[DOCS] Debugging Auto-Device Plugin rst shift + Notebooks installation id align for master (#18240)
* Update AutoPlugin_Debugging.md * Update AutoPlugin_Debugging.md * Update AutoPlugin_Debugging.md * Update AutoPlugin_Debugging.md * notebooks id fix * fixes
This commit is contained in:
Maciej Smyk
GitHub
@@ -1,19 +1,26 @@
|
||||
# Debugging Auto-Device Plugin {#openvino_docs_OV_UG_supported_plugins_AUTO_debugging}
|
||||
|
||||
## Using Debug Log
|
||||
In case of execution problems, just like all other plugins, Auto-Device provides the user with information on exceptions and error values. If the returned data is not enough for debugging purposes, more information may be acquired by means of `ov::log::Level`.
|
||||
|
||||
There are six levels of logs, which can be called explicitly or set via the `OPENVINO_LOG_LEVEL` environment variable (can be overwritten by `compile_model()` or `set_property()`):
|
||||
|
||||
0 - ov::log::Level::NO
|
||||
1 - ov::log::Level::ERR
|
||||
2 - ov::log::Level::WARNING
|
||||
3 - ov::log::Level::INFO
|
||||
4 - ov::log::Level::DEBUG
|
||||
5 - ov::log::Level::TRACE
|
||||
|
||||
@sphinxdirective
|
||||
|
||||
Using Debug Log
|
||||
###############
|
||||
|
||||
In case of execution problems, just like all other plugins, Auto-Device provides the user with information on exceptions and error values. If the returned data is not enough for debugging purposes, more information may be acquired by means of ``ov::log::Level``.
|
||||
|
||||
There are six levels of logs, which can be called explicitly or set via the ``OPENVINO_LOG_LEVEL`` environment variable (can be overwritten by ``compile_model()`` or ``set_property()``):
|
||||
|
||||
0 - `ov::log::Level::NO <https://docs.openvino.ai/nightly/enumov_1_1log_1_1Level.html#doxid-group-ov-runtime-cpp-prop-api-1gga9868e1ed6b0286d17cdb0ab85b2cc66bac2f3f489a00553e7a01d369c103c7251>`__
|
||||
|
||||
1 - `ov::log::Level::ERR <https://docs.openvino.ai/nightly/enumov_1_1log_1_1Level.html#doxid-group-ov-runtime-cpp-prop-api-1gga9868e1ed6b0286d17cdb0ab85b2cc66bac2f3f489a00553e7a01d369c103c7251>`__
|
||||
|
||||
2 - `ov::log::Level::WARNING <https://docs.openvino.ai/nightly/enumov_1_1log_1_1Level.html#doxid-group-ov-runtime-cpp-prop-api-1gga9868e1ed6b0286d17cdb0ab85b2cc66bac2f3f489a00553e7a01d369c103c7251>`__
|
||||
|
||||
3 - `ov::log::Level::INFO <https://docs.openvino.ai/nightly/enumov_1_1log_1_1Level.html#doxid-group-ov-runtime-cpp-prop-api-1gga9868e1ed6b0286d17cdb0ab85b2cc66bac2f3f489a00553e7a01d369c103c7251>`__
|
||||
|
||||
4 - `ov::log::Level::DEBUG <https://docs.openvino.ai/nightly/enumov_1_1log_1_1Level.html#doxid-group-ov-runtime-cpp-prop-api-1gga9868e1ed6b0286d17cdb0ab85b2cc66bac2f3f489a00553e7a01d369c103c7251>`__
|
||||
|
||||
5 - `ov::log::Level::TRACE <https://docs.openvino.ai/nightly/enumov_1_1log_1_1Level.html#doxid-group-ov-runtime-cpp-prop-api-1gga9868e1ed6b0286d17cdb0ab85b2cc66bac2f3f489a00553e7a01d369c103c7251>`__
|
||||
|
||||
.. tab-set::
|
||||
|
||||
.. tab-item:: C++
|
||||
@@ -43,79 +50,77 @@ There are six levels of logs, which can be called explicitly or set via the `OPE
|
||||
|
||||
Windows
|
||||
set OPENVINO_LOG_LEVEL=0
|
||||
|
||||
@endsphinxdirective
|
||||
|
||||
The property returns information in the following format:
|
||||
|
||||
@sphinxdirective
|
||||
.. code-block:: sh
|
||||
|
||||
[time]LOG_LEVEL[file] [PLUGIN]: message
|
||||
@endsphinxdirective
|
||||
|
||||
in which the `LOG_LEVEL` is represented by the first letter of its name (ERROR being an exception and using its full name). For example:
|
||||
in which the ``LOG_LEVEL`` is represented by the first letter of its name (ERROR being an exception and using its full name). For example:
|
||||
|
||||
@sphinxdirective
|
||||
.. code-block:: sh
|
||||
|
||||
[17:09:36.6188]D[plugin.cpp:167] deviceName:GPU, defaultDeviceID:, uniqueName:GPU_
|
||||
[17:09:36.6242]I[executable_network.cpp:181] [AUTOPLUGIN]:select device:GPU
|
||||
[17:09:36.6809]ERROR[executable_network.cpp:384] [AUTOPLUGIN] load failed, GPU:[ GENERAL_ERROR ]
|
||||
@endsphinxdirective
|
||||
|
||||
|
||||
## Instrumentation and Tracing Technology
|
||||
Instrumentation and Tracing Technology
|
||||
######################################
|
||||
|
||||
All major performance calls of both OpenVINO™ Runtime and the AUTO plugin are instrumented with Instrumentation and Tracing Technology (ITT) APIs. To enable ITT in OpenVINO™ Runtime, compile it with the following option:
|
||||
@sphinxdirective
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
-DENABLE_PROFILING_ITT=ON
|
||||
@endsphinxdirective
|
||||
|
||||
|
||||
For more information, you can refer to:
|
||||
* [Intel® VTune™ Profiler User Guide](https://www.intel.com/content/www/us/en/develop/documentation/vtune-help/top/api-support/instrumentation-and-tracing-technology-apis.html)
|
||||
|
||||
### Analyze Code Performance on Linux
|
||||
* `Intel® VTune™ Profiler User Guide <https://www.intel.com/content/www/us/en/develop/documentation/vtune-help/top/api-support/instrumentation-and-tracing-technology-apis.html>`__
|
||||
|
||||
You can analyze code performance using Intel® VTune™ Profiler. For more information and installation instructions refer to the [installation guide (PDF)](https://software.intel.com/content/www/us/en/develop/download/intel-vtune-install-guide-linux-os.html)
|
||||
Analyze Code Performance on Linux
|
||||
+++++++++++++++++++++++++++++++++
|
||||
|
||||
You can analyze code performance using Intel® VTune™ Profiler. For more information and installation instructions refer to the `installation guide (PDF) <https://software.intel.com/content/www/us/en/develop/download/intel-vtune-install-guide-linux-os.html>`__
|
||||
With Intel® VTune™ Profiler installed you can configure your analysis with the following steps:
|
||||
|
||||
1. Open Intel® VTune™ Profiler GUI on the host machine with the following command:
|
||||
@sphinxdirective
|
||||
|
||||
.. code-block:: sh
|
||||
.. code-block:: sh
|
||||
|
||||
cd /vtune install dir/intel/oneapi/vtune/2021.6.0/env
|
||||
source vars.sh
|
||||
vtune-gui
|
||||
|
||||
cd /vtune install dir/intel/oneapi/vtune/2021.6.0/env
|
||||
source vars.sh
|
||||
vtune-gui
|
||||
@endsphinxdirective
|
||||
|
||||
2. select **Configure Analysis**
|
||||
2. Select **Configure Analysis**
|
||||
|
||||
3. In the **where** pane, select **Local Host**
|
||||
@sphinxdirective
|
||||
.. image:: _static/images/OV_UG_supported_plugins_AUTO_debugging-img01-localhost.png
|
||||
:align: center
|
||||
@endsphinxdirective
|
||||
|
||||
.. image:: _static/images/OV_UG_supported_plugins_AUTO_debugging-img01-localhost.png
|
||||
:align: center
|
||||
|
||||
4. In the **what** pane, specify your target application/script on the local system.
|
||||
@sphinxdirective
|
||||
.. image:: _static/images/OV_UG_supported_plugins_AUTO_debugging-img02-launch.png
|
||||
:align: center
|
||||
@endsphinxdirective
|
||||
5. In the **how** pane, choose and configure the analysis type you want to perform, for example, **Hotspots Analysis**:
|
||||
identify the most time-consuming functions and drill down to see time spent on each line of source code. Focus optimization efforts on hot code for the greatest performance impact.
|
||||
@sphinxdirective
|
||||
.. image:: _static/images/OV_UG_supported_plugins_AUTO_debugging-img03-hotspots.png
|
||||
:align: center
|
||||
@endsphinxdirective
|
||||
6. Start the analysis by clicking the start button. When it is done, you will get a summary of the run, including top hotspots and top tasks in your application:
|
||||
@sphinxdirective
|
||||
.. image:: _static/images/OV_UG_supported_plugins_AUTO_debugging-img04-vtunesummary.png
|
||||
:align: center
|
||||
@endsphinxdirective
|
||||
|
||||
.. image:: _static/images/OV_UG_supported_plugins_AUTO_debugging-img02-launch.png
|
||||
:align: center
|
||||
|
||||
5. In the **how** pane, choose and configure the analysis type you want to perform, for example, **Hotspots Analysis**: identify the most time-consuming functions and drill down to see time spent on each line of source code. Focus optimization efforts on hot code for the greatest performance impact.
|
||||
|
||||
.. image:: _static/images/OV_UG_supported_plugins_AUTO_debugging-img03-hotspots.png
|
||||
:align: center
|
||||
|
||||
6. Start the analysis by clicking the start button. When it is done, you will get a summary of the run, including top hotspots and top tasks in your application:
|
||||
|
||||
.. image:: _static/images/OV_UG_supported_plugins_AUTO_debugging-img04-vtunesummary.png
|
||||
:align: center
|
||||
|
||||
7. To analyze ITT info related to the Auto plugin, click on the **Bottom-up** tab, choose the **Task Domain/Task Type/Function/Call Stack** from the dropdown list - Auto plugin-related ITT info is under the MULTIPlugin task domain:
|
||||
@sphinxdirective
|
||||
.. image:: _static/images/OV_UG_supported_plugins_AUTO_debugging-img05-vtunebottomup.png
|
||||
:align: center
|
||||
|
||||
.. image:: _static/images/OV_UG_supported_plugins_AUTO_debugging-img05-vtunebottomup.png
|
||||
:align: center
|
||||
|
||||
|
||||
@endsphinxdirective
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Installation of OpenVINO™ Notebooks {#notebooks-installation}
|
||||
# Installation of OpenVINO™ Notebooks {#notebooks_installation}
|
||||
|
||||
|
||||
@sphinxdirective
|
||||
@@ -22,10 +22,10 @@ Follow the guide below in order to run and manage the notebooks on your machine.
|
||||
Contents:
|
||||
|
||||
- `Installation Guide <#-installation-guide>`__
|
||||
- `Run the Notebooks <#-run-the-notebooks>`__
|
||||
- `Manage the notebooks <#-manage-the-notebooks>`__
|
||||
- `Troubleshooting <#-troubleshooting>`__
|
||||
- `FAQ <#-faq>`__
|
||||
- `Run the Notebooks <#-run-the-notebooks>`__
|
||||
- `Manage the notebooks <#-manage-the-notebooks>`__
|
||||
- `Troubleshooting <#-troubleshooting>`__
|
||||
- `FAQ <#-faq>`__
|
||||
|
||||
--------------------
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@
|
||||
:caption: Notebooks
|
||||
:hidden:
|
||||
|
||||
notebooks-installation
|
||||
notebooks_installation
|
||||
notebooks/notebooks
|
||||
|
||||
This collection of Python tutorials are written for running on Jupyter notebooks.
|
||||
@@ -36,7 +36,7 @@ see the `Additional Resources <#-additional-resources>`__ section).
|
||||
|
||||
.. note::
|
||||
For the best performance, more control and resources, you should run the notebooks locally.
|
||||
Follow the `Installation Guide <notebooks-installation.html>`__ in order to get information
|
||||
Follow the :doc:`Installation Guide <notebooks_installation>` in order to get information
|
||||
on how to run and manage the notebooks on your machine.
|
||||
|
||||
|
||||
@@ -328,7 +328,7 @@ The following tutorials are guaranteed to provide a great experience with infere
|
||||
-------------------
|
||||
|
||||
.. note::
|
||||
If there are any issues while running the notebooks, refer to the **Troubleshooting** and **FAQ** sections in the `Installation Guide <notebooks-installation.html>`__ or start a GitHub
|
||||
If there are any issues while running the notebooks, refer to the **Troubleshooting** and **FAQ** sections in the :doc:`Installation Guide <notebooks_installation>` or start a GitHub
|
||||
`discussion <https://github.com/openvinotoolkit/openvino_notebooks/discussions>`__.
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user