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

DOCS shift to rst - Hello Query Device C++ Sample & Hello Query Device Python* Sample (#16650)

Browse Source
This commit is contained in:
Maciej Smyk 2023-04-03 08:24:02 +02:00 committed by GitHub
parent f5dced8e69
commit bb20151c9d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 172 additions and 144 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
samples/cpp/hello_query_device/README.md
View File

@ -1,41 +1,54 @@
# Hello Query Device C++ Sample {#openvino_inference_engine_samples_hello_query_device_README} # Hello Query Device C++ Sample {#openvino_inference_engine_samples_hello_query_device_README}
This sample demonstrates how to execute an query OpenVINO™ Runtime devices, prints their metrics and default configuration values, using [Properties API](../../../docs/OV_Runtime_UG/supported_plugins/config_properties.md). @sphinxdirective
This sample demonstrates how to execute an query OpenVINO™ Runtime devices, prints their metrics and default configuration values, using :doc:`Properties API <openvino_docs_OV_UG_query_api>`.
The following C++ API is used in the application: The following C++ API is used in the application:
+----------------------------------------+---------------------------------------+-------------------------------------------------------------------+
| Feature | API | Description | | Feature | API | Description |
| :--- | :--- | :--- | +========================================+=======================================+===================================================================+
| Available Devices | `ov::Core::get_available_devices`, `ov::Core::get_property` | Get available devices information and configuration for inference | | Available Devices | ``ov::Core::get_available_devices``, | Get available devices information and configuration for inference |
| | ``ov::Core::get_property`` | |
+----------------------------------------+---------------------------------------+-------------------------------------------------------------------+
Basic OpenVINO™ Runtime API is covered by [Hello Classification C++ sample](../hello_classification/README.md). Basic OpenVINO™ Runtime API is covered by :doc:`Hello Classification C++ sample <openvino_inference_engine_samples_hello_classification_README>`.
+----------------------------------------+----------------------------------------------------------------------------------------------+
| Options | Values | | Options | Values |
| :--- |:--- +========================================+==============================================================================================+
| Supported devices | [All](../../../docs/OV_Runtime_UG/supported_plugins/Supported_Devices.md) | | Supported devices | :doc:`All <openvino_docs_OV_UG_supported_plugins_Supported_Devices>` |
| Other language realization | [Python](../../python/hello_query_device/README.md) | +----------------------------------------+----------------------------------------------------------------------------------------------+
| Other language realization | :doc:`Python <openvino_inference_engine_ie_bridges_python_sample_hello_query_device_README>` |
+----------------------------------------+----------------------------------------------------------------------------------------------+
## How It Works How It Works
############
The sample queries all available OpenVINO™ Runtime devices, prints their supported metrics and plugin configuration parameters. The sample queries all available OpenVINO™ Runtime devices, prints their supported metrics and plugin configuration parameters.
## Building Building
########
To build the sample, please use instructions available at [Build the Sample Applications](../../../docs/OV_Runtime_UG/Samples_Overview.md) section in OpenVINO™ Toolkit Samples guide. To build the sample, please use instructions available at :doc:`Build the Sample Applications <openvino_docs_OV_UG_Samples_Overview>` section in OpenVINO™ Toolkit Samples guide.
## Running Running
#######
To see quired information, run the following: To see quired information, run the following:
``` .. code-block:: console
hello_query_device
```
## Sample Output hello_query_device
Sample Output
#############
The application prints all available devices with their supported metrics and default values for configuration parameters: The application prints all available devices with their supported metrics and default values for configuration parameters:
``` .. code-block:: console
[ INFO ] OpenVINO Runtime version ......... <version> [ INFO ] OpenVINO Runtime version ......... <version>
[ INFO ] Build ........... <build> [ INFO ] Build ........... <build>
[ INFO ] [ INFO ]
@ -86,9 +99,12 @@ The application prints all available devices with their supported metrics and de
[ INFO ] LOG_LEVEL : LOG_NONE [ INFO ] LOG_LEVEL : LOG_NONE
[ INFO ] PERF_COUNT : NO [ INFO ] PERF_COUNT : NO
[ INFO ] SINGLE_THREAD : YES [ INFO ] SINGLE_THREAD : YES
```
## See Also See Also
########
- :doc:`Integrate the OpenVINO™ Runtime with Your Application <openvino_docs_OV_UG_Integrate_OV_with_your_application>`
- :doc:`Using OpenVINO™ Toolkit Samples <openvino_docs_OV_UG_Samples_Overview>`
@endsphinxdirective
- [Integrate the OpenVINO™ Runtime with Your Application](../../../docs/OV_Runtime_UG/integrate_with_your_application.md)
- [Using OpenVINO™ Toolkit Samples](../../../docs/OV_Runtime_UG/Samples_Overview.md)

54
samples/python/hello_query_device/README.md
View File

@ -1,37 +1,51 @@
# Hello Query Device Python* Sample {#openvino_inference_engine_ie_bridges_python_sample_hello_query_device_README} # Hello Query Device Python* Sample {#openvino_inference_engine_ie_bridges_python_sample_hello_query_device_README}
This sample demonstrates how to show OpenVINO™ Runtime devices and prints their metrics and default configuration values using [Query Device API feature](../../../docs/OV_Runtime_UG/supported_plugins/config_properties.md). @sphinxdirective
This sample demonstrates how to show OpenVINO™ Runtime devices and prints their metrics and default configuration values using :doc:`Query Device API feature <openvino_docs_OV_UG_query_api>`.
The following Python API is used in the application: The following Python API is used in the application:
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------+
| Feature | API | Description | | Feature | API | Description |
| :----------- | :---------------------------------------------------------------------------------------------------------------- | :-------------------- | +=======================================+============================================================================================================================================================================================+========================================+
| Basic | [openvino.runtime.Core] | Common API | | Basic | `openvino.runtime.Core <https://docs.openvino.ai/2022.3/api/ie_python_api/_autosummary/openvino.runtime.Core.html>`__ | Common API |
| Query Device | [openvino.runtime.Core.available_devices], [openvino.runtime.Core.get_metric], [openvino.runtime.Core.get_config] | Get device properties | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------+
| Query Device | `openvino.runtime.Core.available_devices <https://docs.openvino.ai/2022.3/api/ie_python_api/_autosummary/openvino.runtime.Core.html#openvino.runtime.Core.available_devices>`__ , | Get device properties |
| | `openvino.runtime.Core.get_metric <https://docs.openvino.ai/2022.3/api/ie_python_api/_autosummary/openvino.inference_engine.IECore.html#openvino.inference_engine.IECore.get_metric>`__ , | |
| | `openvino.runtime.Core.get_config <https://docs.openvino.ai/2022.3/api/ie_python_api/_autosummary/openvino.inference_engine.IECore.html#openvino.inference_engine.IECore.get_config>`__ | |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------+
+-------------------------------------------------------+--------------------------------------------------------------------------+
| Options | Values | | Options | Values |
| :------------------------- | :---------------------------------------------------------------- | +=======================================================+==========================================================================+
| Supported devices | [All](../../../docs/OV_Runtime_UG/supported_plugins/Supported_Devices.md) | | Supported devices | :doc:`All <openvino_docs_OV_UG_supported_plugins_Supported_Devices>` |
| Other language realization | [C++](../../../samples/cpp/hello_query_device/README.md) | +-------------------------------------------------------+--------------------------------------------------------------------------+
| Other language realization | :doc:`C++ <openvino_inference_engine_samples_hello_query_device_README>` |
+-------------------------------------------------------+--------------------------------------------------------------------------+
## How It Works How It Works
############
The sample queries all available OpenVINO™ Runtime devices and prints their supported metrics and plugin configuration parameters. The sample queries all available OpenVINO™ Runtime devices and prints their supported metrics and plugin configuration parameters.
## Running Running
#######
The sample has no command-line parameters. To see the report, run the following command: The sample has no command-line parameters. To see the report, run the following command:
``` .. code-block:: console
python hello_query_device.py
```
## Sample Output python hello_query_device.py
Sample Output
#############
The application prints all available devices with their supported metrics and default values for configuration parameters. The application prints all available devices with their supported metrics and default values for configuration parameters.
For example: For example:
``` .. code-block:: console
[ INFO ] Available devices: [ INFO ] Available devices:
[ INFO ] CPU : [ INFO ] CPU :
[ INFO ] SUPPORTED_METRICS: [ INFO ] SUPPORTED_METRICS:
@ -81,13 +95,11 @@ For example:
[ INFO ] LOG_LEVEL: LOG_NONE [ INFO ] LOG_LEVEL: LOG_NONE
[ INFO ] PERF_COUNT: NO [ INFO ] PERF_COUNT: NO
[ INFO ] SINGLE_THREAD: YES [ INFO ] SINGLE_THREAD: YES
```
## See Also See Also
########
- [Using OpenVINO™ Toolkit Samples](../../../docs/OV_Runtime_UG/Samples_Overview.md) - :doc:`Using OpenVINO™ Toolkit Samples <openvino_docs_OV_UG_Samples_Overview>`
@endsphinxdirective
[openvino.runtime.Core]:https://docs.openvino.ai/2022.3/api/ie_python_api/_autosummary/openvino.runtime.Core.html
[openvino.runtime.Core.available_devices]:https://docs.openvino.ai/2022.3/api/ie_python_api/_autosummary/openvino.runtime.Core.html#openvino.runtime.Core.available_devices
[openvino.runtime.Core.get_metric]:https://docs.openvino.ai/2022.3/api/ie_python_api/_autosummary/openvino.inference_engine.IECore.html#openvino.inference_engine.IECore.get_metric
[openvino.runtime.Core.get_config]:https://docs.openvino.ai/2022.3/api/ie_python_api/_autosummary/openvino.inference_engine.IECore.html#openvino.inference_engine.IECore.get_config