Renamed user guides

openvinotoolkit · Mar 23, 2022 · 787764e · 787764e
1 parent ecf363c
commit 787764e
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 26 deletions.
diff --git a/docs/MO_DG/Deep_Learning_Model_Optimizer_DevGuide.md b/docs/MO_DG/Deep_Learning_Model_Optimizer_DevGuide.md
@@ -1,4 +1,4 @@
-# Model Optimizer User Guide {#openvino_docs_MO_DG_Deep_Learning_Model_Optimizer_DevGuide}
+# Convert model with Model Optimizer {#openvino_docs_MO_DG_Deep_Learning_Model_Optimizer_DevGuide}
 
 @sphinxdirective
 

diff --git a/docs/OV_Runtime_UG/deployment/deployment_intro.md b/docs/OV_Runtime_UG/deployment/deployment_intro.md
@@ -46,6 +46,6 @@ The _optional_ means that if the application does not use the capability enabled
 
 The information above covers granularity aspects of majority distribution types, more detailed information is only needed and provided in [Local Distribution](local-distribution.md).
 
-> **NOTE**: Depending on target OpenVINO devices, you also have to use [Configurations for GPU](../../install_guides/configurations-for-intel-gpu.md), [Configurations for GNA](../../install_guides/configurations-for-intel-gna.md), [Configurations for NCS2](../../install_guides/configurations-for-ncs2.md) or [Configurations for GNA](../../install_guides/installing-openvino-config-ivad-vpu.md) for proper configuration of deployed machines.
+> **NOTE**: Depending on target OpenVINO devices, you also have to use [Configurations for GPU](../../install_guides/configurations-for-intel-gpu.md), [Configurations for GNA](../../install_guides/configurations-for-intel-gna.md), [Configurations for NCS2](../../install_guides/configurations-for-ncs2.md) or [Configurations for VPU](../../install_guides/installing-openvino-config-ivad-vpu.md) for proper configuration of deployed machines.
 
 [deployment_simplified]: ../../img/deployment_simplified.png
diff --git a/docs/OV_Runtime_UG/deployment/local-distribution.md b/docs/OV_Runtime_UG/deployment/local-distribution.md
@@ -2,7 +2,7 @@
 
 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 build / linker stage.
