IntenseWebs/openvino
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[DOCS] Configuring devices article update for master (#17756)

Browse Source 
* Update configure_devices.md
This commit is contained in:
Maciej Smyk 2023-05-29 09:02:39 +02:00 committed by GitHub
parent dfb6c8ae38
commit 00f94426f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/OV_Runtime_UG/migration_ov_2_0/configure_devices.md
View File

@ -2,12 +2,11 @@
@sphinxdirective @sphinxdirective
The Inference Engine API provides the ability to configure devices with configuration keys and obtain device-specific metrics. The values retrived from `InferenceEngine::Core::GetConfig <namespaceInferenceEngine.html#doxid-namespace-inference-engine-1aff2231f886c9f8fc9c226fd343026789>`__ are requested by the string name, while the return type is `InferenceEngine::Parameter <namespaceInferenceEngine.html#doxid-namespace-inference-engine-1aff2231f886c9f8fc9c226fd343026789>`__ , which results in users not knowing what the actual type is stored in this parameter.
Inference Engine API provides the `ability to configure devices <https://docs.openvino.ai/2021.4/openvino_docs_IE_DG_InferenceEngine_QueryAPI.html>`__ via configuration keys and `get device specific metrics <https://docs.openvino.ai/2021.4/openvino_docs_IE_DG_InferenceEngine_QueryAPI.html#getmetric>`__. The values taken from `InferenceEngine::Core::GetConfig <namespaceInferenceEngine.html#doxid-namespace-inference-engine-1aff2231f886c9f8fc9c226fd343026789>`__ are requested by the string name, while the return type is `InferenceEngine::Parameter <namespaceInferenceEngine.html#doxid-namespace-inference-engine-1aff2231f886c9f8fc9c226fd343026789>`__, making users lost on what the actual type is stored in this parameter.
API 2.0 solves these issues by introducing :doc:`properties <openvino_docs_OV_UG_query_api>`, which unify metrics and configuration key concepts. The main advantage is that they have the C++ type: API 2.0 solves these issues by introducing :doc:`properties <openvino_docs_OV_UG_query_api>`, which unify metrics and configuration key concepts. The main advantage is that they have the C++ type:
.. code-block:: .. code-block:: sh
static constexpr Property<std::string> full_name{"FULL_DEVICE_NAME"}; static constexpr Property<std::string> full_name{"FULL_DEVICE_NAME"};
@ -22,6 +21,10 @@ where the property can be requested from an inference device as:
The snippets in the following sections demonstrate the device configurations for migrating from Inference Engine to API 2.0. The snippets in the following sections demonstrate the device configurations for migrating from Inference Engine to API 2.0.
.. note::
The Inference Engine API is a **legacy solution** and it is recomended to use API 2.0. If you want to learn more about Inference Engine API, its configuration and how to obtain device-specific metrics from it, check the following `article <https://docs.openvino.ai/2021.4/openvino_docs_IE_DG_InferenceEngine_QueryAPI.html>`__ from the 2021.4 version of OpenVINO documentation.
Setting Configuration Values Setting Configuration Values
############################ ############################
@ -194,7 +197,8 @@ Setting Configuration Values
:fragment: compiled_model_set_property :fragment: compiled_model_set_property
## Getting Information Getting Information
###################
**Inference Engine API** **Inference Engine API**