From 1c562982df4cbe099dd957ae8b20419d81d3d7f3 Mon Sep 17 00:00:00 2001 From: Karol Blaszczak Date: Fri, 3 Feb 2023 12:19:31 +0100 Subject: [PATCH] Docs formatting for models article port (#15486) * [DOCS] add to additional resources and change button formatting --- .../installing-model-dev-tools.md | 1 + docs/install_guides/installing-openvino-apt.md | 4 ++++ docs/install_guides/installing-openvino-brew.md | 3 +++ .../install_guides/installing-openvino-conda.md | 4 +++- .../installing-openvino-docker-linux.md | 1 + .../installing-openvino-docker-windows.md | 1 + .../installing-openvino-from-archive-linux.md | 4 ++++ .../installing-openvino-from-archive-macos.md | 4 ++++ .../installing-openvino-from-archive-windows.md | 4 ++++ .../installing-openvino-linux-header.md | 1 + .../install_guides/installing-openvino-linux.md | 4 +++- .../installing-openvino-macos-header.md | 2 ++ .../install_guides/installing-openvino-macos.md | 4 +++- .../installing-openvino-overview.md | 9 +++++---- docs/install_guides/installing-openvino-pip.md | 1 + .../installing-openvino-raspbian.md | 6 ++++-- .../installing-openvino-windows-header.md | 2 ++ .../installing-openvino-windows.md | 4 +++- .../install_guides/installing-openvino-yocto.md | 1 + docs/install_guides/installing-openvino-yum.md | 6 +++++- docs/install_guides/pypi-openvino-dev.md | 1 + docs/install_guides/pypi-openvino-rt.md | 1 + docs/resources/supported_models.md | 17 ++++++++++++----- 23 files changed, 69 insertions(+), 16 deletions(-) diff --git a/docs/install_guides/installing-model-dev-tools.md b/docs/install_guides/installing-model-dev-tools.md index 7b4e5af181a..3a7842bc47d 100644 --- a/docs/install_guides/installing-model-dev-tools.md +++ b/docs/install_guides/installing-model-dev-tools.md @@ -206,3 +206,4 @@ Visit the [Samples](../OV_Runtime_UG/Samples_Overview.md) page for other C++ exa - Intel® Distribution of OpenVINO™ toolkit home page: - For IoT Libraries & Code Samples, see [Intel® IoT Developer Kit](https://github.com/intel-iot-devkit). +- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) diff --git a/docs/install_guides/installing-openvino-apt.md b/docs/install_guides/installing-openvino-apt.md index 7cdd5f4aa05..247dc309870 100644 --- a/docs/install_guides/installing-openvino-apt.md +++ b/docs/install_guides/installing-openvino-apt.md @@ -247,3 +247,7 @@ You can also try the following things: * Take a glance at the OpenVINO product home page: https://software.intel.com/en-us/openvino-toolkit. @endsphinxdirective + +## Additional Resources + +- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) \ No newline at end of file diff --git a/docs/install_guides/installing-openvino-brew.md b/docs/install_guides/installing-openvino-brew.md index 4232f0eb075..8b4ef71da3a 100644 --- a/docs/install_guides/installing-openvino-brew.md +++ b/docs/install_guides/installing-openvino-brew.md @@ -101,3 +101,6 @@ Now that you've installed OpenVINO Runtime, you can try the following things: @endsphinxdirective +## Additional Resources + +- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) diff --git a/docs/install_guides/installing-openvino-conda.md b/docs/install_guides/installing-openvino-conda.md index d3b5a188043..a80c482cdec 100644 --- a/docs/install_guides/installing-openvino-conda.md +++ b/docs/install_guides/installing-openvino-conda.md @@ -5,4 +5,6 @@ * [Install OpenVINO with Docker](installing-openvino-docker-linux.md) * [Build From Source](https://github.com/openvinotoolkit/openvino/wiki/BuildingCode) -The other installation methods are temporarily unavailable. \ No newline at end of file +The other installation methods are temporarily unavailable. + +For a full selection of distribution channels, see the [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) \ No newline at end of file diff --git a/docs/install_guides/installing-openvino-docker-linux.md b/docs/install_guides/installing-openvino-docker-linux.md index 68861358837..2b09588ca6e 100644 --- a/docs/install_guides/installing-openvino-docker-linux.md +++ b/docs/install_guides/installing-openvino-docker-linux.md @@ -251,3 +251,4 @@ docker run -itu root:root --rm --device=/dev/ion:/dev/ion -v /var/tmp:/var/tmp - - [DockerHub CI Framework](https://github.com/openvinotoolkit/docker_ci) for Intel® Distribution of OpenVINO™ toolkit. The Framework can generate a Dockerfile, build, test, and deploy an image with the Intel® Distribution of OpenVINO™ toolkit. You can reuse available Dockerfiles, add your layer and customize the image of OpenVINO™ for your needs. - Intel® Distribution of OpenVINO™ toolkit home page: [https://software.intel.com/en-us/openvino-toolkit](https://software.intel.com/en-us/openvino-toolkit) - Intel® Neural Compute Stick 2 Get Started: [https://software.intel.com/en-us/neural-compute-stick/get-started](https://software.intel.com/en-us/neural-compute-stick/get-started) +- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) \ No newline at end of file diff --git a/docs/install_guides/installing-openvino-docker-windows.md b/docs/install_guides/installing-openvino-docker-windows.md index 7e558265572..b42034cb7bc 100644 --- a/docs/install_guides/installing-openvino-docker-windows.md +++ b/docs/install_guides/installing-openvino-docker-windows.md @@ -172,3 +172,4 @@ cmd /S /C "omz_downloader --name googlenet-v1 --precisions FP16 && omz_converter - [DockerHub CI Framework](https://github.com/openvinotoolkit/docker_ci) for Intel® Distribution of OpenVINO™ toolkit. The Framework can generate a Dockerfile, build, test, and deploy an image with the Intel® Distribution of OpenVINO™ toolkit. You can reuse available Dockerfiles, add your layer and customize the image of OpenVINO™ for your needs. - Intel® Distribution of OpenVINO™ toolkit home page: [https://software.intel.com/en-us/openvino-toolkit](https://software.intel.com/en-us/openvino-toolkit) +- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) \ No newline at end of file diff --git a/docs/install_guides/installing-openvino-from-archive-linux.md b/docs/install_guides/installing-openvino-from-archive-linux.md index 2b35aea9cbc..ca7da980526 100644 --- a/docs/install_guides/installing-openvino-from-archive-linux.md +++ b/docs/install_guides/installing-openvino-from-archive-linux.md @@ -204,3 +204,7 @@ To uninstall the toolkit, follow the steps on the [Uninstalling page](uninstalli .. _Intel® IoT Developer Kit: https://github.com/intel-iot-devkit @endsphinxdirective + +## Additional Resources + +- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) \ No newline at end of file diff --git a/docs/install_guides/installing-openvino-from-archive-macos.md b/docs/install_guides/installing-openvino-from-archive-macos.md index d2ae9224d75..6281880e18d 100644 --- a/docs/install_guides/installing-openvino-from-archive-macos.md +++ b/docs/install_guides/installing-openvino-from-archive-macos.md @@ -166,3 +166,7 @@ To uninstall the toolkit, follow the steps on the [Uninstalling page](uninstalli .. _Intel® IoT Developer Kit: https://github.com/intel-iot-devkit @endsphinxdirective + +## Additional Resources + +- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) \ No newline at end of file diff --git a/docs/install_guides/installing-openvino-from-archive-windows.md b/docs/install_guides/installing-openvino-from-archive-windows.md index b4e70d0d6a0..f2a2d90866b 100644 --- a/docs/install_guides/installing-openvino-from-archive-windows.md +++ b/docs/install_guides/installing-openvino-from-archive-windows.md @@ -182,3 +182,7 @@ To uninstall OpenVINO, follow the steps on the [Uninstalling page](uninstalling- .. _Intel® IoT Developer Kit: https://github.com/intel-iot-devkit @endsphinxdirective + +## Additional Resources + +- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) \ No newline at end of file diff --git a/docs/install_guides/installing-openvino-linux-header.md b/docs/install_guides/installing-openvino-linux-header.md index 1cbcdbd6b7b..8f6a77f2d05 100644 --- a/docs/install_guides/installing-openvino-linux-header.md +++ b/docs/install_guides/installing-openvino-linux-header.md @@ -24,3 +24,4 @@ If you want to install OpenVINO™ Runtime on your Linux machine, there are a fe * [Install OpenVINO Runtime via HomeBrew](installing-openvino-brew.md) * [Install OpenVINO with Docker](installing-openvino-docker-linux.md) +For a full selection of distribution channels, see the [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) diff --git a/docs/install_guides/installing-openvino-linux.md b/docs/install_guides/installing-openvino-linux.md index 0acb3b1b76b..b88dc7f6730 100644 --- a/docs/install_guides/installing-openvino-linux.md +++ b/docs/install_guides/installing-openvino-linux.md @@ -10,4 +10,6 @@ Currently only the following ways are provided to install OpenVINO™: * [Install OpenVINO with Docker](installing-openvino-docker-linux.md) * [Build From Source](https://github.com/openvinotoolkit/openvino/wiki/BuildingCode) -The other installation methods are temporarily unavailable. \ No newline at end of file +The other installation methods are temporarily unavailable. + +For a full selection of distribution channels, see the [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) diff --git a/docs/install_guides/installing-openvino-macos-header.md b/docs/install_guides/installing-openvino-macos-header.md index 0bf25477af3..7054d0c6e0d 100644 --- a/docs/install_guides/installing-openvino-macos-header.md +++ b/docs/install_guides/installing-openvino-macos-header.md @@ -17,3 +17,5 @@ If you want to install OpenVINO™ Runtime on macOS, there are a few ways to acc * [Install OpenVINO Runtime from an Archive File](installing-openvino-from-archive-macos.md) * [Install OpenVINO Runtime via HomeBrew](installing-openvino-brew.md) * [Install OpenVINO from PyPI](installing-openvino-pip.md) + +For a full selection of distribution channels, see the [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) diff --git a/docs/install_guides/installing-openvino-macos.md b/docs/install_guides/installing-openvino-macos.md index 317c9a4d286..06fc2969dff 100644 --- a/docs/install_guides/installing-openvino-macos.md +++ b/docs/install_guides/installing-openvino-macos.md @@ -7,4 +7,6 @@ Currently only the following ways are provided to install OpenVINO™: * [Install OpenVINO from PyPI](installing-openvino-pip.md) * [Build From Source](https://github.com/openvinotoolkit/openvino/wiki/BuildingCode) -The other installation methods are temporarily unavailable. \ No newline at end of file +The other installation methods are temporarily unavailable. + +For a full selection of distribution channels, see the [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) diff --git a/docs/install_guides/installing-openvino-overview.md b/docs/install_guides/installing-openvino-overview.md index c116bc9c81d..2711e9a49fd 100644 --- a/docs/install_guides/installing-openvino-overview.md +++ b/docs/install_guides/installing-openvino-overview.md @@ -25,10 +25,11 @@ Intel® Distribution of OpenVINO™ toolkit is a comprehensive toolkit for devel @sphinxdirective -.. link-button:: https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html - :type: url - :text: Check out the OpenVINO Download Page - :classes: btn-primary btn-block +.. button-link:: https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html + :color: primary + :outline: + + Check out the OpenVINO Download Page :fas:`fa-external-link-alt` @endsphinxdirective diff --git a/docs/install_guides/installing-openvino-pip.md b/docs/install_guides/installing-openvino-pip.md index 84fa47cd7cc..114c4d93498 100644 --- a/docs/install_guides/installing-openvino-pip.md +++ b/docs/install_guides/installing-openvino-pip.md @@ -104,3 +104,4 @@ OpenVINO Runtime has a plugin architecture that enables you to run inference on - Intel® Distribution of OpenVINO™ toolkit home page: - For IoT Libraries & Code Samples, see [Intel® IoT Developer Kit](https://github.com/intel-iot-devkit). +- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) \ No newline at end of file diff --git a/docs/install_guides/installing-openvino-raspbian.md b/docs/install_guides/installing-openvino-raspbian.md index 3a4ec86756c..e8c8dba1901 100644 --- a/docs/install_guides/installing-openvino-raspbian.md +++ b/docs/install_guides/installing-openvino-raspbian.md @@ -172,7 +172,9 @@ To uninstall the toolkit, follow the steps on the [Uninstalling page](uninstalli * Writing your own OpenVINO™ applications: :ref:`OpenVINO™ Runtime User Guide ` * Sample applications: :ref:`OpenVINO™ Toolkit Samples Overview ` * Pre-trained deep learning models: :ref:`Overview of OpenVINO™ Toolkit Pre-Trained Models ` -* IoT libraries and code samples in the GitHUB repository: `Intel® IoT Developer Kit`_ +* IoT libraries and code samples in the GitHUB repository: `Intel® IoT Developer Kit`_ +* :ref:`OpenVINO Installation Selector Tool ` + .. _Intel® IoT Developer Kit: https://github.com/intel-iot-devkit -@endsphinxdirective +@endsphinxdirective \ No newline at end of file diff --git a/docs/install_guides/installing-openvino-windows-header.md b/docs/install_guides/installing-openvino-windows-header.md index 6c3ebc28820..2b0489fd384 100644 --- a/docs/install_guides/installing-openvino-windows-header.md +++ b/docs/install_guides/installing-openvino-windows-header.md @@ -17,3 +17,5 @@ If you want to install OpenVINO™ Runtime on Windows, you have the following op * [Install OpenVINO Runtime from an Archive File](installing-openvino-from-archive-windows.md) * [Install OpenVINO from PyPI](installing-openvino-pip.md) * [Install OpenVINO with Docker](installing-openvino-docker-windows.md) + +For a full selection of distribution channels, see the [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) diff --git a/docs/install_guides/installing-openvino-windows.md b/docs/install_guides/installing-openvino-windows.md index 757755cf4a5..b9f787ce8ea 100644 --- a/docs/install_guides/installing-openvino-windows.md +++ b/docs/install_guides/installing-openvino-windows.md @@ -7,4 +7,6 @@ Currently only the following ways are provided to install OpenVINO™: * [Install OpenVINO with Docker](installing-openvino-docker-windows.md) * [Build From Source](https://github.com/openvinotoolkit/openvino/wiki/BuildingCode) -The other installation methods are temporarily unavailable. \ No newline at end of file +The other installation methods are temporarily unavailable. + +For a full selection of distribution channels, see the [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) diff --git a/docs/install_guides/installing-openvino-yocto.md b/docs/install_guides/installing-openvino-yocto.md index 39a1736c28b..04402e6e676 100644 --- a/docs/install_guides/installing-openvino-yocto.md +++ b/docs/install_guides/installing-openvino-yocto.md @@ -104,3 +104,4 @@ openvino-model-optimizer-dev - [Meta-intel](https://git.yoctoproject.org/meta-intel/tree/README) - [Meta-openembedded](http://cgit.openembedded.org/meta-openembedded/tree/README) - [Meta-clang](https://github.com/kraj/meta-clang/tree/master/#readme) +- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) \ No newline at end of file diff --git a/docs/install_guides/installing-openvino-yum.md b/docs/install_guides/installing-openvino-yum.md index c46bef6366f..a9fd96f345e 100644 --- a/docs/install_guides/installing-openvino-yum.md +++ b/docs/install_guides/installing-openvino-yum.md @@ -216,4 +216,8 @@ You can also try the following things: * See sample applications in :doc:`OpenVINO toolkit Samples Overview `. * Take a glance at the OpenVINO product home page: https://software.intel.com/en-us/openvino-toolkit. -@endsphinxdirective \ No newline at end of file +@endsphinxdirective + +## Additional Resources + +- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) diff --git a/docs/install_guides/pypi-openvino-dev.md b/docs/install_guides/pypi-openvino-dev.md index efb03727e56..2d720950457 100644 --- a/docs/install_guides/pypi-openvino-dev.md +++ b/docs/install_guides/pypi-openvino-dev.md @@ -174,6 +174,7 @@ sudo apt-get install libpython3.7 - [Intel® Distribution of OpenVINO™ toolkit](https://software.intel.com/en-us/openvino-toolkit) - [OpenVINO™ Documentation](https://docs.openvino.ai/2022.3/home.html) - [OpenVINO™ Notebooks](https://github.com/openvinotoolkit/openvino_notebooks) +- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) Copyright © 2018-2023 Intel Corporation > **LEGAL NOTICE**: Your use of this software and any required dependent software (the diff --git a/docs/install_guides/pypi-openvino-rt.md b/docs/install_guides/pypi-openvino-rt.md index 78db1dcd415..c5ba2c01781 100644 --- a/docs/install_guides/pypi-openvino-rt.md +++ b/docs/install_guides/pypi-openvino-rt.md @@ -98,6 +98,7 @@ sudo apt-get install libpython3.7 - [Intel® Distribution of OpenVINO™ toolkit](https://software.intel.com/en-us/openvino-toolkit) - [OpenVINO™ Documentation](https://docs.openvino.ai/) - [OpenVINO™ Notebooks](https://github.com/openvinotoolkit/openvino_notebooks) +- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) Copyright © 2018-2023 Intel Corporation > **LEGAL NOTICE**: Your use of this software and any required dependent software (the diff --git a/docs/resources/supported_models.md b/docs/resources/supported_models.md index b38fb4066d7..907f220e665 100644 --- a/docs/resources/supported_models.md +++ b/docs/resources/supported_models.md @@ -6,13 +6,20 @@ Based on our research and user feedback, we prioritize the most common models an before every release. These models are considered officially supported. @sphinxdirective -:download:`SEE THE COMPLETE LIST OF SUPPORTED MODELS [PDF]<_static/download/OV_2022_models_supported.pdf>` + +.. button-link:: _static/download/OV_2022_models_supported.pdf + :color: primary + :outline: + + :material-regular:`download;1.5em` Click for supported models [PDF] + + +| Note that the list provided here does not include all models supported by OpenVINO. +| If your model is not included but is similar to those that are, it is still very likely to work. + If your model fails to execute properly there are a few options available: + @endsphinxdirective -Note that the list provided here does not include all models supported by OpenVINO. -If your model is not included but is similar to those that are, it is very likely it will work. - -Should a model fail to execute properly there are a few options available: * If the model originates from a framework like TensorFlow or PyTorch, OpenVINO™ offers a hybrid solution. The original model can be run without explicit conversion into the OpenVINO format. For more information, see [OpenVINO TensorFlow Integration](https://docs.openvino.ai/latest/ovtf_integration.html). * You can create a GitHub request for the operation(s) that are missing. These requests are reviewed regularly. You will be informed if and how the request will be accommodated. Additionally, your request may trigger a reply from someone in the community who can help. * As OpenVINO™ is open source you can enhance it with your own contribution to the GitHub repository. To learn more, see the articles on [OpenVINO Extensibility](https://docs.openvino.ai/latest/openvino_docs_Extensibility_UG_Intro.html).