diff --git a/.ci/azure/android_arm64.yml b/.ci/azure/android_arm64.yml index 715bd20f37f..9ca378e6e6b 100644 --- a/.ci/azure/android_arm64.yml +++ b/.ci/azure/android_arm64.yml @@ -8,6 +8,7 @@ trigger: - docs/ - /**/docs/* - /**/*.md + - README.md pr: branches: @@ -19,6 +20,7 @@ pr: - docs/ - /**/docs/* - /**/*.md + - README.md resources: repositories: diff --git a/.ci/azure/linux.yml b/.ci/azure/linux.yml index eb25e1cc2c8..771d094d0ce 100644 --- a/.ci/azure/linux.yml +++ b/.ci/azure/linux.yml @@ -8,6 +8,7 @@ trigger: - docs/ - /**/docs/* - /**/*.md + - README.md pr: branches: @@ -19,6 +20,7 @@ pr: - docs/ - /**/docs/* - /**/*.md + - README.md resources: repositories: diff --git a/.ci/azure/linux_arm64.yml b/.ci/azure/linux_arm64.yml index c906d4f5652..f30866e8aea 100644 --- a/.ci/azure/linux_arm64.yml +++ b/.ci/azure/linux_arm64.yml @@ -8,6 +8,7 @@ trigger: - docs/ - /**/docs/* - /**/*.md + - README.md pr: branches: @@ -19,6 +20,7 @@ pr: - docs/ - /**/docs/* - /**/*.md + - README.md resources: repositories: diff --git a/.ci/azure/linux_conditional_compilation.yml b/.ci/azure/linux_conditional_compilation.yml index 8a39e77cc7a..a829f1d3542 100644 --- a/.ci/azure/linux_conditional_compilation.yml +++ b/.ci/azure/linux_conditional_compilation.yml @@ -8,6 +8,7 @@ trigger: - docs/ - /**/docs/* - /**/*.md + - README.md pr: branches: @@ -19,6 +20,7 @@ pr: - docs/ - /**/docs/* - /**/*.md + - README.md jobs: - job: LinCC diff --git a/.ci/azure/linux_cuda.yml b/.ci/azure/linux_cuda.yml index cbfc27b7b82..26f34f69e64 100644 --- a/.ci/azure/linux_cuda.yml +++ b/.ci/azure/linux_cuda.yml @@ -8,6 +8,7 @@ trigger: - docs/ - /**/docs/* - /**/*.md + - README.md pr: branches: @@ -19,6 +20,7 @@ pr: - docs/ - /**/docs/* - /**/*.md + - README.md resources: repositories: diff --git a/.ci/azure/linux_debian.yml b/.ci/azure/linux_debian.yml index d987ad02e5a..805acec0605 100644 --- a/.ci/azure/linux_debian.yml +++ b/.ci/azure/linux_debian.yml @@ -8,6 +8,7 @@ trigger: - docs/ - /**/docs/* - /**/*.md + - README.md pr: branches: @@ -19,6 +20,7 @@ pr: - docs/ - /**/docs/* - /**/*.md + - README.md resources: repositories: diff --git a/.ci/azure/linux_ngraph_onnx.yml b/.ci/azure/linux_ngraph_onnx.yml index 93a722770ae..5a916bdbb50 100644 --- a/.ci/azure/linux_ngraph_onnx.yml +++ b/.ci/azure/linux_ngraph_onnx.yml @@ -8,6 +8,7 @@ trigger: - docs/ - /**/docs/* - /**/*.md + - README.md pr: branches: @@ -19,6 +20,7 @@ pr: - docs/ - /**/docs/* - /**/*.md + - README.md jobs: - job: OpenVINO_ONNX_CI diff --git a/.ci/azure/linux_onnxruntime.yml b/.ci/azure/linux_onnxruntime.yml index 5f58dbb4f85..253b442784a 100644 --- a/.ci/azure/linux_onnxruntime.yml +++ b/.ci/azure/linux_onnxruntime.yml @@ -8,6 +8,7 @@ trigger: - docs/ - /**/docs/* - /**/*.md + - README.md pr: branches: @@ -19,6 +20,7 @@ pr: - docs/ - /**/docs/* - /**/*.md + - README.md jobs: - job: onnxruntime diff --git a/.ci/azure/mac.yml b/.ci/azure/mac.yml index f552a085d32..22bbc52ad9f 100644 --- a/.ci/azure/mac.yml +++ b/.ci/azure/mac.yml @@ -8,6 +8,7 @@ trigger: - docs/ - /**/docs/* - /**/*.md + - README.md pr: branches: @@ -19,6 +20,7 @@ pr: - docs/ - /**/docs/* - /**/*.md + - README.md resources: repositories: diff --git a/.ci/azure/windows.yml b/.ci/azure/windows.yml index 2dbf79a6b3b..83edf561722 100644 --- a/.ci/azure/windows.yml +++ b/.ci/azure/windows.yml @@ -8,6 +8,7 @@ trigger: - docs/ - /**/docs/* - /**/*.md + - README.md pr: branches: @@ -19,6 +20,7 @@ pr: - docs/ - /**/docs/* - /**/*.md + - README.md resources: repositories: diff --git a/.ci/azure/windows_conditional_compilation.yml b/.ci/azure/windows_conditional_compilation.yml index d70aa7d4392..38530d4321d 100644 --- a/.ci/azure/windows_conditional_compilation.yml +++ b/.ci/azure/windows_conditional_compilation.yml @@ -8,6 +8,7 @@ trigger: - docs/ - /**/docs/* - /**/*.md + - README.md pr: branches: @@ -19,6 +20,7 @@ pr: - docs/ - /**/docs/* - /**/*.md + - README.md jobs: - job: WinCC diff --git a/README.md b/README.md index 879be8daff6..ab3135ed86b 100644 --- a/README.md +++ b/README.md @@ -40,18 +40,18 @@ source and public models in popular formats such as TensorFlow, ONNX, PaddlePadd ### Components * [OpenVINO™ Runtime] - is a set of C++ libraries with C and Python bindings providing a common API to deliver inference solutions on the platform of your choice. - * [core](https://github.com/openvinotoolkit/openvino/tree/master/src/core) - provides the base API for model representation and modification. - * [inference](https://github.com/openvinotoolkit/openvino/tree/master/src/inference) - provides an API to infer models on device. - * [transformations](https://github.com/openvinotoolkit/openvino/tree/master/src/common/transformations) - contains the set of common transformations which are used in OpenVINO plugins. - * [low precision transformations](https://github.com/openvinotoolkit/openvino/tree/master/src/common/low_precision_transformations) - contains the set of transformations which are used in low precision models - * [bindings](https://github.com/openvinotoolkit/openvino/tree/master/src/bindings) - contains all available OpenVINO bindings which are maintained by OpenVINO team. - * [c](https://github.com/openvinotoolkit/openvino/tree/master/src/bindings/c) - provides C API for OpenVINO™ Runtime - * [python](https://github.com/openvinotoolkit/openvino/tree/master/src/bindings/python) - Python API for OpenVINO™ Runtime -* [Plugins](https://github.com/openvinotoolkit/openvino/tree/master/src/plugins) - contains OpenVINO plugins which are maintained in open-source by OpenVINO team. For more information please take a look to the [list of supported devices](#supported-hardware-matrix). -* [Frontends](https://github.com/openvinotoolkit/openvino/tree/master/src/frontends) - contains available OpenVINO frontends which allow to read model from native framework format. + * [core](./src/core) - provides the base API for model representation and modification. + * [inference](./src/inference) - provides an API to infer models on the device. + * [transformations](./src/common/transformations) - contains the set of common transformations which are used in OpenVINO plugins. + * [low precision transformations](./src/common/low_precision_transformations) - contains the set of transformations that are used in low precision models + * [bindings](./src/bindings) - contains all available OpenVINO bindings which are maintained by the OpenVINO team. + * [c](./src/bindings/c) - provides C API for OpenVINO™ Runtime + * [python](./src/bindings/python) - Python API for OpenVINO™ Runtime +* [Plugins](./src/plugins) - contains OpenVINO plugins which are maintained in open-source by OpenVINO team. For more information, take a look at the [list of supported devices](#supported-hardware-matrix). +* [Frontends](./src/frontends) - contains available OpenVINO frontends that allow reading models from the native framework format. * [Model Optimizer] - is a cross-platform command-line tool that facilitates the transition between training and deployment environments, performs static model analysis, and adjusts deep learning models for optimal execution on end-point target devices. * [Post-Training Optimization Tool] - is designed to accelerate the inference of deep learning models by applying special methods without model retraining or fine-tuning, for example, post-training 8-bit quantization. -* [Samples] - applications on C, C++ and Python languages which shows basic use cases of OpenVINO usages. +* [Samples] - applications in C, C++ and Python languages that show basic OpenVINO use cases. ## Supported Hardware matrix @@ -70,7 +70,7 @@ The OpenVINO™ Runtime can infer models on different hardware devices. This sec CPU Intel CPU - openvino_intel_cpu_plugin + openvino_intel_cpu_plugin Intel Xeon with Intel® Advanced Vector Extensions 2 (Intel® AVX2), Intel® Advanced Vector Extensions 512 (Intel® AVX-512), and AVX512_BF16, Intel Core Processors with Intel AVX2, Intel Atom Processors with Intel® Streaming SIMD Extensions (Intel® SSE) @@ -81,19 +81,19 @@ The OpenVINO™ Runtime can infer models on different hardware devices. This sec GPU Intel GPU - openvino_intel_gpu_plugin + openvino_intel_gpu_plugin Intel Processor Graphics, including Intel HD Graphics and Intel Iris Graphics GNA Intel GNA - openvino_intel_gna_plugin + openvino_intel_gna_plugin Intel Speech Enabling Developer Kit, Amazon Alexa* Premium Far-Field Developer Kit, Intel Pentium Silver J5005 Processor, Intel Pentium Silver N5000 Processor, Intel Celeron J4005 Processor, Intel Celeron J4105 Processor, Intel Celeron Processor N4100, Intel Celeron Processor N4000, Intel Core i3-8121U Processor, Intel Core i7-1065G7 Processor, Intel Core i7-1060G7 Processor, Intel Core i5-1035G4 Processor, Intel Core i5-1035G7 Processor, Intel Core i5-1035G1 Processor, Intel Core i5-1030G7 Processor, Intel Core i5-1030G4 Processor, Intel Core i3-1005G1 Processor, Intel Core i3-1000G1 Processor, Intel Core i3-1000G4 Processor VPU Myriad plugin - openvino_intel_myriad_plugin + openvino_intel_myriad_plugin Intel® Neural Compute Stick 2 powered by the Intel® Movidius™ Myriad™ X @@ -111,22 +111,22 @@ Also OpenVINO™ Toolkit contains several plugins which should simplify to load Auto - openvino_auto_plugin + openvino_auto_plugin Auto plugin enables selecting Intel device for inference automatically Auto Batch - openvino_auto_batch_plugin + openvino_auto_batch_plugin Auto batch plugin performs on-the-fly automatic batching (i.e. grouping inference requests together) to improve device utilization, with no programming effort from the user Hetero - openvino_hetero_plugin + openvino_hetero_plugin Heterogeneous execution enables automatic inference splitting between several devices Multi - openvino_auto_plugin + openvino_auto_plugin Multi plugin enables simultaneous inference of the same model on several devices in parallel diff --git a/src/README.md b/src/README.md index f0c17842d2e..192663bf4f0 100644 --- a/src/README.md +++ b/src/README.md @@ -45,30 +45,17 @@ flowchart LR OpenVINO Frontends allow to convert model from framework to OpenVINO representation. - * [ir](./frontends/ir/README.md) - * [onnx](./frontends/onnx) - * [paddle](./frontends/paddle) - * [tensorflow](./frontends/tensorflow) - +Go to the [Frontends page](./frontends/README.md) to get more information. + ## OpenVINO Plugins -Plugins provide a support of hardware device +OpenVINO Plugins provide support for hardware devices. - * [auto](./plugins/auto) - * [auto_batch](./plugins/auto_batch) - * [hetero](./plugins/hetero) - * [intel_cpu](./plugins/intel_cpu) - * [intel_gna](./plugins/intel_gna) - * [intel_gpu](./plugins/intel_gpu) - * [intel_myriad](./plugins/intel_myriad) - * [template](./plugins/template) +To get more information about supported OpenVINO Plugins, go to the [Plugins page](./plugins/README.md). ## OpenVINO Bindings -OpenVINO provides bindings for several languages: - - * [c](./bindings/c) - * [python](./bindings/python) +OpenVINO provides bindings for different languages. To get the full list of supported languages, go to the [page](./bindings/README.md). ## Core developer topics diff --git a/src/bindings/README.md b/src/bindings/README.md new file mode 100644 index 00000000000..12065ed7e76 --- /dev/null +++ b/src/bindings/README.md @@ -0,0 +1,11 @@ +## OpenVINO Bindings + +OpenVINO provides bindings for several languages: + + * [c](./c) + * [python](./python) + +## See also + * [OpenVINO™ README](../../README.md) + * [OpenVINO Core Components](../README.md) + * [Developer documentation](../../docs/dev/index.md) diff --git a/src/frontends/README.md b/src/frontends/README.md new file mode 100644 index 00000000000..43b399d287c --- /dev/null +++ b/src/frontends/README.md @@ -0,0 +1,15 @@ +# OpenVINO Frontends + +OpenVINO Frontends allow converting models from the native framework to OpenVINO representation. + +Below is the full list of supported frontends: + + * [ir](./ir/README.md) + * [onnx](./onnx) + * [paddle](./paddle) + * [tensorflow](./tensorflow) + +## See also + * [OpenVINO™ README](../../README.md) + * [OpenVINO Core Components](../README.md) + * [Developer documentation](../../docs/dev/index.md) diff --git a/src/frontends/ir/README.md b/src/frontends/ir/README.md index 0a93b1f1242..4e98a743a00 100644 --- a/src/frontends/ir/README.md +++ b/src/frontends/ir/README.md @@ -31,7 +31,7 @@ OpenVINO IR Frontend contains the next components: ## Architecture -OpenVINO IR Frontend uses [pugixml](../../../thirdparty/pugixml/README.md) library to parse xml files. +OpenVINO IR Frontend uses [pugixml](https://github.com/zeux/pugixml/blob/master/README.md) library to parse xml files. For detailed information about OpenVINO IR Frontend architecture, read the [architecture guide](./docs/architecture.md). ## Tutorials diff --git a/src/frontends/ir/docs/architecture.md b/src/frontends/ir/docs/architecture.md index 857a0aa68e8..3bee0108e08 100644 --- a/src/frontends/ir/docs/architecture.md +++ b/src/frontends/ir/docs/architecture.md @@ -1,6 +1,6 @@ # OpenVINO IR Frontend Architecture -OpenVINO IR Frontend uses [pugixml](../../../thirdparty/pugixml/README.md) library to parse XML files. After that, based on the version and name of the operation, the Frontend creates the supported operation and initializes it using OpenVINO Visitor API: +OpenVINO IR Frontend uses [pugixml](https://github.com/zeux/pugixml/blob/master/README.md) library to parse XML files. After that, based on the version and name of the operation, the Frontend creates the supported operation and initializes it using OpenVINO Visitor API: ```mermaid flowchart TB fw_model[(IR)] diff --git a/src/plugins/README.md b/src/plugins/README.md new file mode 100644 index 00000000000..a3cf97c383f --- /dev/null +++ b/src/plugins/README.md @@ -0,0 +1,19 @@ +# OpenVINO Plugins + +OpenVINO Plugins provide support for hardware devices. + +The list of supported plugins: + + * [auto](./auto) + * [auto_batch](./auto_batch) + * [hetero](./hetero) + * [intel_cpu](./intel_cpu) + * [intel_gna](./intel_gna) + * [intel_gpu](./intel_gpu) + * [intel_myriad](./intel_myriad) + * [template](./template) + +## See also + * [OpenVINO™ README](../../README.md) + * [OpenVINO Core Components](../README.md) + * [Developer documentation](../../docs/dev/index.md)