[CPU] Reorganize development documentation (#16708)

This commit is contained in:
Egor Duplenskii authored and GitHub committed 2023-05-17 17:29:47 +04:00
1 parent e14d1b2a07
commit 1e878b6a01
14 files changed
+9 -32

No files matched your search

+4 -1
View File
@@ -16,11 +16,14 @@ CPU Plugin contains the following components:
## Tutorials
* [Debug capabilities](./docs/debug_capabilities.md)
* [Debug capabilities](./docs/debug_capabilities/README.md)
* [Performance analysis using ITT counters](./docs/performance_analysis_ITT_counters.md)
* [Intel Software Development Emulator (CPU emulation)](./docs/cpu_emulation.md)
* [Runtime parameters cache](./docs/runtime_parameters_cache.md)
* [Internal CPU Plugin Optimizations](./docs/internal_cpu_plugin_optimization.md)
* [FakeQuantize insights and optimizations](./docs/fake_quantize.md)
* [Selective build (Conditional Compilation)](./docs/selective_build.md)
* [Workaround for python stack size on AMX hosts](./docs/wa_amx_python_sigaltstack.md)
## See also
@@ -2,7 +2,7 @@
The following compilation options can be helpful in developing CPU plugin
* `ENABLE_DEBUG_CAPS=ON`
See [Debug capabilities](README.md#debug_capabilities)
See [Debug capabilities](./debug_capabilities/README.md)
* `ENABLE_CPU_SUBSET_TESTS_PATH="relative/path/to/test/file"`
* Example: `-DENABLE_CPU_SUBSET_TESTS_PATH="single_layer_tests/convolution.cpp subgraph_tests/src/mha.cpp"`
* Specifies the list of relative paths to functional tests which will be included into the new target `ov_cpu_func_tests_subset`
@@ -1,22 +0,0 @@
# CPU Plugin Debug Capabilities
The page describes a list of useful debug features, controlled by environment variables.
They can be activated at runtime and might be used for analyzing issues, getting more context, comparing execution results, etc.
To have CPU debug capabilities available at runtime, use the following CMake option when building the plugin:
* `ENABLE_DEBUG_CAPS`. Default is `OFF`
The following debug capabilities are available with the latest OpenVINO:
- [Verbose mode](../src/docs/verbose.md)
- [Blob dumping](../src/docs/blob_dumping.md)
- [Graph serialization](../src/docs/graph_serialization.md)
## See also
* [OpenVINO™ README](../../../../README.md)
* [OpenVINO Core Components](../../../README.md)
* [OpenVINO Plugins](../../README.md)
* [OpenVINO GPU Plugin](../README.md)
* [Developer documentation](../../../../docs/dev/index.md)
@@ -1,10 +1,8 @@
# OpenVINO CPU plugin
Development documentation of OpenVINO CPU plugin
# Debug capabilities
Debug capabilities are the set of useful debug features, controlled by environment variables.
## Compilation options
See [Compilation options](compilation_options.md)
They can be activated at runtime and might be used for analyzing issues, getting more context, comparing execution results, etc.
## Debug capabilities
Use the following cmake option to enable debug capabilities:
`-DENABLE_DEBUG_CAPS=ON`
@@ -66,7 +66,7 @@ Example:
OV_CPU_BLOB_DUMP_NODE_TYPE='Convolution Reorder' binary ...
```
> **NOTE**: see **enum Type** in [node.h](../node.h) for list of the types
> **NOTE**: see **enum Type** in [node.h](../../src/cpu_types.h) for list of the types
## Filter by name
To dump blobs only for nodes with name matching specified regex:
@@ -2,8 +2,6 @@
## Introduction
Selective build or conditional compilation can significantly reduce OpenVINO™ binaries size by excluding unnecessary components for particular model's inference.
Here we enable the selective build function on oneDNN plugin.
## Workflow
Onednn path in OpenVINO: