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

[Docs] Add Python snippets for configure devices (#10913)

Browse Source 
* Add Python docs for configure devices

* Bugfixes

* Minor changes

* Minor changes

* Format changes

* Minor changes
This commit is contained in:
Przemyslaw Wysocki 2022-03-11 19:17:22 +01:00 committed by GitHub
parent 23604ca28c
commit de3088adce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 123 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -46,23 +46,45 @@ OpenVINO Runtime API 2.0:
@sphinxdirective
.. tab:: Devices
.. tab:: C++
.. doxygensnippet:: docs/snippets/ov_properties_migration.cpp
:language: cpp
:fragment: [core_set_property]
.. tab:: Devices
.. tab:: Model Loading
.. doxygensnippet:: docs/snippets/ov_properties_migration.cpp
:language: cpp
:fragment: [core_set_property]
.. doxygensnippet:: docs/snippets/ov_properties_migration.cpp
:language: cpp
:fragment: [core_compile_model]
.. tab:: Model Loading
.. tab:: Execution
.. doxygensnippet:: docs/snippets/ov_properties_migration.cpp
:language: cpp
:fragment: [core_compile_model]
.. doxygensnippet:: docs/snippets/ov_properties_migration.cpp
:language: cpp
:fragment: [compiled_model_set_property]
.. tab:: Execution
.. doxygensnippet:: docs/snippets/ov_properties_migration.cpp
:language: cpp
:fragment: [compiled_model_set_property]
.. tab:: Python
.. tab:: Devices
.. doxygensnippet:: docs/snippets/ov_properties_migration.py
:language: python
:fragment: [core_set_property]
.. tab:: Model Loading
.. doxygensnippet:: docs/snippets/ov_properties_migration.py
:language: python
:fragment: [core_compile_model]
.. tab:: Execution
.. doxygensnippet:: docs/snippets/ov_properties_migration.py
:language: python
:fragment: [compiled_model_set_property]
@endsphinxdirective
@ -102,28 +124,56 @@ OpenVINO Runtime API 2.0:
@sphinxdirective
.. tab:: Device configuration
.. tab:: C++
.. doxygensnippet:: docs/snippets/ov_properties_migration.cpp
:language: cpp
:fragment: [core_get_rw_property]
.. tab:: Device configuration
.. tab:: Device metrics
.. doxygensnippet:: docs/snippets/ov_properties_migration.cpp
:language: cpp
:fragment: [core_get_rw_property]
.. doxygensnippet:: docs/snippets/ov_properties_migration.cpp
:language: cpp
:fragment: [core_get_ro_property]
.. tab:: Device metrics
.. tab:: Execution config
.. doxygensnippet:: docs/snippets/ov_properties_migration.cpp
:language: cpp
:fragment: [core_get_ro_property]
.. doxygensnippet:: docs/snippets/ov_properties_migration.cpp
:language: cpp
:fragment: [compiled_model_get_rw_property]
.. tab:: Execution config
.. tab:: Execution metrics
.. doxygensnippet:: docs/snippets/ov_properties_migration.cpp
:language: cpp
:fragment: [compiled_model_get_rw_property]
.. doxygensnippet:: docs/snippets/ov_properties_migration.cpp
:language: cpp
:fragment: [compiled_model_get_ro_property]
.. tab:: Execution metrics
.. doxygensnippet:: docs/snippets/ov_properties_migration.cpp
:language: cpp
:fragment: [compiled_model_get_ro_property]
.. tab:: Python
.. tab:: Device configuration
.. doxygensnippet:: docs/snippets/ov_properties_migration.py
:language: python
:fragment: [core_get_rw_property]
.. tab:: Device metrics
.. doxygensnippet:: docs/snippets/ov_properties_migration.py
:language: python
:fragment: [core_get_ro_property]
.. tab:: Execution config
.. doxygensnippet:: docs/snippets/ov_properties_migration.py
:language: python
:fragment: [compiled_model_get_rw_property]
.. tab:: Execution metrics
.. doxygensnippet:: docs/snippets/ov_properties_migration.py
:language: python
:fragment: [compiled_model_get_ro_property]
@endsphinxdirective

2
docs/snippets/ov_properties_migration.cpp
View File

@ -42,7 +42,7 @@ auto nireq = compiled_model.get_property(ov::optimal_number_of_infer_requests);
{
//! [compiled_model_get_rw_property]
ov::hint::PerformanceMode perf_model = compiled_model.get_property(ov::hint::performance_mode);
ov::hint::PerformanceMode perf_mode = compiled_model.get_property(ov::hint::performance_mode);
//! [compiled_model_get_rw_property]
}

44
docs/snippets/ov_properties_migration.py Normal file
View File

@ -0,0 +1,44 @@
# Copyright (C) 2018-2022 Intel Corporation
# SPDX-License-Identifier: Apache-2.0
#
from openvino.runtime import Core
core = Core()
# ! [core_set_property]
core.set_property(device_name="CPU", properties={"PERF_COUNT": "YES"})
# ! [core_set_property]
model = core.read_model("sample.xml")
# ! [core_compile_model]
compiled_model = core.compile_model(model=model, device_name="MULTI", config=
{
"MULTI_DEVICE_PRIORITIES": "GPU,CPU",
"PERFORMANCE_HINT": "THROUGHPUT",
"INFERENCE_PRECISION_HINT": "f32"
})
# ! [core_compile_model]
# ! [compiled_model_set_property]
# turn CPU off for multi-device execution
compiled_model.set_property(properties={"MULTI_DEVICE_PRIORITIES": "GPU"})
# ! [compiled_model_set_property]
# ! [core_get_rw_property]
num_streams = core.get_property("CPU", "NUM_STREAMS")
# ! [core_get_rw_property]
# ! [core_get_ro_property]
full_device_name = core.get_property("CPU", "FULL_DEVICE_NAME")
# ! [core_get_ro_property]
# ! [compiled_model_get_rw_property]
perf_mode = compiled_model.get_property("PERFORMANCE_HINT")
# ! [compiled_model_get_rw_property]
# ! [compiled_model_get_ro_property]
nireq = compiled_model.get_property("OPTIMAL_NUMBER_OF_INFER_REQUESTS")
# ! [compiled_model_get_ro_property]