From c89da1aee2018dd28085dcbc4018e8a02d56cfc7 Mon Sep 17 00:00:00 2001 From: Sebastian Golebiewski Date: Thu, 23 Mar 2023 12:02:01 +0100 Subject: [PATCH] DOCS shift to rst - Install OpenVINO on macOS, Raspbian (#16506) --- .../installing-openvino-brew.md | 81 +++++------- .../installing-openvino-from-archive-macos.md | 123 +++++++++--------- .../installing-openvino-macos-header.md | 13 +- .../installing-openvino-macos.md | 12 +- .../installing-openvino-raspbian.md | 65 +++------ 5 files changed, 133 insertions(+), 161 deletions(-) diff --git a/docs/install_guides/installing-openvino-brew.md b/docs/install_guides/installing-openvino-brew.md index 557e38872e84c2..1bbf98042015a2 100644 --- a/docs/install_guides/installing-openvino-brew.md +++ b/docs/install_guides/installing-openvino-brew.md @@ -2,58 +2,52 @@ @sphinxdirective -With the OpenVINO™ 2022.3 release, you can install OpenVINO Runtime on macOS and Linux via `Homebrew `_. OpenVINO™ Development Tools can be installed via PyPI only. See :ref:`Installing Additional Components ` for more information. +With the OpenVINO™ 2022.3 release, you can install OpenVINO Runtime on macOS and Linux via `Homebrew `_. OpenVINO™ Development Tools can be installed via PyPI only. See `Installing Additional Components <#optional-installing-additional-components>`__ for more information. -See the `Release Notes `_ for more information on updates in the latest release. +See the `Release Notes `__ for more information on updates in the latest release. Installing OpenVINO Runtime from Homebrew is recommended for C++ developers. If you are working with Python, the PyPI package has everything needed for Python development and deployment on CPU and GPUs. Visit the :doc:`Install OpenVINO from PyPI ` page for instructions on how to install OpenVINO Runtime for Python using PyPI. -.. note:: +.. note:: Only CPU is supported for inference if you install OpenVINO via HomeBrew. -.. warning:: +.. warning:: - By downloading and using this container and the included software, you agree to the terms and conditions of the `software license agreements `_. + By downloading and using this container and the included software, you agree to the terms and conditions of the `software license agreements `__. -@endsphinxdirective - -## Prerequisites - -### System Requirements -@sphinxdirective - -Full requirement listing is available on the `System Requirements Page `_ +Prerequisites +#################### -@endsphinxdirective +System Requirements +++++++++++++++++++++ -### Software Requirements +Full requirement listing is available on the `System Requirements Page `__ -@sphinxdirective +Software Requirements ++++++++++++++++++++++ .. tab:: macOS * `Homebrew `_ - * `CMake 3.13 or higher `_ (choose "macOS 10.13 or later"). Add `/Applications/CMake.app/Contents/bin` to path (for default installation). - * `Python 3.7 - 3.10 `_ (choose 3.7 - 3.10). Install and add it to path. - * Apple Xcode Command Line Tools. In the terminal, run `xcode-select --install` from any directory to install it. + * `CMake 3.13 or higher `__ (choose "macOS 10.13 or later"). Add ``/Applications/CMake.app/Contents/bin`` to path (for default installation). + * `Python 3.7 - 3.10 `__ (choose 3.7 - 3.10). Install and add it to path. + * Apple Xcode Command Line Tools. In the terminal, run ``xcode-select --install`` from any directory to install it. * (Optional) Apple Xcode IDE (not required for OpenVINO™, but useful for development) .. tab:: Linux * `Homebrew `_ - * `CMake 3.13 or higher, 64-bit `_ + * `CMake 3.13 or higher, 64-bit `__ * GCC 7.5.0 (for Ubuntu 18.04) or GCC 9.3.0 (for Ubuntu 20.04) - * `Python 3.7 - 3.10, 64-bit `_ - -@endsphinxdirective + * `Python 3.7 - 3.10, 64-bit `__ -## Installing OpenVINO Runtime -@sphinxdirective +Installing OpenVINO Runtime +########################### -1. Make sure that you have installed HomeBrew on your system. If not, follow the instructions on `the Homebrew website `_ to install and configure it. +1. Make sure that you have installed HomeBrew on your system. If not, follow the instructions on `the Homebrew website `__ to install and configure it. 2. Open a command prompt terminal window, and run the following command to install OpenVINO Runtime: @@ -61,15 +55,11 @@ Full requirement listing is available on the `System Requirements Page `_. -@endsphinxdirective - -## Uninstalling OpenVINO +Uninstalling OpenVINO +##################### To uninstall OpenVINO via HomeBrew, use the following command: -```sh -brew uninstall openvino -``` -## What's Next? +.. code-block:: sh -@sphinxdirective + brew uninstall openvino + + +What's Next? +#################### -Now that you've installed OpenVINO Runtime, you can try the following things: +Now that you've installed OpenVINO Runtime, you can try the following things: * Learn more about :doc:`OpenVINO Workflow `. * To prepare your models for working with OpenVINO, see :doc:`Model Preparation `. @@ -99,8 +89,9 @@ Now that you've installed OpenVINO Runtime, you can 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 +Additional Resources +#################### -## Additional Resources +* `OpenVINO Installation Selector Tool `__ -- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) \ No newline at end of file +@endsphinxdirective diff --git a/docs/install_guides/installing-openvino-from-archive-macos.md b/docs/install_guides/installing-openvino-from-archive-macos.md index 23d20d6e666130..2e3793bce92e3f 100644 --- a/docs/install_guides/installing-openvino-from-archive-macos.md +++ b/docs/install_guides/installing-openvino-from-archive-macos.md @@ -1,53 +1,59 @@ # Install OpenVINO™ Runtime on macOS from an Archive File {#openvino_docs_install_guides_installing_openvino_from_archive_macos} +@sphinxdirective + With the OpenVINO™ 2022.3 release, you can download and use archive files to install OpenVINO Runtime. The archive files contain pre-built binaries and library files needed for OpenVINO Runtime, as well as code samples. -Installing OpenVINO Runtime from archive files is recommended for C++ developers. If you are working with Python, the PyPI package has everything needed for Python development and deployment on CPU and GPUs. Visit the [Install OpenVINO from PyPI](installing-openvino-pip.md) page for instructions on how to install OpenVINO Runtime for Python using PyPI. +Installing OpenVINO Runtime from archive files is recommended for C++ developers. If you are working with Python, the PyPI package has everything needed for Python development and deployment on CPU and GPUs. Visit the :doc:`Install OpenVINO from PyPI ` page for instructions on how to install OpenVINO Runtime for Python using PyPI. -See the [Release Notes](https://software.intel.com/en-us/articles/OpenVINO-RelNotes) for more information on updates in the latest release. +See the `Release Notes `__ for more information on updates in the latest release. -> **NOTE**: Since the OpenVINO™ 2022.1 release, the following development tools: Model Optimizer, Post-Training Optimization Tool, Model Downloader and other Open Model Zoo tools, Accuracy Checker, and Annotation Converter can be installed via [pypi.org](https://pypi.org/project/openvino-dev/) only. +.. note:: + + Since the OpenVINO™ 2022.1 release, the following development tools: Model Optimizer, Post-Training Optimization Tool, Model Downloader and other Open Model Zoo tools, Accuracy Checker, and Annotation Converter can be installed via `pypi.org `__ only. -@sphinxdirective .. tab:: System Requirements | Full requirement listing is available in: - | `System Requirements Page `_ + | `System Requirements Page `__ .. tab:: Software Requirements - * `CMake 3.13 or higher `_ (choose "macOS 10.13 or later"). Add `/Applications/CMake.app/Contents/bin` to path (for default install). - * `Python 3.7 - 3.10 `_ (choose 3.7 - 3.10). Install and add to path. - * Apple Xcode Command Line Tools. In the terminal, run `xcode-select --install` from any directory + * `CMake 3.13 or higher `__ (choose "macOS 10.13 or later"). Add ``/Applications/CMake.app/Contents/bin`` to path (for default install). + * `Python 3.7 - 3.10 `__ (choose 3.7 - 3.10). Install and add to path. + * Apple Xcode Command Line Tools. In the terminal, run ``xcode-select --install`` from any directory * (Optional) Apple Xcode IDE (not required for OpenVINO™, but useful for development) -@endsphinxdirective -## Installing OpenVINO Runtime +Installing OpenVINO Runtime +########################### -### Step 1: Install OpenVINO Core Components +Step 1: Install OpenVINO Core Components +++++++++++++++++++++++++++++++++++++++++ -@sphinxdirective -1. Open a command prompt terminal window. -2. Create the `/opt/intel` folder for OpenVINO by using the following command. If the folder already exists, skip this command. +1. Open a command prompt terminal window. +2. Create the ``/opt/intel`` folder for OpenVINO by using the following command. If the folder already exists, skip this command. .. code-block:: sh sudo mkdir /opt/intel - - .. note:: - - The `/opt/intel` path is the recommended folder path for installing OpenVINO. You may use a different path if desired. -3. Browse to the current user's `Downloads` folder: + + .. note:: + + The ``/opt/intel`` path is the recommended folder path for installing OpenVINO. You may use a different path if desired. + + +3. Browse to the current user's ``Downloads`` folder: .. code-block:: sh cd /Downloads - -4. Download the `OpenVINO Runtime archive file for macOS `_, extract the files, rename the extracted folder and move it to the desired path: + + +4. Download the `OpenVINO Runtime archive file for macOS `__, extract the files, rename the extracted folder and move it to the desired path: .. tab:: x86, 64-bit @@ -65,55 +71,62 @@ See the [Release Notes](https://software.intel.com/en-us/articles/OpenVINO-RelNo tar -xf openvino_2022.3.0.tgz sudo mv m_openvino_toolkit_macos_11_0_2022.3.0.9052.9752fafe8eb_arm64 /opt/intel/openvino_2022.3.0 + 5. For simplicity, it is useful to create a symbolic link as below: .. code-block:: sh sudo ln -s openvino_2022.3.0 openvino_2022 - - .. note:: - - If you have already installed a previous release of OpenVINO 2022, a symbolic link to the `openvino_2022` folder may already exist. Unlink the previous link with `sudo unlink openvino_2022`, and then re-run the command above. -@endsphinxdirective + .. note:: + + If you have already installed a previous release of OpenVINO 2022, a symbolic link to the ``openvino_2022`` folder may already exist. Unlink the previous link with ``sudo unlink openvino_2022``, and then re-run the command above. + -Congratulations, you finished the installation! The `/opt/intel/openvino_2022` folder now contains the core components for OpenVINO. If you used a different path in Step 2, you will find the `openvino_2022` folder there. The path to the `openvino_2022` directory is also referred as `` throughout the OpenVINO documentation. +Congratulations, you finished the installation! The ``/opt/intel/openvino_2022`` folder now contains the core components for OpenVINO. If you used a different path in Step 2, you will find the ``openvino_2022`` folder there. The path to the ``openvino_2022`` directory is also referred as ```` throughout the OpenVINO documentation. -### Step 2: Configure the Environment +Step 2: Configure the Environment ++++++++++++++++++++++++++++++++++ -You must update several environment variables before you can compile and run OpenVINO applications. Open a terminal window and run the `setupvars.sh` script as shown below to temporarily set your environment variables. If your is not `/opt/intel/openvino_2022`, use the correct one instead. +You must update several environment variables before you can compile and run OpenVINO applications. Open a terminal window and run the ``setupvars.sh`` script as shown below to temporarily set your environment variables. If your ```` is not ``/opt/intel/openvino_2022``, use the correct one instead. -```sh -source /opt/intel/openvino_2022/setupvars.sh -``` +.. code-block:: sh -If you have more than one OpenVINO™ version on your machine, you can easily switch its version by sourcing the `setupvars.sh` of your choice. + source /opt/intel/openvino_2022/setupvars.sh -> **NOTE**: The above command must be re-run every time you start a new terminal session. To set up macOS to automatically run the command every time a new terminal is opened, open `~/.zshrc` in your favorite editor and add `source /opt/intel/openvino_2022/setupvars.sh` after the last line. Next time when you open a terminal, you will see `[setupvars.sh] OpenVINO™ environment initialized`. Changing `~/.zshrc` is not recommended when you have multiple OpenVINO versions on your machine and want to switch among them. + +If you have more than one OpenVINO™ version on your machine, you can easily switch its version by sourcing the ``setupvars.sh`` of your choice. + +.. note:: + + The above command must be re-run every time you start a new terminal session. To set up macOS to automatically run the command every time a new terminal is opened, open ``~/.zshrc`` in your favorite editor and add ``source /opt/intel/openvino_2022/setupvars.sh`` after the last line. Next time when you open a terminal, you will see ``[setupvars.sh] OpenVINO™ environment initialized``. Changing ``~/.zshrc`` is not recommended when you have multiple OpenVINO versions on your machine and want to switch among them. The environment variables are set. Continue to the next section if you want to download any additional components. -### Step 3 (Optional): Install Additional Components +Step 3 (Optional): Install Additional Components +++++++++++++++++++++++++++++++++++++++++++++++++ OpenVINO Development Tools is a set of utilities for working with OpenVINO and OpenVINO models. It provides tools like Model Optimizer, Benchmark Tool, Post-Training Optimization Tool, and Open Model Zoo Downloader. If you install OpenVINO Runtime using archive files, OpenVINO Development Tools must be installed separately. -See the [Install OpenVINO Development Tools](installing-model-dev-tools.md) page for step-by-step installation instructions. +See the :doc:`Install OpenVINO Development Tools ` page for step-by-step installation instructions. + +OpenCV is necessary to run demos from Open Model Zoo (OMZ). Some OpenVINO samples can also extend their capabilities when compiled with OpenCV as a dependency. To install OpenCV for OpenVINO, see the `instructions on GitHub `__. -OpenCV is necessary to run demos from Open Model Zoo (OMZ). Some OpenVINO samples can also extend their capabilities when compiled with OpenCV as a dependency. To install OpenCV for OpenVINO, see the [instructions on GitHub](https://github.com/opencv/opencv/wiki/BuildOpenCV4OpenVINO). +What's Next? +#################### -## 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. -@sphinxdirective + .. tab:: Get started with Python 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. - + .. image:: https://user-images.githubusercontent.com/15709723/127752390-f6aa371f-31b5-4846-84b9-18dd4f662406.gif :width: 400 Visit the :ref:`Tutorials ` 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 `_ * `Convert a PyTorch model and use it for image background removal `_ @@ -121,44 +134,38 @@ Now that you've installed OpenVINO Runtime, you're ready to run your own machine .. tab:: Get started with C++ Try the `C++ Quick Start Example `_ for step-by-step instructions on building and running a basic image classification C++ application. - + .. image:: https://user-images.githubusercontent.com/36741649/127170593-86976dc3-e5e4-40be-b0a6-206379cd7df5.jpg :width: 400 Visit the :ref:`Samples ` page for other C++ example applications to get you started with OpenVINO, such as: - + * `Basic object detection with the Hello Reshape SSD C++ sample `_ * `Automatic speech recognition C++ sample `_ -@endsphinxdirective - -## Uninstalling Intel® Distribution of OpenVINO™ Toolkit +Uninstalling Intel® Distribution of OpenVINO™ Toolkit +##################################################### -To uninstall the toolkit, follow the steps on the [Uninstalling page](uninstalling-openvino.md). +To uninstall the toolkit, follow the steps on the :doc:`Uninstalling page `. -## Additional Resources - -@sphinxdirective +Additional Resources +#################### +* `OpenVINO Installation Selector Tool `__ * :ref:`Troubleshooting Guide for OpenVINO Installation & Configuration ` * Converting models for use with OpenVINO™: :ref:`Model Optimizer User Guide ` * 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 `__ -.. _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-macos-header.md b/docs/install_guides/installing-openvino-macos-header.md index 7054d0c6e0dbc3..69b1e93df437c3 100644 --- a/docs/install_guides/installing-openvino-macos-header.md +++ b/docs/install_guides/installing-openvino-macos-header.md @@ -10,12 +10,13 @@ From PyPI Using HomeBrew -@endsphinxdirective +If you want to install OpenVINO™ Runtime on macOS, there are a few ways to accomplish this. We prepared following options for you: -If you want to install OpenVINO™ Runtime on macOS, there are a few ways to accomplish this. We prepared following options for you: +* :doc:`Install OpenVINO Runtime from an Archive File ` +* :doc:`Install OpenVINO Runtime via HomeBrew ` +* :doc:`Install OpenVINO from PyPI ` -* [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 `__ -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) +@endsphinxdirective \ No newline at end of file diff --git a/docs/install_guides/installing-openvino-macos.md b/docs/install_guides/installing-openvino-macos.md index 9a98f9335e1ded..21c5053e082821 100644 --- a/docs/install_guides/installing-openvino-macos.md +++ b/docs/install_guides/installing-openvino-macos.md @@ -1,12 +1,16 @@ # Install OpenVINO™ Runtime for macOS from Installer +@sphinxdirective + Currently only the following ways are provided to install OpenVINO™: -* [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) -* [Build From Source](https://github.com/openvinotoolkit/openvino/blob/master/docs/dev/build.md) +* :doc:`Install OpenVINO Runtime from an Archive File ` +* :doc:`Install OpenVINO Runtime via HomeBrew ` +* :doc:`Install OpenVINO from PyPI ` +* `Build From Source `__ 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) + +@endsphinxdirective \ 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 8e87595aca6022..d47cea800092e6 100644 --- a/docs/install_guides/installing-openvino-raspbian.md +++ b/docs/install_guides/installing-openvino-raspbian.md @@ -8,12 +8,8 @@ * These steps have been validated with Raspberry Pi 3. * There is also an open-source version of OpenVINO™ that can be compiled for arch64 (see `build instructions `_). -@endsphinxdirective - - -## Development and Target Systems - -@sphinxdirective +Development and Target Systems +############################### .. tab:: System Requirements @@ -28,12 +24,8 @@ .. _install-openvino: -@endsphinxdirective - - -## Step 1: Download and Install OpenVINO Runtime - -@sphinxdirective +Step 1: Download and Install OpenVINO Runtime +############################################# #. Open the Terminal or your preferred console application. #. Create an installation folder for OpenVINO. If the folder already exists, skip this step. @@ -99,12 +91,8 @@ Congratulations, you finished the installation! The ``/opt/intel/openvino_2022`` .. _install-external-dependencies: -@endsphinxdirective - - -## Step 2: Install External Software Dependencies - -@sphinxdirective +Step 2: Install External Software Dependencies +############################################## CMake version 3.10 or higher is required for building the OpenVINO™ toolkit sample application. To install, open a Terminal window and run the following command: @@ -117,12 +105,8 @@ CMake is installed. Continue to the next section to set the environment variable .. _set-the-environment-variables-raspbian: -@endsphinxdirective - - -## Step 3: Set the Environment Variables - -@sphinxdirective +Step 3: Set the Environment Variables +##################################### You must update several environment variables before you can compile and run OpenVINO applications. Open a terminal window and run the ``setupvars.sh`` script as shown below to temporarily set your environment variables. If your is not ``/opt/intel/openvino_2022``, use the correct one instead. @@ -141,12 +125,8 @@ The environment variables are set. Continue to the next section if you want to d .. _model-optimizer: -@endsphinxdirective - - -## Step 4 (Optional): Install Additional Components - -@sphinxdirective +Step 4 (Optional): Install Additional Components +################################################ If you want to use your model for inference, the model must be converted to the ``.bin`` and ``.xml`` Intermediate Representation (IR) files that are used as input by OpenVINO Runtime. To get the optimized models, you can use one of the following options: @@ -158,16 +138,11 @@ If you want to use your model for inference, the model must be converted to the * OpenVINO Development Tools is a set of utilities for working with OpenVINO and OpenVINO models. It provides tools like Model Optimizer, Benchmark Tool, Post-Training Optimization Tool, and Open Model Zoo Downloader. See the :doc:`Install OpenVINO Development Tools ` page for step-by-step installation instructions. -@endsphinxdirective - - -## What's Next? - -@sphinxdirective +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. - .. tab:: Get started with Python 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. @@ -181,6 +156,7 @@ Now that you've installed OpenVINO Runtime, you're ready to run your own machine * `Basic image classification program with Hello Image Classification `_ * `Convert a PyTorch model and use it for image background removal `_ + .. tab:: Get started with C++ Try the `C++ Quick Start Example `_ for step-by-step instructions on building and running a basic image classification C++ application. @@ -193,24 +169,17 @@ Now that you've installed OpenVINO Runtime, you're ready to run your own machine * `Basic object detection with the Hello Reshape SSD C++ sample `_ * `Automatic speech recognition C++ sample `_ - To uninstall the toolkit, follow the steps on the :doc:`Uninstalling page `. -@endsphinxdirective - - -## Additional Resources - -@sphinxdirective +Additional Resources +#################### * :ref:`Troubleshooting Guide for OpenVINO Installation & Configuration ` * Converting models for use with OpenVINO™: :ref:`Model Optimizer User Guide ` * 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 \ No newline at end of file +@endsphinxdirective