openvino/samples/python/hello_query_device/README.md

# Hello Query Device Python Sample {#openvino_inference_engine_ie_bridges_python_sample_hello_query_device_README}

@sphinxdirective

.. meta::
   :description: Learn how to show metrics and default 
                 configuration values of inference devices using Query 
                 Device (Python) API feature.


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>`.

.. tab-set::

   .. tab-item:: Requirements 

      +-------------------------------------------------------+--------------------------------------------------------------------------+
      | Options                                               | Values                                                                   |
      +=======================================================+==========================================================================+
      | Supported devices                                     | :doc:`All <openvino_docs_OV_UG_supported_plugins_Supported_Devices>`     |
      +-------------------------------------------------------+--------------------------------------------------------------------------+
      | Other language realization                            | :doc:`C++ <openvino_inference_engine_samples_hello_query_device_README>` |
      +-------------------------------------------------------+--------------------------------------------------------------------------+

   .. tab-item:: Python API 

      The following Python API is used in the application:

      +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------+
      | Feature                               | API                                                                                                                                                                                        | Description                            |
      +=======================================+============================================================================================================================================================================================+========================================+
      | Basic                                 | `openvino.runtime.Core <https://docs.openvino.ai/2023.1/api/ie_python_api/_autosummary/openvino.runtime.Core.html>`__                                                                      | Common API                             |
      +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------+
      | Query Device                          | `openvino.runtime.Core.available_devices <https://docs.openvino.ai/2023.1/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/2023.1/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/2023.1/api/ie_python_api/_autosummary/openvino.inference_engine.IECore.html#openvino.inference_engine.IECore.get_config>`__    |                                        |
      +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------+

   .. tab-item:: Sample Code

      .. doxygensnippet:: samples/python/hello_query_device/hello_query_device.py 
         :language: python      

How It Works
############

The sample queries all available OpenVINO™ Runtime devices and prints their supported metrics and plugin configuration parameters.

Running
#######

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
#############

The application prints all available devices with their supported metrics and default values for configuration parameters.
For example:

.. code-block:: console
   
   [ INFO ] Available devices:
   [ INFO ] CPU :
   [ INFO ]        SUPPORTED_METRICS:
   [ INFO ]                AVAILABLE_DEVICES:
   [ INFO ]                FULL_DEVICE_NAME: Intel(R) Core(TM) i5-8350U CPU @ 1.70GHz
   [ INFO ]                OPTIMIZATION_CAPABILITIES: FP32, FP16, INT8, BIN
   [ INFO ]                RANGE_FOR_ASYNC_INFER_REQUESTS: 1, 1, 1
   [ INFO ]                RANGE_FOR_STREAMS: 1, 8
   [ INFO ]                IMPORT_EXPORT_SUPPORT: True
   [ INFO ]
   [ INFO ]        SUPPORTED_CONFIG_KEYS (default values):
   [ INFO ]                CACHE_DIR:
   [ INFO ]                CPU_BIND_THREAD: NO
   [ INFO ]                CPU_THREADS_NUM: 0
   [ INFO ]                CPU_THROUGHPUT_STREAMS: 1
   [ INFO ]                DUMP_EXEC_GRAPH_AS_DOT:
   [ INFO ]                ENFORCE_BF16: NO
   [ INFO ]                EXCLUSIVE_ASYNC_REQUESTS: NO
   [ INFO ]                PERFORMANCE_HINT:
   [ INFO ]                PERFORMANCE_HINT_NUM_REQUESTS: 0
   [ INFO ]                PERF_COUNT: NO
   [ INFO ]
   [ INFO ] GNA :
   [ INFO ]        SUPPORTED_METRICS:
   [ INFO ]                AVAILABLE_DEVICES: GNA_SW
   [ INFO ]                OPTIMAL_NUMBER_OF_INFER_REQUESTS: 1
   [ INFO ]                FULL_DEVICE_NAME: GNA_SW
   [ INFO ]                GNA_LIBRARY_FULL_VERSION: 3.0.0.1455
   [ INFO ]                IMPORT_EXPORT_SUPPORT: True
   [ INFO ]
   [ INFO ]        SUPPORTED_CONFIG_KEYS (default values):
   [ INFO ]                EXCLUSIVE_ASYNC_REQUESTS: NO
   [ INFO ]                GNA_COMPACT_MODE: YES
   [ INFO ]                GNA_COMPILE_TARGET:
   [ INFO ]                GNA_DEVICE_MODE: GNA_SW_EXACT
   [ INFO ]                GNA_EXEC_TARGET:
   [ INFO ]                GNA_FIRMWARE_MODEL_IMAGE:
   [ INFO ]                GNA_FIRMWARE_MODEL_IMAGE_GENERATION:
   [ INFO ]                GNA_LIB_N_THREADS: 1
   [ INFO ]                GNA_PRECISION: I16
   [ INFO ]                GNA_PWL_MAX_ERROR_PERCENT: 1.000000
   [ INFO ]                GNA_PWL_UNIFORM_DESIGN: NO
   [ INFO ]                GNA_SCALE_FACTOR: 1.000000
   [ INFO ]                GNA_SCALE_FACTOR_0: 1.000000
   [ INFO ]                LOG_LEVEL: LOG_NONE
   [ INFO ]                PERF_COUNT: NO
   [ INFO ]                SINGLE_THREAD: YES

See Also
########

- :doc:`Using OpenVINO™ Toolkit Samples <openvino_docs_OV_UG_Samples_Overview>`

@endsphinxdirective