Map configuration to API 2.0 properties (#23161)

### Details:
- *Create table to map some of the Inference Engine configurations to
API 2.0 C++/Python properties*
- *Provide configurations/properties header files for other
configurations/properties*

### Tickets:
 - *CVS-94044*

---------

Signed-off-by: Peter Chen <peter.chen@intel.com>
This commit is contained in:
Chen Peter 2024-03-01 15:25:44 +08:00 committed by GitHub
parent 0671bf3161
commit 004a6e9cf2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 74 additions and 0 deletions

View File

@ -417,4 +417,78 @@ Getting Information
:language: c
:fragment: compiled_model_get_ro_property
Configuration to property mapping
#################################
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| Inference Engine Configuration | API 2.0 C++ | API 2.0 Python |
+=======================================+==================================================+====================================================+
| CPU_DENORMALS_OPTIMIZATION | ov::intel_cpu::denormals_optimization | props.intel_cpu.denormals_optimization |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| CPU_SPARSE_WEIGHTS_DECOMPRESSION_RATE | ov::intel_cpu::sparse_weights_decompression_rate | props.intel_cpu.sparse_weights_decompression_rate |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| GPU_HOST_TASK_PRIORITY | ov::intel_gpu::hint::host_task_priority | props.intel_gpu.hint.host_task_priority |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| GPU_ENABLE_LOOP_UNROLLING | ov::intel_gpu::enable_loop_unrolling | props.intel_gpu.host_task_priority |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| GPU_THROUGHPUT_STREAMS | ov::num_streams | props.streams.num |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| MULTI_DEVICE_PRIORITIES | ov::device::priorities | props.device.priorities |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| MODEL_PRIORITY | ov::hint::model_priority | props.hint.model_priority |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| PERFORMANCE_HINT | ov::hint::performance_mode | props.hint.performance_mode |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| PERFORMANCE_HINT_NUM_REQUESTS | ov::hint::num_requests | props.hint.num_requests |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| ALLOW_AUTO_BATCHING | ov::hint::allow_auto_batching | props.hint.allow_auto_batching |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| AUTO_BATCH_DEVICE_CONFIG | ov::device::priorities | props.device.priorities |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| AUTO_BATCH_TIMEOUT | ov::auto_batch_timeout | props.auto_batch_timeout |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| CPU_THREADS_NUM | ov::inference_num_threads | props.inference_num_threads |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| CPU_BIND_THREAD | ov::hint::enable_cpu_pinning | props.hint.enable_cpu_pinning |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| CPU_THROUGHPUT_STREAMS | ov::num_streams | props.streams.num |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| PERF_COUNT | ov::enable_profiling | props.enable_profiling |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| LOG_LEVEL | ov::log::level | props.log.level |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| DEVICE_ID | ov::device::id | props.device.id |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| ENFORCE_BF16 | ov::hint::inference_precision(ov::element::bf16) | props.hint.inference_precision(openvino.Type.bf16) |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| CACHE_DIR | ov::cache_dir | props.cache_dir |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
| FORCE_TBB_TERMINATE | ov::force_tbb_terminate | props.force_tbb_terminate |
+---------------------------------------+--------------------------------------------------+----------------------------------------------------+
.. note::
API 2.0 Python "import openvino.properties as props"
More references
+++++++++++++++
InferenceEngine Engine Configuration
------------------------------------
- `src/inference/include/ie/ie_plugin_config.hpp <https://github.com/openvinotoolkit/openvino/blob/releases/2023/3/src/inference/include/ie/ie_plugin_config.hpp>`__
- `src/inference/include/ie/cpu/cpu_config.hpp <https://github.com/openvinotoolkit/openvino/blob/releases/2023/3/src/inference/include/ie/cpu/cpu_config.hpp>`__
- `src/inference/include/ie/gpu/gpu_config.hpp <https://github.com/openvinotoolkit/openvino/blob/releases/2023/3/src/inference/include/ie/gpu/gpu_config.hpp>`__
API 2.0 C++ properties
----------------------
- `src/inference/include/openvino/runtime/properties.hpp <https://github.com/openvinotoolkit/openvino/blob/releases/2023/3/src/inference/include/openvino/runtime/properties.hpp>`__
- `src/inference/include/openvino/runtime/intel_cpu/properties.hpp <https://github.com/openvinotoolkit/openvino/blob/releases/2023/3/src/inference/include/openvino/runtime/intel_cpu/properties.hpp>`__
- `src/inference/include/openvino/runtime/intel_gpu/properties.hpp <https://github.com/openvinotoolkit/openvino/blob/releases/2023/3/src/inference/include/openvino/runtime/intel_gpu/properties.hpp>`__
API 2.0 Python properties
-------------------------
- `src/bindings/python/src/pyopenvino/core/properties/properties.cpp <https://github.com/openvinotoolkit/openvino/blob/releases/2023/3/src/bindings/python/src/pyopenvino/core/properties/properties.cpp>`__
- `src/bindings/python/tests/test_runtime/test_properties.py <https://github.com/openvinotoolkit/openvino/blob/releases/2023/3/src/bindings/python/tests/test_runtime/test_properties.py>`__
Ask questions
-------------
- Go to "Forum", "Support", "Github"