Skip to content

how-to-build-from-source.md

Latest commit

 

History

History
67 lines (45 loc) · 2.71 KB

how-to-build-from-source.md

File metadata and controls

67 lines (45 loc) · 2.71 KB

How to Build from Source

Build the VLM OpenVINO serving microservice from source to customize, debug, or extend its functionality. In this guide, you will:

  • Set up your development environment.
  • Compile the source code and resolve dependencies.
  • Generate a runnable build for local testing or deployment.

This guide is ideal for developers who want to work directly with the source code.

Prerequisites

Before you begin, ensure the following:

Steps to Build

This section provides a detailed note on how to build the VLM OpenVINO Serving microservice.

(Optional) Docker Compose builds the VLM Inference Serving with a default image and tag name. If you want to use a different image and tag, export these variables:

export REGISTRY_URL="your-container-registry_url"
export PROJECT_NAME="your-project-name"
export TAG="your_tag"

NOTE: PROJECT_NAME will be suffixed to REGISTRY_URL to create a namespaced url. Final image name will be created/pulled by further suffixing the application name and tag with the namespaced url.

EXAMPLE: If variables are set using above command, the final image names for VLM OpenVINO Serving would be <your-container-registry-url>/<your-project-name>/vlm-openvino-serving:<your-tag>.

If variables are not set, in that case, the TAG will have default value as latest. Hence, final image will be vlm-openvino-serving:latest.

  1. Clone the Repository:
# Clone the latest on mainline
git clone https://github.com/open-edge-platform/edge-ai-libraries.git edge-ai-libraries
# Alternatively, Clone a specific release branch
git clone https://github.com/open-edge-platform/edge-ai-libraries.git edge-ai-libraries -b <release-tag>

cd edge-ai-libraries/microservices/vlm-openvino-serving/docker
  1. Set up environment values:

Follow all the instructions provided in the get started document to set up the environment variables.

  1. Build the Docker image:

To build the Docker image, run the following command:

docker compose build

Validation

Verify Build Success:

  • Check the logs. Look for confirmation messages indicating the microservice started successfully.

Supporting Resources