[CPU] Reorganize development documentation (#16708)

openvinotoolkit · May 17, 2023 · 1e878b6 · 1e878b6
1 parent e14d1b2
commit 1e878b6
Show file tree

Hide file tree

Showing 14 changed files with 9 additions and 32 deletions.
diff --git a/src/plugins/intel_cpu/README.md b/src/plugins/intel_cpu/README.md
@@ -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
 

diff --git a/...intel_cpu/src/docs/compilation_options.md → ...ins/intel_cpu/docs/compilation_options.md b/...intel_cpu/src/docs/compilation_options.md → ...ins/intel_cpu/docs/compilation_options.md
@@ -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`

diff --git a/...plugins/intel_cpu/src/docs/convPostOps.md → ...ns/intel_cpu/docs/convolution_post_ops.md b/...plugins/intel_cpu/src/docs/convPostOps.md → ...ns/intel_cpu/docs/convolution_post_ops.md
diff --git a/src/plugins/intel_cpu/docs/debug_capabilities.md b/src/plugins/intel_cpu/docs/debug_capabilities.md
diff --git a/src/plugins/intel_cpu/src/docs/README.md → ...tel_cpu/docs/debug_capabilities/README.md b/src/plugins/intel_cpu/src/docs/README.md → ...tel_cpu/docs/debug_capabilities/README.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`

diff --git a/...lugins/intel_cpu/src/docs/blob_dumping.md → ...u/docs/debug_capabilities/blob_dumping.md b/...lugins/intel_cpu/src/docs/blob_dumping.md → ...u/docs/debug_capabilities/blob_dumping.md
@@ -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:

diff --git a/.../intel_cpu/src/docs/debug_caps_filters.md → .../debug_capabilities/debug_caps_filters.md b/.../intel_cpu/src/docs/debug_caps_filters.md → .../debug_capabilities/debug_caps_filters.md
diff --git a/...s/intel_cpu/src/docs/feature_disabling.md → ...s/debug_capabilities/feature_disabling.md b/...s/intel_cpu/src/docs/feature_disabling.md → ...s/debug_capabilities/feature_disabling.md
diff --git a/...intel_cpu/src/docs/graph_serialization.md → ...debug_capabilities/graph_serialization.md b/...intel_cpu/src/docs/graph_serialization.md → ...debug_capabilities/graph_serialization.md
diff --git a/src/plugins/intel_cpu/src/docs/logging.md → ...el_cpu/docs/debug_capabilities/logging.md b/src/plugins/intel_cpu/src/docs/logging.md → ...el_cpu/docs/debug_capabilities/logging.md
diff --git a/src/plugins/intel_cpu/src/docs/verbose.md → ...el_cpu/docs/debug_capabilities/verbose.md b/src/plugins/intel_cpu/src/docs/verbose.md → ...el_cpu/docs/debug_capabilities/verbose.md
diff --git a/...ugins/intel_cpu/src/docs/fake_quantize.md → src/plugins/intel_cpu/docs/fake_quantize.md b/...ugins/intel_cpu/src/docs/fake_quantize.md → src/plugins/intel_cpu/docs/fake_quantize.md
diff --git a/...el_cpu/src/docs/onednn_selective_build.md → ...plugins/intel_cpu/docs/selective_build.md b/...el_cpu/src/docs/onednn_selective_build.md → ...plugins/intel_cpu/docs/selective_build.md
@@ -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:

diff --git a/.../intel_cpu/src/docs/python_sigaltstack.md → ...tel_cpu/docs/wa_amx_python_sigaltstack.md b/.../intel_cpu/src/docs/python_sigaltstack.md → ...tel_cpu/docs/wa_amx_python_sigaltstack.md