openvino/docs/OV_Runtime_UG/deployment/local-distribution.md

Local distribution

The local distribution implies that each C or C++ application / installer will have its own copies of OpenVINO Runtime binaries. However, OpenVINO has a scalable plugin-based architecture which implies that some components can be loaded in runtime only if they are really needed. So, it is important to understand which minimal set of libraries is really needed to deploy the application and this guide helps to achieve this goal.

Note

: The steps below are operation system independent and refer to a library file name without any prefixes (like lib on Unix systems) or suffixes (like .dll on Windows OS). Do not put .lib files on Windows OS to the distribution, because such files are needed only on a linker stage.

Local dsitribution is also appropriate for OpenVINO binaries built from sources using Build instructions, but the guide below supposes OpenVINO Runtime is built dynamically. For case of Static OpenVINO Runtime select the required OpenVINO capabilities on CMake configuration stage using CMake Options for Custom Compilation, the build and link the OpenVINO components into the final application.

C++ or C language

Independently on language used to write the application, openvino must always be put to the final distribution since is a core library which orshectrates with all the inference and frontend plugins. If your application is written with C language, then you need to put openvino_c additionally.

The plugins.xml file with information about inference devices must also be taken as support file for openvino.

Note

: in Intel Distribution of OpenVINO, openvino depends on TBB libraries which are used by OpenVINO Runtime to optimally saturate the devices with computations, so it must be put to the distribution package

Pluggable components

The picture below demonstrates dependnecies between the OpenVINO Runtime core and pluggable libraries:

Compute devices

For each inference device, OpenVINO Runtime has its own plugin library:

• openvino_intel_cpu_plugin for Intel CPU devices
• openvino_intel_gpu_plugin for Intel GPU devices
• openvino_intel_gna_plugin for Intel GNA devices
• openvino_intel_myriad_plugin for Intel MYRIAD devices
• openvino_intel_hddl_plugin for Intel HDDL device
• openvino_arm_cpu_plugin for ARM CPU devices

Depending on what devices is used in the app, put the appropriate libraries to the distribution package.

As it is shown on the picture above, some plugin libraries may have OS-specific dependencies which are either backend libraries or additional supports files with firmware, etc. Refer to the table below for details:

@sphinxdirective

.. raw:: html

<div class="collapsible-section" data-title="Windows OS: Click to expand/collapse">

@endsphinxdirective

Device	Dependency
CPU	-
GPU	OpenCL.dll, cache.json
MYRIAD	usb.dll, usb-ma2x8x.mvcmd, pcie-ma2x8x.elf
HDDL	bsl.dll, hddlapi.dll, json-c.dll, libcrypto-1_1-x64.dll, libssl-1_1-x64.dll, mvnc-hddl.dll
GNA	gna.dll
Arm® CPU	-

@sphinxdirective

.. raw:: html

</div>

@endsphinxdirective @sphinxdirective

.. raw:: html

<div class="collapsible-section" data-title="Linux OS: Click to expand/collapse">

@endsphinxdirective

Device	Dependency
CPU	-
GPU	libOpenCL.so, cache.json
MYRIAD	libusb.so, usb-ma2x8x.mvcmd, pcie-ma2x8x.mvcmd
HDDL	libbsl.so, libhddlapi.so, libmvnc-hddl.so
GNA	gna.dll
Arm® CPU	-

@sphinxdirective

.. raw:: html

</div>

@endsphinxdirective @sphinxdirective

.. raw:: html

<div class="collapsible-section" data-title="MacOS: Click to expand/collapse">

@endsphinxdirective

Device	Dependency
CPU	-
MYRIAD	libusb.dylib, usb-ma2x8x.mvcmd, pcie-ma2x8x.mvcmd
Arm® CPU	-

@sphinxdirective

.. raw:: html

</div>

@endsphinxdirective

Execution capabilities

HETERO, MULTI, BATCH, AUTO execution capabilities can also be used explicitly or implicitly by the application. Use the following recommendation scheme to decide whether to put the appropriate libraries to the distribution package:

• If AUTO is used explicitly in the application or ov::Core::compile_model is used without specifying a device, put the openvino_auto_plugin to the distribution

Note

: Auto device selection relies on inference device plugins, so if are not sure what inference devices are available on target machine, put all inference plugin libraries to the distribution. If the ov::device::priorities is used for AUTO to specify a limited device list, grab the corresponding device plugins only.

• If MULTI is used explicitly, put the openvino_auto_plugin to the distribution
• If HETERO is either used explicitly or ov::hint::performance_mode is used with GPU, put the openvino_hetero_plugin to the distribution
• If BATCH is either used explicitly or ov::hint::performance_mode is used with GPU, put the openvino_batch_plugin to the distribution

Reading models

OpenVINO Runtime uses frontend libraries dynamically to read models in different formats:

• To read OpenVINO IR openvino_ir_frontend is used
• To read ONNX file format openvino_onnx_frontend is used
• To read Paddle file format openvino_paddle_frontend is used

Depending on what types of model file format are used in the application in ov::Core::read_model, peek up the appropriate libraries.

Note

: The recommended way to optimize the size of final distribution package is to convert models using Model Optimizer to OpenVINO IR, in this case you don't have to keep ONNX, Paddle and other frontend libraries in the distribution package.

(Legacy) Preprocessing via G-API

Note

: G-API preprocessing is a legacy functionality, use preprocessing capabilities from OpenVINO 2.0 which do not require any additional libraries.

If the application uses InferenceEngine::PreProcessInfo::setColorFormat or InferenceEngine::PreProcessInfo::setResizeAlgorithm methods, OpenVINO Runtime dynamically loads openvino_gapi_preproc plugin to perform preprocessing via G-API.

Examples

CPU + IR in C-written application

C-written application performs inference on CPU and reads models stored as OpenVINO IR:

• openvino_c library is a main dependency of the application. It links against this library
• openvino is used as a private dependency for openvino and also used in the deployment
• openvino_intel_cpu_plugin is used for inference
• openvino_ir_frontend is used to read source model

MULTI execution on GPU and MYRIAD in tput mode

C++ written application performs inference simultaneously on GPU and MYRIAD devices with ov::hint::PerformanceMode::THROUGHPUT property, reads models stored in ONNX file format:

• openvino library is a main dependency of the application. It links against this library
• openvino_intel_gpu_plugin and openvino_intel_myriad_plugin are used for inference
• openvino_auto_plugin is used for MULTI multi-device execution
• openvino_auto_batch_plugin can be also put to the distribution to improve saturation of Intel GPU device. If there is no such plugin, Automatic batching is turned off.
• openvino_onnx_frontend is used to read source model

Auto device selection between HDDL and CPU

C++ written application performs inference with automatic device selection with device list limited to HDDL and CPU, model is created using C++ code:

• openvino library is a main dependency of the application. It links against this library
• openvino_auto_plugin is used to enable automatic device selection feature
• openvino_intel_hddl_plugin and openvino_intel_cpu_plugin are used for inference, AUTO selects between CPU and HDDL devices according to their physical existance on deployed machine.
• No frontend library is needed because ov::Model is created in code.