Get Started Guide#

  • Time to Complete: 30 mins

  • Programming Language: Python

Get Started#

Prerequisites#

Step 1: Get the docker images#

Option 1: Build from source#

Go to the target directory of your choice and clone the suite. If you want to clone a specific release branch, replace main with the desired tag. To learn more on partial cloning, check the Repository Cloning guide.

git clone --filter=blob:none --branch main https://github.com/open-edge-platform/metro-ai-suite.git
cd metro-ai-suite

Run the commands to build images for the microservices:

git clone https://github.com/open-edge-platform/edge-ai-libraries.git -b main
cd edge-ai-libraries/microservices

cd visual-data-preparation-for-retrieval/multimodal-dataprep
./build.sh
cd ../../

docker build -t vector-retriever-milvus:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy --build-arg no_proxy=$no_proxy -f vector-retriever/milvus/src/Dockerfile .

cd multimodal-embedding-serving
docker build -t multimodal-embedding-serving:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy --build-arg no_proxy=$no_proxy -f docker/Dockerfile .

cd ../../..

VLM OpenVINO Serving is not built from source. The Compose file references the published image by its pinned tag, so Compose pulls it automatically. To fetch it ahead of time:

docker pull intel/vlm-openvino-serving:2026.2.0

Run the command to build image for the application:

docker build -t visual-search-qa-app:latest --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy --build-arg no_proxy=$no_proxy -f visual-search-question-and-answering/src/Dockerfile .

Option 2: use remote prebuilt images#

Set a remote registry by exporting environment variables:

export REGISTRY="intel/"
export TAG="latest"

Step 2: Prepare host directories for models and data#

mkdir -p $HOME/data

If you would like to test the application with a demo dataset, please continue and follow the instructions in the Try with a demo dataset section later in this guide.

Otherwise, if you would like to use your own data (images and video), put it all in a directory on the host and point HOST_DATA_PATH at it before deploying the services, for example export HOST_DATA_PATH="$HOME/data". It defaults to $HOME/data.

Note

Supported media types are jpg, png, and mp4.

Step 3: Deploy#

Option2: Deploy in Kubernetes#

Refer to Deploy with helm for details.

Try with a demo dataset#

*Applicable to deployment with Option 1 (docker compose deployment).

Prepare demo dataset DAVIS#

Use the prepare_demo_dataset.sh script shipped in tests/. It runs on the host (it needs curl, unzip and ffmpeg) and writes the dataset into the directory shared with the dataprep microservice:

bash tests/prepare_demo_dataset.sh

Check your host data directory $HOME/data (or $HOST_DATA_PATH) and see if DAVIS is there. To save time, only a subset of the dataset is prepared: it is stored in $HOME/data/DAVIS/subset, half as videos and half as sampled images. Use this path in the next step.

The script also writes a meta/<basename>.json sidecar per item with a camera and a capture_date field, so the camera and date filters in the UI have values to filter on.

Use it on Web UI#

Go to http://{host_ip}:17580 with a browser. Put the exact path to the subset of demo dataset (usually/home/user/data/DAVIS/subset, may vary according to your local username) into file directory on host. Click UpdataDB and wait for the uploading done.

Try searching with query text tractor, see if the results are correct.

Expected valid inputs are “car-race”, “deer”, “guitar-violin”, “gym”, “helicopter”, “carousel”, “monkeys-trees”, “golf”, “rollercoaster”, “horsejump-stick”, “planes-crossing”, “tractor”

Try ticking a search result, and ask a question in the leftside chatbox about the selected media.

Note

For each chat request, you may select either a single image, or multiple images, or a single video. Multiple videos or a collection of images+videos are not supported yet.

Performance#

You can check the end-to-end response time for each round of question-and-answering in the chat history.

Summary#

In this get started guide, you learned how to:

  • Build the microservice images

  • Deploy the application with the microservices

  • Try the application with a demo dataset

Learn More#