diff --git a/src/plugins/intel_cpu/README.md b/src/plugins/intel_cpu/README.md index d64b0f3284dbcd..29646c7838aaea 100644 --- 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/src/plugins/intel_cpu/src/docs/compilation_options.md b/src/plugins/intel_cpu/docs/compilation_options.md similarity index 94% rename from src/plugins/intel_cpu/src/docs/compilation_options.md rename to src/plugins/intel_cpu/docs/compilation_options.md index 4662ca80a8f308..d292a042c6c8bc 100644 --- a/src/plugins/intel_cpu/src/docs/compilation_options.md +++ b/src/plugins/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/src/plugins/intel_cpu/src/docs/convPostOps.md b/src/plugins/intel_cpu/docs/convolution_post_ops.md similarity index 100% rename from src/plugins/intel_cpu/src/docs/convPostOps.md rename to src/plugins/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 deleted file mode 100644 index bffa9aff5fd9b6..00000000000000 --- a/src/plugins/intel_cpu/docs/debug_capabilities.md +++ /dev/null @@ -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) \ No newline at end of file diff --git a/src/plugins/intel_cpu/src/docs/README.md b/src/plugins/intel_cpu/docs/debug_capabilities/README.md similarity index 68% rename from src/plugins/intel_cpu/src/docs/README.md rename to src/plugins/intel_cpu/docs/debug_capabilities/README.md index 7203653b6ab44f..67817ece188b30 100644 --- a/src/plugins/intel_cpu/src/docs/README.md +++ b/src/plugins/intel_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/src/plugins/intel_cpu/src/docs/blob_dumping.md b/src/plugins/intel_cpu/docs/debug_capabilities/blob_dumping.md similarity index 95% rename from src/plugins/intel_cpu/src/docs/blob_dumping.md rename to src/plugins/intel_cpu/docs/debug_capabilities/blob_dumping.md index 00bb2a04d12ae9..d6d347afd4d2f6 100644 --- a/src/plugins/intel_cpu/src/docs/blob_dumping.md +++ b/src/plugins/intel_cpu/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/src/plugins/intel_cpu/src/docs/debug_caps_filters.md b/src/plugins/intel_cpu/docs/debug_capabilities/debug_caps_filters.md similarity index 100% rename from src/plugins/intel_cpu/src/docs/debug_caps_filters.md rename to src/plugins/intel_cpu/docs/debug_capabilities/debug_caps_filters.md diff --git a/src/plugins/intel_cpu/src/docs/feature_disabling.md b/src/plugins/intel_cpu/docs/debug_capabilities/feature_disabling.md similarity index 100% rename from src/plugins/intel_cpu/src/docs/feature_disabling.md rename to src/plugins/intel_cpu/docs/debug_capabilities/feature_disabling.md diff --git a/src/plugins/intel_cpu/src/docs/graph_serialization.md b/src/plugins/intel_cpu/docs/debug_capabilities/graph_serialization.md similarity index 100% rename from src/plugins/intel_cpu/src/docs/graph_serialization.md rename to src/plugins/intel_cpu/docs/debug_capabilities/graph_serialization.md diff --git a/src/plugins/intel_cpu/src/docs/logging.md b/src/plugins/intel_cpu/docs/debug_capabilities/logging.md similarity index 100% rename from src/plugins/intel_cpu/src/docs/logging.md rename to src/plugins/intel_cpu/docs/debug_capabilities/logging.md diff --git a/src/plugins/intel_cpu/src/docs/verbose.md b/src/plugins/intel_cpu/docs/debug_capabilities/verbose.md similarity index 100% rename from src/plugins/intel_cpu/src/docs/verbose.md rename to src/plugins/intel_cpu/docs/debug_capabilities/verbose.md diff --git a/src/plugins/intel_cpu/src/docs/fake_quantize.md b/src/plugins/intel_cpu/docs/fake_quantize.md similarity index 100% rename from src/plugins/intel_cpu/src/docs/fake_quantize.md rename to src/plugins/intel_cpu/docs/fake_quantize.md diff --git a/src/plugins/intel_cpu/src/docs/onednn_selective_build.md b/src/plugins/intel_cpu/docs/selective_build.md similarity index 97% rename from src/plugins/intel_cpu/src/docs/onednn_selective_build.md rename to src/plugins/intel_cpu/docs/selective_build.md index cfb57df4996f41..714a385b43e041 100644 --- a/src/plugins/intel_cpu/src/docs/onednn_selective_build.md +++ b/src/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/src/plugins/intel_cpu/src/docs/python_sigaltstack.md b/src/plugins/intel_cpu/docs/wa_amx_python_sigaltstack.md similarity index 100% rename from src/plugins/intel_cpu/src/docs/python_sigaltstack.md rename to src/plugins/intel_cpu/docs/wa_amx_python_sigaltstack.md