Skip to content

Latest commit

 

History

History
133 lines (99 loc) · 4.7 KB

build_from_source.md

File metadata and controls

133 lines (99 loc) · 4.7 KB
Raw

Building from source

This document gives information how to build docker images and the binary package from source with different variants.

Prerequisites

  1. Docker Engine
  2. Ubuntu 20.04 or RedHat 8.7 host
  3. make
  4. bash

Makefile and building

Makefile located in root directory of this repository contains all targets needed to build docker images and binary packages.

It contains docker_build target which by default builds multiple docker images:

  • openvino/model_server:latest - smallest release image containing only neccessary files to run model server on CPU, NCS and HDDL
  • openvino/model_server:latest-gpu - release image containing support for Intel GPU
  • openvino/model_server:latest-nginx-mtls - release image containing examplary NGINX MTLS configuration
  • openvino/model_server-build:latest - image with builder environment containing all the tools to build OVMS

The docker_build target also prepares binary package to run OVMS as standalone application and shared library to link against user written C/C++ applications.

git clone https://github.com/openvinotoolkit/model_server
cd model_server
make docker_build
tree dist/ubuntu
dist/ubuntu
├── Dockerfile.redhat
├── Dockerfile.ubuntu
├── drivers
├── LICENSE
├── Makefile
├── ovms.tar.gz
├── ovms.tar.gz.metadata.json
├── ovms.tar.gz.sha256
├── ovms.tar.xz
├── ovms.tar.xz.metadata.json
├── ovms.tar.xz.sha256
└── thirdparty-licenses

Building Options

BASE_OS

Select base OS:

  • ubuntu for Ubuntu 20.04 (default)
  • redhat for Red Hat UBI 8.7
make docker_build BASE_OS=redhat

Example:

INSTALL_DRIVER_VERSION

Parameter used to control which GPU driver version will be installed. Supported versions:

OS Versions
Ubuntu 22.35.24055 (default),
22.10.22597,
21.48.21782,
20.35.17767
RedHat 22.28.23726 (default),
22.10.22597,
21.38.21026,
20.35.17767

Additionally it is possible to specify custom (pre-production) drivers by providing location to NEO Runtime packages on local disk. Contact Intel representative to get the access to the pre-production drivers.
Warning: Maintained only for Ubuntu base OS.

Put NEO Runtime deb packages in the catalog <model_server_dir>/release_files/drivers/dg2. Expected structure is like below:

drivers
└── dg2
     ├── intel-igc-core_<version>_amd64.deb
     ├── intel-igc-opencl_<version>_amd64.deb
     ├── intel-level-zero-gpu-dbgsym_<version>_amd64.deb
     ├── intel-level-zero-gpu_<version>_amd64.deb
     ├── intel-opencl-icd-dbgsym_<version>_amd64.deb
     ├── intel-opencl-icd_<version>_amd64.deb
     ├── libigdgmm12_<version>_amd64.deb
     └── libigdgmm12_<version>_amd64.deb

and run make docker_build with parameter: INSTALL_DRIVER_VERSION=dg2.

Example:

make docker_build BASE_OS=ubuntu INSTALL_DRIVER_VERSION=dg2

DLDT_PACKAGE_URL

Parameter used to specify URL to OpenVINO package. By default set to latest release.

NVIDIA

By default set to 0. When set to 1, there will be additional docker image prepared: openvino/model_server:latest-cuda which contains environment required to run inference on NVIDIA GPUs. Please note that such image is significantly larger than the base one.

Hint: use together with OV_USE_BINARY=0 to force building OpenVINO from source. Use OV_SOURCE_BRANCH parameter to specify which branch from OpenVINO repository should be used. Use together with OV_CONTRIB_BRANCH to specify which branch from OpenVINO contrib repository should be used for NVIDIA plugin.

Example:

make docker_build NVIDIA=1 OV_USE_BINARY=0 OV_SOURCE_BRANCH=releases/2022/3 OV_CONTRIB_BRANCH=releases/2022/3
docker run -it --gpus all -p 9178:9178 -v ${PWD}/models/public/resnet-50-tf:/opt/model openvino/model_server:latest-cuda --model_path /opt/model --model_name resnet --target_device NVIDIA

OV_USE_BINARY

By default set to 1. When set to 0, OpenVINO will be built from sources and DLDT_PACKAGE_URL will be omitted.
Use OV_SOURCE_BRANCH to select OpenVINO repository branch. By default master will be used.
Warning: Maintained only for Ubuntu base OS.

Example:

make docker_build OV_USE_BINARY=0 OV_SOURCE_BRANCH=<commit or branch>

Read more detailed usage in developer guide.