From 64b7c2b2e07557312a7c72f6771e34e4c7cca890 Mon Sep 17 00:00:00 2001 From: Karol Blaszczak Date: Tue, 24 Sep 2024 11:56:48 +0200 Subject: [PATCH] [DOCS] separate OV integrations section --- docs/articles_en/about-openvino.rst | 24 +++++++-------- .../supported-devices.rst | 1 - .../assets/images/deploy_encrypted_model.svg | 4 +-- docs/articles_en/documentation.rst | 21 +++++++++----- .../documentation/openvino-security.rst | 4 +-- docs/articles_en/openvino-ecosystem.rst | 20 +++++++++++++ .../openvino-integrations.rst | 11 +++++++ .../openvino-project.rst} | 29 +++++++++++-------- .../openvino-project}/datumaro.rst | 0 .../openvino-security-add-on.rst | 0 .../openvino-training-extensions.rst | 0 docs/sphinx_setup/index.rst | 1 + 12 files changed, 79 insertions(+), 36 deletions(-) create mode 100644 docs/articles_en/openvino-ecosystem.rst create mode 100644 docs/articles_en/openvino-ecosystem/openvino-integrations.rst rename docs/articles_en/{documentation/openvino-ecosystem.rst => openvino-ecosystem/openvino-project.rst} (85%) rename docs/articles_en/{documentation/openvino-ecosystem => openvino-ecosystem/openvino-project}/datumaro.rst (100%) rename docs/articles_en/{documentation/openvino-ecosystem => openvino-ecosystem/openvino-project}/openvino-security-add-on.rst (100%) rename docs/articles_en/{documentation/openvino-ecosystem => openvino-ecosystem/openvino-project}/openvino-training-extensions.rst (100%) diff --git a/docs/articles_en/about-openvino.rst b/docs/articles_en/about-openvino.rst index 48422d9b3a7ae9..4a0bd0173cd173 100644 --- a/docs/articles_en/about-openvino.rst +++ b/docs/articles_en/about-openvino.rst @@ -29,26 +29,22 @@ deep learning models. Yet its feature set is much wider, offering various optimi To learn about the main properties of OpenVINO, see the :doc:`Key Features `. + Architecture ############################################################## -To learn more about how OpenVINO works, read the Developer documentation on its `architecture `__ and `core components `__. - -OpenVINO Ecosystem -############################################################## +To learn more about how OpenVINO works, read the Developer documentation on its +`architecture `__ +and +`core components `__. -Along with the primary components of model optimization and runtime, the toolkit also includes: -* `Neural Network Compression Framework (NNCF) `__ - a tool for enhanced OpenVINO™ inference to get performance boost with minimal accuracy drop. -* :doc:`Openvino Notebooks `- Jupyter Python notebook, which demonstrate key features of the toolkit. -* `OpenVINO Model Server `__ - a server that enables scalability via a serving microservice. -* :doc:`OpenVINO Training Extensions ` – a convenient environment to train Deep Learning models and convert them using the OpenVINO™ toolkit for optimized inference. -* :doc:`Dataset Management Framework (Datumaro) ` - a tool to build, transform, and analyze datasets. Community ############################################################## -OpenVINO community plays a vital role in the growth and development of the open-sourced toolkit. Users can contribute to OpenVINO and get support using the following channels: +OpenVINO community plays a vital role in the growth and development of the open-sourced toolkit. +Users can contribute to OpenVINO and get support using the following channels: * `OpenVINO GitHub issues, discussions and pull requests `__ * `OpenVINO Blog `__ @@ -56,9 +52,13 @@ OpenVINO community plays a vital role in the growth and development of the open- * `OpenVINO video `__ * `Support Information `__ + Case Studies ############################################################## -OpenVINO has been employed in various case studies across a wide range of industries and applications, including healthcare, retail, safety and security, transportation, and more. Read about how OpenVINO enhances efficiency, accuracy, and safety in different sectors on the `success stories page `__. +OpenVINO has been employed in various case studies across a wide range of industries and +applications, including healthcare, retail, safety and security, transportation, and more. +Read about how OpenVINO enhances efficiency, accuracy, and safety in different sectors on the +`success stories page `__. diff --git a/docs/articles_en/about-openvino/compatibility-and-support/supported-devices.rst b/docs/articles_en/about-openvino/compatibility-and-support/supported-devices.rst index b9f15bbe12cccc..d58e7c35669d37 100644 --- a/docs/articles_en/about-openvino/compatibility-and-support/supported-devices.rst +++ b/docs/articles_en/about-openvino/compatibility-and-support/supported-devices.rst @@ -46,7 +46,6 @@ Feature Support and API Coverage :doc:`Multi-stream execution <../../openvino-workflow/running-inference/optimize-inference/optimizing-throughput>` Yes Yes No :doc:`Model caching <../../openvino-workflow/running-inference/optimize-inference/optimizing-latency/model-caching-overview>` Yes Partial Yes :doc:`Dynamic shapes <../../openvino-workflow/running-inference/dynamic-shapes>` Yes Partial No - :doc:`Import/Export <../../documentation/openvino-ecosystem>` Yes Yes Yes :doc:`Preprocessing acceleration <../../openvino-workflow/running-inference/optimize-inference/optimize-preprocessing>` Yes Yes No :doc:`Stateful models <../../openvino-workflow/running-inference/stateful-models>` Yes Yes Yes :doc:`Extensibility <../../documentation/openvino-extensibility>` Yes Yes No diff --git a/docs/articles_en/assets/images/deploy_encrypted_model.svg b/docs/articles_en/assets/images/deploy_encrypted_model.svg index 61d0dbe710994e..3287667eeb8feb 100644 --- a/docs/articles_en/assets/images/deploy_encrypted_model.svg +++ b/docs/articles_en/assets/images/deploy_encrypted_model.svg @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:6f802b1396fafdc8a80c03c4931d4b6290cc10451961ddba5edcef1c8227833b -size 44097 +oid sha256:02e27919487f371839ec4773fa1cdc1063f59b1a5cdd9875faf9ac75f57181d5 +size 85978 diff --git a/docs/articles_en/documentation.rst b/docs/articles_en/documentation.rst index 5be7bb9dbc30fb..4fa660bbb53948 100644 --- a/docs/articles_en/documentation.rst +++ b/docs/articles_en/documentation.rst @@ -14,22 +14,29 @@ Documentation API Reference OpenVINO IR format and Operation Sets Legacy Features - Tool Ecosystem OpenVINO Extensibility OpenVINO™ Security -This section provides reference documents that guide you through the OpenVINO toolkit workflow, from preparing models, optimizing them, to deploying them in your own deep learning applications. +This section provides reference documents for the OpenVINO toolkit, such as API and Operation +listing. | :doc:`API Reference doc path ` -| A collection of reference articles for OpenVINO C++, C, and Python APIs. +| A collection of reference articles for OpenVINO C++, C, Node.js, and Python APIs, as well as + the Python API for OpenVINO GenAI. -| :doc:`OpenVINO Ecosystem ` -| Apart from the core components, OpenVINO offers tools, plugins, and expansions revolving around it, even if not constituting necessary parts of its workflow. This section gives you an overview of what makes up the OpenVINO toolkit. +| :doc:`OpenVINO IR format ` +| A section describing the OpenVINO IR model format and its opsets. + +| :doc:`Legacy Features ` +| The information on all OpenVINO components that have recently been deprecated or discontinued. | :doc:`OpenVINO Extensibility Mechanism ` -| The Intel® Distribution of OpenVINO™ toolkit supports neural network models trained with various frameworks, including TensorFlow, PyTorch, ONNX, TensorFlow Lite, and PaddlePaddle. Learn how to extend OpenVINO functionality with custom settings. +| The Intel® Distribution of OpenVINO™ toolkit supports neural network models trained with + various frameworks, including TensorFlow, PyTorch, ONNX, TensorFlow Lite, and PaddlePaddle. + Learn how to extend OpenVINO functionality with custom settings. | :doc:`OpenVINO™ Security ` -| Learn how to use OpenVINO securely and protect your data to meet specific security and privacy requirements. +| Learn how to use OpenVINO securely and protect your data to meet specific security and privacy + requirements. diff --git a/docs/articles_en/documentation/openvino-security.rst b/docs/articles_en/documentation/openvino-security.rst index 99cf13161bf243..bf3bd27538b6f1 100644 --- a/docs/articles_en/documentation/openvino-security.rst +++ b/docs/articles_en/documentation/openvino-security.rst @@ -8,8 +8,8 @@ with encryption or other security tools. Actual security and privacy requirements depend on your unique deployment scenario. This section provides general guidance on using OpenVINO tools and libraries securely. The main security measure for OpenVINO is its -:doc:`Security Add-on `. You can find its description -in the Ecosystem section. +:doc:`Security Add-on <../openvino-ecosystem/openvino-project/openvino-security-add-on>`. +You can find its description in the Ecosystem section. .. _encrypted-models: diff --git a/docs/articles_en/openvino-ecosystem.rst b/docs/articles_en/openvino-ecosystem.rst new file mode 100644 index 00000000000000..884fc0a06654f4 --- /dev/null +++ b/docs/articles_en/openvino-ecosystem.rst @@ -0,0 +1,20 @@ +OpenVINO Ecosystem +================== + +.. meta:: + :description: Explore the OpenVINO™ ecosystem of tools and resources for developing deep + learning solutions. + + +.. toctree:: + :maxdepth: 1 + :hidden: + + OpenVINO Integrations + The OpenVINO Project + + +OpenVINO™ is a big project, offering more than just the core runtime. This section will give +you an overview of a whole ecosystem of tools and solutions under the OpenVINO umbrella. + +The diff --git a/docs/articles_en/openvino-ecosystem/openvino-integrations.rst b/docs/articles_en/openvino-ecosystem/openvino-integrations.rst new file mode 100644 index 00000000000000..514d3c0f2bb1b7 --- /dev/null +++ b/docs/articles_en/openvino-ecosystem/openvino-integrations.rst @@ -0,0 +1,11 @@ +OpenVINO™ Integrations +============================== + + +.. meta:: + :description: Check a list of integrations between OpenVINO and other Deep Learning solutions. + + + + +Tu wrzucamy listę integracji \ No newline at end of file diff --git a/docs/articles_en/documentation/openvino-ecosystem.rst b/docs/articles_en/openvino-ecosystem/openvino-project.rst similarity index 85% rename from docs/articles_en/documentation/openvino-ecosystem.rst rename to docs/articles_en/openvino-ecosystem/openvino-project.rst index 6735192e95f674..222f516768036b 100644 --- a/docs/articles_en/documentation/openvino-ecosystem.rst +++ b/docs/articles_en/openvino-ecosystem/openvino-project.rst @@ -1,24 +1,25 @@ -OpenVINO™ Ecosystem Overview +OpenVINO™ Project Overview ============================== .. meta:: - :description: OpenVINO™ ecosystem offers various resources for developing deep learning - solutions. + :description: Check an overview of the most interesting components included in the + OpenVINO™ project. .. toctree:: :maxdepth: 1 :hidden: - openvino-ecosystem/openvino-training-extensions - openvino-ecosystem/datumaro - openvino-ecosystem/openvino-security-add-on + openvino-project/openvino-training-extensions + openvino-project/datumaro + openvino-project/openvino-security-add-on - -OpenVINO™ is a big project, offering more than just the core runtime. This page will give -you an overview of a whole ecosystem of tools and solutions under the OpenVINO umbrella. +The OpenVINO™ project is not just one tool. This page will give you an overview of the most +interesting components and sub-projects, providing a comprehensive workflow for deep learning +solution development. Learn more about each of them to reach the full potential of the +OpenVINO™ toolkit. | **GenAI** @@ -67,7 +68,7 @@ without the need to convert. | **OpenVINO Training Extensions** | :bdg-link-dark:`Github ` - :bdg-link-success:`Overview Page ` + :bdg-link-success:`Overview Page ` A convenient environment to train Deep Learning models and convert them using the OpenVINO™ toolkit for optimized inference. @@ -76,7 +77,7 @@ toolkit for optimized inference. | **OpenVINO Security Addon** | :bdg-link-dark:`Github ` - :bdg-link-success:`User Guide ` + :bdg-link-success:`User Guide ` A solution for Model Developers and Independent Software Vendors to use secure packaging and secure model execution. @@ -85,7 +86,7 @@ secure model execution. | **Datumaro** | :bdg-link-dark:`Github ` - :bdg-link-success:`Overview Page ` + :bdg-link-success:`Overview Page ` A framework and a CLI tool for building, transforming, and analyzing datasets. |hr| @@ -134,3 +135,7 @@ A detailed listing of OpenVINO-based AI projects is available in the .. |hr| raw:: html
+ + + + diff --git a/docs/articles_en/documentation/openvino-ecosystem/datumaro.rst b/docs/articles_en/openvino-ecosystem/openvino-project/datumaro.rst similarity index 100% rename from docs/articles_en/documentation/openvino-ecosystem/datumaro.rst rename to docs/articles_en/openvino-ecosystem/openvino-project/datumaro.rst diff --git a/docs/articles_en/documentation/openvino-ecosystem/openvino-security-add-on.rst b/docs/articles_en/openvino-ecosystem/openvino-project/openvino-security-add-on.rst similarity index 100% rename from docs/articles_en/documentation/openvino-ecosystem/openvino-security-add-on.rst rename to docs/articles_en/openvino-ecosystem/openvino-project/openvino-security-add-on.rst diff --git a/docs/articles_en/documentation/openvino-ecosystem/openvino-training-extensions.rst b/docs/articles_en/openvino-ecosystem/openvino-project/openvino-training-extensions.rst similarity index 100% rename from docs/articles_en/documentation/openvino-ecosystem/openvino-training-extensions.rst rename to docs/articles_en/openvino-ecosystem/openvino-project/openvino-training-extensions.rst diff --git a/docs/sphinx_setup/index.rst b/docs/sphinx_setup/index.rst index a65b5b5892c560..fa30e0b8f8d34d 100644 --- a/docs/sphinx_setup/index.rst +++ b/docs/sphinx_setup/index.rst @@ -196,4 +196,5 @@ Key Features LEARN OPENVINO OPENVINO WORKFLOW DOCUMENTATION + OPENVINO ECOSYSTEM ABOUT OPENVINO \ No newline at end of file