From fe57a70d85e6cddceb5646f8828cede2a0ca8a0c 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 | 23 ++- .../documentation/openvino-security.rst | 4 +- docs/articles_en/openvino-ecosystem.rst | 31 +++ .../openvino-ecosystem/openvino-adoptions.rst | 63 ++++++ .../openvino-integrations.rst | 182 ++++++++++++++++++ .../openvino-project.rst} | 65 +++---- .../openvino-project}/datumaro.rst | 0 .../openvino-security-add-on.rst | 0 .../openvino-training-extensions.rst | 0 docs/sphinx_setup/index.rst | 1 + 13 files changed, 331 insertions(+), 67 deletions(-) create mode 100644 docs/articles_en/openvino-ecosystem.rst create mode 100644 docs/articles_en/openvino-ecosystem/openvino-adoptions.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} (55%) 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..e157a83d26f6c7 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 + 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..c5972611a43553 --- /dev/null +++ b/docs/articles_en/openvino-ecosystem.rst @@ -0,0 +1,31 @@ +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 Adoptions + + +OpenVINO™, as a toolkit should, involves multiple components and integrations that may be used +in various areas of your Deep Learning pipelines. This section will give you an overview of a +whole ecosystem of resources either developed under the OpenVINO umbrella, integrating it with +external solutions, or utilizing its potential. + +| :doc:`OpenVINO Integrations <./openvino-ecosystem/openvino-integrations>` +| See what other tools OpenVINO is easily integrated with and how you can benefit from its + performance, without rewriting your software. + +| :doc:`The OpenVINO project <./openvino-ecosystem/openvino-project>` +| Check out the most noteworthy components of the OpenVINO project. + +| :doc:`OpenVINO adoptions <./openvino-ecosystem/openvino-adoptions>` +| Here, you will find information about a selection of software projects utilizing OpenVINO. + diff --git a/docs/articles_en/openvino-ecosystem/openvino-adoptions.rst b/docs/articles_en/openvino-ecosystem/openvino-adoptions.rst new file mode 100644 index 00000000000000..a3fe96b1b1fc6b --- /dev/null +++ b/docs/articles_en/openvino-ecosystem/openvino-adoptions.rst @@ -0,0 +1,63 @@ +OpenVINO Adoptions +========================== + +OpenVINO has been adopted by multiple AI projects in various areas. For an extensive list of +community-based projects involving OpenVINO, see the +`Awesome OpenVINO repository `__. + +Here is a small selection of adoptions, including proprietary and commercial tools: + + + + +| **DaVinCI Resolve** +| :bdg-link-info:`Official Website ` + +DaVinci resolve is a professional video editing suite by Blackmagicdesign. It uses OpenVINO to +run some of its industry-leading AI features. +|hr| + +| **OpenVINO AI Plugins for GIMP** +| :bdg-link-dark:`Official Repository ` + +Gimp is an image editor that has promoted open source values for over two decades. Now, you can +use generative AI directly in the application, thanks to the OpenVINO plugin, just like in the +leading graphics suites. +|hr| + +| **OpenVINO AI Plugins for Audacity** +| :bdg-link-info:`Official Website ` + :bdg-link-dark:`Official Repository ` + +Audacity is a hugely popular audio editing and recording application. Now, it offers AI-based +plugins running on OpenVINO, providing new effects, generators, and analyzers. +|hr| + + +| **VisionGuard** +| :bdg-link-dark:`Official Repository ` + +A desktop tool developed within Google Summer of Code. Its aim is to help computer users battle +eye strain, utilizing gaze estimation. +|hr| + +| **OpenVINO Code** +| :bdg-link-dark:`Official Repository ` + +A coding assistant. A community-developed extension for Visual Studio Code, aiming to help +programmers by providing code completion and suggestions. +|hr| + +| **NVIDIA GPU Plugin** +| :bdg-link-dark:`Official Repository ` + +A device plugin for OpenVINO. A community-developed extension, enabling inference using +NVIDIA GPUs. +|hr| + + + + +.. |hr| raw:: html + +
\ No newline at end of file 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..f465792e1d6a7b --- /dev/null +++ b/docs/articles_en/openvino-ecosystem/openvino-integrations.rst @@ -0,0 +1,182 @@ +OpenVINO™ Integrations +============================== + + +.. meta:: + :description: Check a list of integrations between OpenVINO and other Deep Learning solutions. + + + +.. = 1 ======================================================================================== + +**Hugging Face Optimum-Intel** + +|hr| + +.. grid:: 1 1 2 2 + :gutter: 4 + + .. grid-item:: + + | Grab and use models leveraging OpenVINO within the Hugging Face API. + The repository hosts pre-optimized OpenVINO IR models, so that you can use + them in your projects without the need for any adjustments. + | Benefits: + | - Minimize complex coding for Generative AI. + + .. grid-item:: + + * :doc:`Run inference with HuggingFace and Optimum Intel <../learn-openvino/llm_inference_guide/llm-inference-hf>` + * `A notebook example: llm-chatbot `__ + * `Hugging Face Inference documentation `__ + * `Hugging Face Compression documentation `__ + * `Hugging Face Reference Documentation `__ + +.. dropdown:: Check example code + :animate: fade-in-slide-down + :color: secondary + + .. code-block:: py + + -from transformers import AutoModelForCausalLM + +from optimum.intel.openvino import OVModelForCausalLM + + from transformers import AutoTokenizer, pipeline + model_id = "togethercomputer/RedPajama-INCITE-Chat-3B-v1" + + -model = AutoModelForCausalLM.from_pretrained(model_id) + +model = OVModelForCausalLM.from_pretrained(model_id, export=True) + + +.. = 2 ======================================================================================== + +**OpenVINO Execution Provider for ONNX Runtime** + +|hr| + +.. grid:: 1 1 2 2 + :gutter: 4 + + .. grid-item:: + + | Utilize OpenVINO as a backend with your existing ONNX Runtime code. + | Benefits: + | - Enhanced inference performance on Intel hardware with minimal code modifications. + + .. grid-item:: + + * A notebook example: YOLOv8 object detection + * `ONNX User documentation `__ + * `Build ONNX RT with OV EP `__ + * `ONNX Examples `__ + + +.. dropdown:: Check example code + :animate: fade-in-slide-down + :color: secondary + + .. code-block:: cpp + + device = `CPU_FP32` + # Set OpenVINO as the Execution provider to infer this model + sess.set_providers([`OpenVINOExecutionProvider`], [{device_type` : device}]) + + +.. = 3 ======================================================================================== + +**Torch.compile with OpenVINO** + +|hr| + +.. grid:: 1 1 2 2 + :gutter: 4 + + .. grid-item:: + + | Use OpenVINO for Python-native applications by JIT-compiling code into optimized kernels. + | Benefits: + | - Enhanced inference performance on Intel hardware with minimal code modifications. + + .. grid-item:: + + * :doc:`PyTorch Deployment via torch.compile <../openvino-workflow/torch-compile>` + * A notebook example: n.a. + * `torch.compiler documentation `__ + * `torch.compiler API reference `__ + +.. dropdown:: Check example code + :animate: fade-in-slide-down + :color: secondary + + .. code-block:: python + + import openvino.torch + + ... + model = torch.compile(model, backend='openvino') + ... + + + +.. = 4 ======================================================================================== + +**OpenVINO LLMs with LlamaIndex** + +|hr| + +.. grid:: 1 1 2 2 + :gutter: 4 + + .. grid-item:: + + | Build context-augmented GenAI applications with the LlamaIndex framework and enhance + runtime performance with OpenVINO. + | Benefits: + | - Minimize complex coding for Generative AI. + + .. grid-item:: + + * :doc:`LLM inference with Optimum-intel <../learn-openvino/llm_inference_guide/llm-inference-hf>` + * `A notebook example: llm-agent-rag `__ + * + * `Inference documentation `__ + * `Rerank documentation `__ + * `Embeddings documentation `__ + * `API Reference `__ + +.. dropdown:: Check example code + :animate: fade-in-slide-down + :color: secondary + + .. code-block:: python + + ov_config = { + "PERFORMANCE_HINT": "LATENCY", + "NUM_STREAMS": "1", + "CACHE_DIR": "", + } + + ov_llm = OpenVINOLLM( + model_id_or_path="HuggingFaceH4/zephyr-7b-beta", + context_window=3900, + max_new_tokens=256, + model_kwargs={"ov_config": ov_config}, + generate_kwargs={"temperature": 0.7, "top_k": 50, "top_p": 0.95}, + messages_to_prompt=messages_to_prompt, + completion_to_prompt=completion_to_prompt, + device_map="cpu", + ) + + + + + + + + + +.. ============================================================================================ + +.. |hr| raw:: html + +
\ 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 55% rename from docs/articles_en/documentation/openvino-ecosystem.rst rename to docs/articles_en/openvino-ecosystem/openvino-project.rst index 6735192e95f674..3a6d2028888947 100644 --- a/docs/articles_en/documentation/openvino-ecosystem.rst +++ b/docs/articles_en/openvino-ecosystem/openvino-project.rst @@ -1,37 +1,35 @@ -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 of 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. +This page provides an overview of the most noteworthy tools and components for AI developers, +developed in repositories under the OpenVINO project: | **GenAI** -| :bdg-link-dark:`Github ` +| :bdg-link-dark:`GitHub ` :bdg-link-success:`User Guide ` -OpenVINO™ GenAI Library aims to simplify running inference of generative AI +OpenVINO™ GenAI Library simplifies running inference of generative AI models. Check the LLM-powered Chatbot Jupyter notebook to see how GenAI works. |hr| | **Neural Network Compression Framework** -| :bdg-link-dark:`Github ` +| :bdg-link-dark:`GitHub ` :bdg-link-success:`User Guide ` A suite of advanced algorithms for Neural Network inference optimization with minimal accuracy @@ -41,7 +39,7 @@ and TensorFlow models during training. | **OpenVINO Model Server** -| :bdg-link-dark:`Github ` +| :bdg-link-dark:`GitHub ` :bdg-link-success:`User Guide ` A high-performance system that can be used to access the host models via request to the model @@ -50,24 +48,16 @@ server. | **OpenVINO Notebooks** -| :bdg-link-dark:`Github ` +| :bdg-link-dark:`GitHub ` :bdg-link-success:`Jupyter Notebook Collection ` A collection of Jupyter notebooks for learning and experimenting with the OpenVINO™ Toolkit. |hr| -| **Hugging Face OpenVINO models** -| :bdg-link-info:`Model Collection ` - -A Hugging Face repository hosting pre-optimized OpenVINO IR models, so that you can use them -without the need to convert. -|hr| - - | **OpenVINO Training Extensions** -| :bdg-link-dark:`Github ` - :bdg-link-success:`Overview Page ` +| :bdg-link-dark:`GitHub ` + :bdg-link-success:`Overview Page ` A convenient environment to train Deep Learning models and convert them using the OpenVINO™ toolkit for optimized inference. @@ -75,8 +65,8 @@ toolkit for optimized inference. | **OpenVINO Security Addon** -| :bdg-link-dark:`Github ` - :bdg-link-success:`User Guide ` +| :bdg-link-dark:`GitHub ` + :bdg-link-success:`User Guide ` A solution for Model Developers and Independent Software Vendors to use secure packaging and secure model execution. @@ -84,15 +74,15 @@ secure model execution. | **Datumaro** -| :bdg-link-dark:`Github ` - :bdg-link-success:`Overview Page ` +| :bdg-link-dark:`GitHub ` + :bdg-link-success:`Overview Page ` A framework and a CLI tool for building, transforming, and analyzing datasets. |hr| | **Intel® Geti™** -| :bdg-link-dark:`Github ` +| :bdg-link-dark:`GitHub ` :bdg-link-info:`Official Website ` Intel's new software for building computer vision @@ -103,7 +93,7 @@ development process, empowering teams to produce custom AI models at scale. | **Tokenizers** -| :bdg-link-dark:`Github ` +| :bdg-link-dark:`GitHub ` :bdg-link-success:`User Guide ` OpenVINO Tokenizers add text processing operations to OpenVINO. @@ -111,26 +101,17 @@ OpenVINO Tokenizers add text processing operations to OpenVINO. | **OpenVINO's Open Model Zoo** -| :bdg-link-dark:`Github ` +| :bdg-link-dark:`GitHub ` :bdg-link-success:`User Guide ` Open Model Zoo includes optimized deep learning models and a set of demos to expedite development of high-performance deep learning inference applications. -OpenVINO-based AI projects -########################## -OpenVINO is used in many educational, multimodal, and AI projects in the fields of AI Audio, -Natural Language Processing, AI Computer Vision, Generative AI, operating systems and API extensions. -Examples of such projects are: `OpenVINO AI Plugins for GIMP `__, -`OpenVINO Code `__, and -`NVIDIA GPU Plugin `__. +.. |hr| raw:: html -A detailed listing of OpenVINO-based AI projects is available in the -`Awesome OpenVINO repository `__ +
-.. |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