+> **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](https://github.com/openvinotoolkit/openvino/wiki#how-to-build), but the guide below supposes OpenVINO Runtime is built dynamically. For case of [Static OpenVINO Runtime](https://github.com/openvinotoolkit/openvino/wiki/StaticLibraries) select the required OpenVINO capabilities on CMake configuration stage using [CMake Options for Custom Compilation](https://github.com/openvinotoolkit/openvino/wiki/CMakeOptionsForCustomCompilation), the build and link the OpenVINO components into the final application.
 
@@ -26,17 +26,49 @@ The picture below demonstrates dependnecies between the OpenVINO Runtime core an
 For each inference device, OpenVINO Runtime has its own plugin library:
 - `openvino_intel_cpu_plugin` for [Intel CPU devices](../supported_plugins/CPU.md)
 - `openvino_intel_gpu_plugin` for [Intel GPU devices](../supported_plugins/GPU.md)
- - Has `OpenCL` library as a dependency
 - `openvino_intel_gna_plugin` for [Intel GNA devices](../supported_plugins/GNA.md)
- - Has `gna` backend library as a dependency
 - `openvino_intel_myriad_plugin` for [Intel MYRIAD devices](../supported_plugins/MYRIAD.md)
- - Has `usb` library as a dependency
 - `openvino_intel_hddl_plugin` for [Intel HDDL device](../supported_plugins/HDDL.md)
- - Has libraries from `runtime/3rdparty/hddl` as a dependency
 - `openvino_arm_cpu_plugin` for [ARM CPU devices](../supported_plugins/ARM_CPU.md)
 
 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
+
+.. tab:: Windows
+
+| 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    |  `-`      |
+
+.. tab:: Linux
+
+| 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    |  `-`        |
+
+.. tab:: MacOS
+
+| Device      | Dependency  |
+|-------------|-------------|
+| CPU         |     `-`     |
+| MYRIAD      | `libusb.dylib`, `usb-ma2x8x.mvcmd`, `pcie-ma2x8x.mvcmd` |
+| Arm® CPU    |  `-`        |
+
+@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:

diff --git a/docs/OV_Runtime_UG/migration_ov_2_0/intro.md b/docs/OV_Runtime_UG/migration_ov_2_0/intro.md
@@ -1,4 +1,4 @@
-# OpenVINO™ Transition Guide for API 2.0 {#openvino_2_0_transition_guide}
+# Transition to OpenVINO™ 2.0 {#openvino_2_0_transition_guide}
 
 @sphinxdirective
 

diff --git a/docs/OV_Runtime_UG/openvino_intro.md b/docs/OV_Runtime_UG/openvino_intro.md
@@ -1,4 +1,4 @@
-# OpenVINO™ Runtime User Guide {#openvino_docs_OV_Runtime_User_Guide}
+# Performing inference with OpenVINO Runtime {#openvino_docs_OV_Runtime_User_Guide}
 
 @sphinxdirective
 

diff --git a/docs/OV_Runtime_UG/preprocessing_overview.md b/docs/OV_Runtime_UG/preprocessing_overview.md
@@ -1,4 +1,4 @@
-# Overview of Preprocessing API {#openvino_docs_OV_Runtime_UG_Preprocessing_Overview}
+# Optimize Preprocessing {#openvino_docs_OV_Runtime_UG_Preprocessing_Overview}
 
 @sphinxdirective
 

diff --git a/docs/OV_Runtime_UG/supported_plugins/GNA.md b/docs/OV_Runtime_UG/supported_plugins/GNA.md
@@ -284,7 +284,7 @@ Intel® GNA plugin supports the processing of context-windowed speech frames in
 
 Please refer to [Layout API overview](@ref openvino_docs_OV_Runtime_UG_Layout_Overview) to determine batch dimension.
 
-To set layout of model inputs in runtime use [Preprocessing API](@ref openvino_docs_OV_Runtime_UG_Preprocessing_Overview):
+To set layout of model inputs in runtime use [Optimize Preprocessing](@ref openvino_docs_OV_Runtime_UG_Preprocessing_Overview) guide:
 
 @sphinxtabset
 

diff --git a/docs/OV_Runtime_UG/supported_plugins/Supported_Devices.md b/docs/OV_Runtime_UG/supported_plugins/Supported_Devices.md
@@ -20,21 +20,6 @@ The OpenVINO Runtime provides unique capabilities to infer deep learning models
 
 Devices similar to the ones we have used for benchmarking can be accessed using [Intel® DevCloud for the Edge](https://devcloud.intel.com/edge/), a remote development environment with access to Intel® hardware and the latest versions of the Intel® Distribution of the OpenVINO™ Toolkit. [Learn more](https://devcloud.intel.com/edge/get_started/devcloud/) or [Register here](https://inteliot.force.com/DevcloudForEdge/s/).
 
-The table below shows the plugin libraries and additional dependencies for Linux, Windows and macOS platforms.
-
-| Plugin | Library name for Linux      | Dependency libraries for Linux                              | Library name for Windows | Dependency libraries for Windows                                                                       | Library name for macOS       | Dependency libraries for macOS              |
-|--------|-----------------------------|-------------------------------------------------------------|--------------------------|--------------------------------------------------------------------------------------------------------|------------------------------|---------------------------------------------|
-| CPU    | `libopenvino_intel_cpu_plugin.so`        | | `openvino_intel_cpu_plugin.dll`       | | `libopenvino_intel_cpu_plugin.so`      | |
-| GPU    | `libopenvino_intel_gpu_plugin.so`         | `libOpenCL.so` | `openvino_intel_gpu_plugin.dll`        | `OpenCL.dll` |  Is not supported            |  -                                          |
-| MYRIAD | `libopenvino_intel_myriad_plugin.so` | `libusb.so`                                                 | `openvino_intel_myriad_plugin.dll`| `usb.dll`                                                                                              | `libopenvino_intel_myriad_plugin.so`   | `libusb.dylib`                              |
-| HDDL   | `libintel_hddl_plugin.so`          | `libbsl.so`, `libhddlapi.so`, `libmvnc-hddl.so`             | `intel_hddl_plugin.dll`         | `bsl.dll`, `hddlapi.dll`, `json-c.dll`, `libcrypto-1_1-x64.dll`, `libssl-1_1-x64.dll`, `mvnc-hddl.dll` |  Is not supported            |  -                                          |
-| GNA    | `libopenvino_intel_gna_plugin.so`           | `libgna.so`,                                                | `openvino_intel_gna_plugin.dll`          | `gna.dll`                                                                                              |  Is not supported            |  -                                          |
-| Arm® CPU | `libopenvino_arm_cpu_plugin.so`           |                                                 | Is not supported          | -                                                                                              |  `libopenvino_arm_cpu_plugin.so`            |  -                                          |
-| HETERO | `libopenvino_hetero_plugin.so`        | Same as for selected plugins                                | `openvino_hetero_plugin.dll`       | Same as for selected plugins                                                                           | `libopenvino_hetero_plugin.so`      |  Same as for selected plugins               |
-| MULTI  | `libopenvino_auto_plugin.so`   | Same as for selected plugins                                | `openvino_auto_plugin.dll`  | Same as for selected plugins                                                                           | `libopenvino_auto_plugin.so` |  Same as for selected plugins               |
-| AUTO | `libopenvino_auto_plugin.so`   | Same as for selected plugins                                | `openvino_auto_plugin.dll`  | Same as for selected plugins                                                                           | `libopenvino_auto_plugin.so` |  Same as for selected plugins               |
-| BATCH | `libopenvino_auto_batch_plugin.so`   | Same as for selected plugins                                | `openvino_auto_batch_plugin.dll`  | Same as for selected plugins                                                                           | `libopenvino_auto_batch_plugin.so` |  Same as for selected plugins               |
-
 ## Supported Configurations
 
 The OpenVINO Runtime can inference models in different formats with various input and output formats.