From d8cbe925dc0036fff9f326a8e523ab6d171420b6 Mon Sep 17 00:00:00 2001 From: Ilya Lavrenov Date: Fri, 9 Aug 2024 01:56:59 +0400 Subject: [PATCH] Updated OpenVINO build docs (#25982) ### Details: - *item1* - *...* ### Tickets: - *ticket-id* --- docs/dev/cmake_options_for_custom_compilation.md | 3 +++ docs/dev/static_libaries.md | 14 +++++--------- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/dev/cmake_options_for_custom_compilation.md b/docs/dev/cmake_options_for_custom_compilation.md index d370285f99c8b4..5ace401ce091c6 100644 --- a/docs/dev/cmake_options_for_custom_compilation.md +++ b/docs/dev/cmake_options_for_custom_compilation.md @@ -19,6 +19,8 @@ This document provides description and default values for CMake options that can * `ON` is default for x86 platforms; `OFF`, otherwise. * `ENABLE_INTEL_GPU` enables Intel GPU plugin compilation: * `ON` is default for x86 platforms; not available, otherwise. + * `ENABLE_INTEL_NPU` enables Intel NPU plugin compilation: + * `ON` is default for Windows and Linux x86 platforms; not available, otherwise. * `ENABLE_HETERO` enables HETERO plugin build: * `ON` is default. * `ENABLE_MULTI` enables MULTI plugin build: @@ -191,3 +193,4 @@ In this case OpenVINO CMake scripts take `TBBROOT` environment variable into acc [PyTorch]:https://pytorch.org/ [FlatBuffers]:https://google.github.io/flatbuffers/ [oneTBB]:https://github.com/oneapi-src/oneTBB +[JAX]:https://github.com/google/jax diff --git a/docs/dev/static_libaries.md b/docs/dev/static_libaries.md index 0f694cda73f07d..19972a292f3b0c 100644 --- a/docs/dev/static_libaries.md +++ b/docs/dev/static_libaries.md @@ -28,15 +28,15 @@ It is possible because not all interface symbols of OpenVINO Runtime libraries a ## Configure OpenVINO Runtime in the CMake stage The default architecture of OpenVINO Runtime assumes that the following components are subject to dynamic loading during execution: -* (Device) Inference backends (CPU, GPU, MULTI, HETERO, etc.) -* (Model) Frontends (IR, ONNX, PDPD, etc.) -* Preprocessing library (to perform preprocessing, e.g. resize and color space conversions) +* (Device) Inference backends (CPU, GPU, NPU, MULTI, HETERO, etc.) +* (Model) Frontends (IR, ONNX, PDPD, TF, JAX, etc.) With the static OpenVINO Runtime, all these modules should be linked into a final user application and **the list of modules/configuration must be known for the CMake configuration stage**. To minimize the total binary size, you can explicitly turn `OFF` unnecessary components. Use [[CMake Options for Custom Compilation|CMakeOptionsForCustomCompilation ]] as a reference for OpenVINO CMake configuration. For example, to enable only IR v11 reading and CPU inference capabilities, use: ```sh cmake -DENABLE_INTEL_GPU=OFF \ + -DENABLE_INTEL_NPU=OFF \ -DENABLE_TEMPLATE=OFF \ -DENABLE_HETERO=OFF \ -DENABLE_MULTI=OFF \ @@ -46,6 +46,7 @@ cmake -DENABLE_INTEL_GPU=OFF \ -DENABLE_OV_PADDLE_FRONTEND=OFF \ -DENABLE_OV_TF_FRONTEND=OFF \ -DENABLE_OV_TF_LITE_FRONTEND=OFF \ + -DENABLE_OV_JAX_FRONTEND=OFF \ -DENABLE_OV_PYTORCH_FRONTEND=OFF \ -DENABLE_OV_JAX_FRONTEND=OFF \ -DENABLE_INTEL_CPU=ON \ @@ -133,21 +134,16 @@ cmake -DCMAKE_TOOLCHAIN_FILE=/cmake/toolchains/mt.runtime.w * The enabled and tested capabilities of OpenVINO Runtime in a static build: * OpenVINO common runtime - work with `ov::Model`, perform model loading on particular device * MULTI, HETERO, AUTO, and BATCH inference modes - * IR, ONNX, PDPD, and TF frontends to read `ov::Model` + * IR, ONNX, PDPD, TF and TF Lite frontends to read `ov::Model` * Static build support for building static libraries only for OpenVINO Runtime libraries. All other third-party prebuilt dependencies remain in the same format: - * `libGNA` is a shared library. * `TBB` is a shared library; to provide your own TBB build from [[oneTBB source code|https://github.com/oneapi-src/oneTBB]] use `export TBBROOT=` before OpenVINO CMake scripts are run. > **NOTE**: The TBB team does not recommend using oneTBB as a static library, see [[Why onetbb does not like a static library?|https://github.com/oneapi-src/oneTBB/issues/646]] * `TBBBind_2_5` is not available on Windows x64 during a static OpenVINO build (see description for `ENABLE_TBBBIND_2_5` CMake option [[here|CMakeOptionsForCustomCompilation]] to understand what this library is responsible for). So, capabilities enabled by `TBBBind_2_5` are not available. To enable them, build [[oneTBB from source code|https://github.com/oneapi-src/oneTBB]] and provide the path to built oneTBB artifacts via `TBBROOT` environment variable before OpenVINO CMake scripts are run. -* `ov::Op::type_info` static member is deprecated and not available in static build. Don't use `type_info` during implementation of your own custom operations, use `ov::Op::get_type_info_static()` instead. - ## See also * [OpenVINO README](../../README.md) * [OpenVINO Developer Documentation](index.md) * [How to Build OpenVINO](build.md) - -