From 2afe473c2ab29f783a65bebbd51aa46c14b405ae Mon Sep 17 00:00:00 2001 From: Karol Blaszczak Date: Wed, 2 Oct 2024 10:38:04 +0200 Subject: [PATCH] [DOCS] technical adjustments for the build mstr --- CONTRIBUTING.md | 2 +- .../install-openvino/install-openvino-pip.rst | 42 ++++++++++++------- docs/sphinx_setup/conf.py | 2 +- 3 files changed, 28 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f9557603de5f06..7169ebc2ba2c9b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,7 +52,7 @@ product better. Since the market of computing devices is constantly evolving, OpenVINO is always open to extending its support for new hardware. If you want to run inference on a device that is currently not supported, you can see how to develop a new plugin for it in the - [Plugin Developer Guide](https://docs.openvino.ai/canonical/openvino_docs_ie_plugin_dg_overview.html). + [Plugin Developer Guide](https://docs.openvino.ai/2024/documentation/openvino-extensibility/openvino-plugin-library.html). ### Improve documentation diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-pip.rst b/docs/articles_en/get-started/install-openvino/install-openvino-pip.rst index 522817a2cec2be..20eef52ae1ad1b 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-pip.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-pip.rst @@ -16,18 +16,6 @@ Install Intel® Distribution of OpenVINO™ Toolkit from PyPI Repository (all x86_64 / arm64 architectures) * macOS offers support only for CPU inference -| **Simplified Build and Integration** -| The package includes CMake configurations, precompiled static libraries, and headers, which - can be easily accessed through the Python API. You can use the `get_cmake_path()` method to - retrieve the paths to the CMake configurations and libraries: - -.. code-block:: python - - from openvino import get_cmake_path - cmake_path = get_cmake_path() - -For detailed instructions on how to use these configurations in your build setup, check out the -:ref:`Create a library with extensions ` section. .. tab-set:: @@ -42,10 +30,13 @@ For detailed instructions on how to use these configurations in your build setup .. tab-item:: Processor Notes :sync: processor-notes - | To see if your processor includes the integrated graphics technology and supports iGPU inference, refer to: + | To see if your processor includes the integrated graphics technology and supports iGPU + inference, refer to: | `Product Specifications `__ + + Installing OpenVINO Runtime ########################### @@ -136,21 +127,40 @@ to see if your case needs any of them. +| **Simplified Build and Integration** +| The package includes CMake configurations, precompiled static libraries, and headers, which + can be easily accessed through the Python API. You can use the `get_cmake_path()` method to + retrieve the paths to the CMake configurations and libraries: + +.. code-block:: python + + from openvino import get_cmake_path + cmake_path = get_cmake_path() + +For detailed instructions on how to use these configurations in your build setup, check out the +:ref:`Create a library with extensions ` section. + What's Next? #################### -Now that you've installed OpenVINO Runtime, you're ready to run your own machine learning applications! Learn more about how to integrate a model in OpenVINO applications by trying out the following tutorials. +Now that you've installed OpenVINO Runtime, you're ready to run your own machine learning +applications! Learn more about how to integrate a model in OpenVINO applications by trying out +the following tutorials. .. image:: https://user-images.githubusercontent.com/15709723/127752390-f6aa371f-31b5-4846-84b9-18dd4f662406.gif :width: 400 -Try the `Python Quick Start Example `__ to estimate depth in a scene using an OpenVINO monodepth model in a Jupyter Notebook inside your web browser. +Try the `Python Quick Start Example `__ +to estimate depth in a scene using an OpenVINO monodepth model in a Jupyter Notebook inside +your web browser. + Get started with Python +++++++++++++++++++++++ -Visit the :doc:`Tutorials <../../../learn-openvino/interactive-tutorials-python>` page for more Jupyter Notebooks to get you started with OpenVINO, such as: +Visit the :doc:`Tutorials <../../../learn-openvino/interactive-tutorials-python>` page for more +Jupyter Notebooks to get you started with OpenVINO, such as: * `OpenVINO Python API Tutorial `__ * `Basic image classification program with Hello Image Classification `__ diff --git a/docs/sphinx_setup/conf.py b/docs/sphinx_setup/conf.py index 218787355a2e36..5bf58f00374d2f 100644 --- a/docs/sphinx_setup/conf.py +++ b/docs/sphinx_setup/conf.py @@ -55,7 +55,7 @@ '.md': 'markdown', } -html_baseurl = 'https://docs.openvino.ai/canonical/' +# html_baseurl = 'https://docs.openvino.ai/2024/' # -- Sitemap configuration ---------------------------------------------------