Docs: Update "Install OpenVINO Runtime on Linux from Archive File" page (#13345)
* docs: begin updates to install instructions * docs: change instructions for downloading and unpacking archive * docs: finish changes to Step 2 and Step 3 * docs: change whats next section * docs: minor updates and fix typos * docs: change link to GitHub archive page * docs: typo fix * docs: minor change * docs: replace wget command with curl * docs: clarify archive install is for C++ users * docs: add link to PyPI page * Update docs/install_guides/installing-openvino-from-archive-linux.md Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com> * Update docs/install_guides/installing-openvino-from-archive-linux.md Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com> * Update docs/install_guides/installing-openvino-from-archive-linux.md Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com> * docs: add link to Release Notes * docs: Change back to numbered instructions and remove Debian from OS list * Update docs/install_guides/installing-openvino-from-archive-linux.md * Update docs/install_guides/installing-openvino-from-archive-linux.md * Update docs/install_guides/installing-openvino-from-archive-linux.md * Update docs/install_guides/installing-openvino-from-archive-linux.md * Update docs/install_guides/installing-openvino-from-archive-linux.md * Update docs/install_guides/installing-openvino-from-archive-linux.md * Update docs/install_guides/installing-openvino-from-archive-linux.md * Update docs/install_guides/installing-openvino-from-archive-linux.md * Update docs/install_guides/installing-openvino-from-archive-linux.md * docs: change wget commands to curl * docs: change wget commands to curl * Update docs/install_guides/installing-openvino-from-archive-linux.md Co-authored-by: Yuan Xu <yuan1.xu@intel.com> * Update docs/install_guides/installing-openvino-from-archive-linux.md * Update installing-openvino-from-archive-linux.md * Update docs/install_guides/installing-openvino-from-archive-linux.md * Update docs/install_guides/installing-openvino-from-archive-linux.md * Update docs/install_guides/installing-openvino-from-archive-linux.md * Update docs/install_guides/installing-openvino-from-archive-linux.md * Update docs/install_guides/installing-openvino-from-archive-linux.md * Update docs/install_guides/installing-openvino-from-archive-linux.md * Update installing-openvino-from-archive-linux.md * Update installing-openvino-from-archive-linux.md * Update installing-openvino-from-archive-linux.md * Update installing-openvino-from-archive-linux.md * Update installing-openvino-from-archive-linux.md * Update installing-openvino-from-archive-linux.md * Update docs/install_guides/installing-openvino-from-archive-linux.md Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com> Co-authored-by: Yuan Xu <yuan1.xu@intel.com>
This commit is contained in:
Evan
GitHub
parent
db0e2be481
commit
f5300fdb98
@ -1,18 +1,21 @@
|
||||
# Install OpenVINO™ Runtime on Linux from an Archive File {#openvino_docs_install_guides_installing_openvino_from_archive_linux}
|
||||
|
||||
With the OpenVINO™ 2022.2 release, you can download and use archive files to install OpenVINO Runtime.
|
||||
With the OpenVINO™ 2022.2 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.
|
||||
|
||||
You can also check the [Release Notes](https://software.intel.com/en-us/articles/OpenVINO-RelNotes) for more information on updates in this release.
|
||||
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. See the [Install OpenVINO from PyPI](installing-openvino-pip.md) page for instructions on how to install OpenVINO Runtime for Python using PyPI.
|
||||
|
||||
> **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.
|
||||
|
||||
See the [Release Notes](https://software.intel.com/en-us/articles/OpenVINO-RelNotes) for more information on updates in the latest release.
|
||||
|
||||
## System Requirements
|
||||
|
||||
@sphinxdirective
|
||||
.. tab:: Operating Systems
|
||||
|
||||
* Ubuntu 18.04 long-term support (LTS), 64-bit
|
||||
* Ubuntu 20.04 long-term support (LTS), 64-bit
|
||||
* Ubuntu 18.04 long-term support (LTS) x86, 64-bit
|
||||
* Ubuntu 20.04 long-term support (LTS) x86, 64-bit
|
||||
* Red Hat Enterprise Linux 8 x86, 64-bit
|
||||
|
||||
.. note::
|
||||
Since the OpenVINO™ 2022.1 release, CentOS 7.6, 64-bit is no longer supported.
|
||||
@ -48,74 +51,90 @@ You can also check the [Release Notes](https://software.intel.com/en-us/articles
|
||||
|
||||
## Installing OpenVINO Runtime
|
||||
|
||||
### <a name="install-openvino"></a>Step 1: Download and Install the OpenVINO Core Components
|
||||
|
||||
@sphinxdirective
|
||||
|
||||
.. important::
|
||||
Before you start your journey with the installation of the Intel® Distribution of OpenVINO™ toolkit, we encourage you to check the :ref:`code samples <code samples>` in C, C++, Python and :ref:`notebook tutorials <notebook tutorials>`, so you could see all the amazing things that you can achieve with our tool.
|
||||
1. Open a command prompt terminal window. You can use the keyboard shortcut: Ctrl+Alt+T
|
||||
|
||||
2. Create the ``/opt/intel`` folder for OpenVINO by using the following command. If the folder already exists, skip this step.
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
sudo mkdir /opt/intel
|
||||
|
||||
.. note::
|
||||
The ``/opt/intel`` path is the recommended folder path for administrators or root users. If you prefer to install OpenVINO in regular userspace, the recommended path is ``/home/<USER>/intel``. You may use a different path if desired.
|
||||
|
||||
3. Browse to the current user's ``Downloads`` folder:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
cd <user_home>/Downloads
|
||||
|
||||
4. Download the `OpenVINO Runtime archive file for your system <https://storage.openvinotoolkit.org/repositories/openvino/packages/2022.2/linux/>`_, extract the files, rename the extracted folder and move it to the desired path:
|
||||
|
||||
.. tab:: Ubuntu 18.04
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
curl -L https://storage.openvinotoolkit.org/repositories/openvino/packages/2022.2/linux/l_openvino_toolkit_ubuntu18_2022.2.0.7713.af16ea1d79a_x86_64.tgz --output openvino_2022.2.0.7713.tgz
|
||||
tar -xf openvino_2022.2.0.7713.tgz
|
||||
sudo mv l_openvino_toolkit_ubuntu18_2022.2.0.7713.af16ea1d79a_x86_64 /opt/intel/openvino_2022.2.0.7713
|
||||
|
||||
.. tab:: Ubuntu 20.04
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
curl -L https://storage.openvinotoolkit.org/repositories/openvino/packages/2022.2/linux/l_openvino_toolkit_ubuntu20_2022.2.0.7713.af16ea1d79a_x86_64.tgz --output openvino_2022.2.0.7713.tgz
|
||||
tar -xf openvino_2022.2.0.7713.tgz
|
||||
sudo mv l_openvino_toolkit_ubuntu20_2022.2.0.7713.af16ea1d79a_x86_64 /opt/intel/openvino_2022.2.0.7713
|
||||
|
||||
.. tab:: RHEL 8
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
curl -L https://storage.openvinotoolkit.org/repositories/openvino/packages/2022.2/linux/l_openvino_toolkit_rhel8_2022.2.0.7713.af16ea1d79a_x86_64.tgz --output openvino_2022.2.0.7713.tgz
|
||||
tar -xf openvino_2022.2.0.7713.tgz
|
||||
sudo mv l_openvino_toolkit_rhel8_2022.2.0.7713.af16ea1d79a_x86_64 /opt/intel/openvino_2022.2.0.7713
|
||||
|
||||
5. For simplicity, it is useful to create a symbolic link as below:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
sudo ln -s openvino_2022.2.0.7713 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
|
||||
|
||||
### <a name="install-openvino"></a>Step 1: Download and Install the OpenVINO Package
|
||||
|
||||
1. Select and download the OpenVINO™ archive files from [Intel® Distribution of OpenVINO™ toolkit download page](https://software.intel.com/en-us/openvino-toolkit/choose-download). There are typically two files for you to download:
|
||||
```sh
|
||||
l_openvino_toolkit_<operating system>_<release version>_<package ID>_x86_64.tgz
|
||||
l_openvino_toolkit_<operating system>_<release version>_<package ID>_x86_64.tgz.sha256
|
||||
```
|
||||
where the `.sha256` file is used to verify the success of the download process.
|
||||
2. Open a command prompt terminal window. You can use the keyboard shortcut: Ctrl+Alt+T
|
||||
3. Change the directory to where you downloaded the archive files.<br>
|
||||
For example, if you downloaded the files to the current user's `Downloads` directory, use the following command:
|
||||
```sh
|
||||
cd ~/Downloads/
|
||||
```
|
||||
4. To verify the package by using the `.sha256` file:
|
||||
```sh
|
||||
sha256sum -с <archive name>.tgz.sha256
|
||||
```
|
||||
If any error message appears, check your network connections, re-download the correct files, and make sure the download process completes successfully.
|
||||
5. Extract OpenVINO files from the `.tgz` file:
|
||||
```sh
|
||||
tar xf <archive name>.tgz -C <destination_dir>
|
||||
```
|
||||
where the `<destination_dir>` is the directory that you extract OpenVINO files to. You're recommended to set it as:
|
||||
* For root users or administrators: `/opt/intel/`
|
||||
* For regular users: `/home/<USER>/intel/`
|
||||
|
||||
If you forgot to set the directory in Step 5, you can then use `sudo mv <extracted_folder> /opt/intel` (for root users or administrators), or `mv <extracted_folder> /home/<USER>/intel/` (for regular users) to set that.
|
||||
|
||||
For simplicity, it is useful to create a symbolic link/symlink:
|
||||
```sh
|
||||
ln -s /home/<USER>/intel/<extracted_folder> /home/<USER>/intel/openvino_2022
|
||||
```
|
||||
If such a link already exists, remove the previous link with `rm /home/<USER>/intel/openvino_2022`.
|
||||
|
||||
The `/opt/intel/openvino_<version>/` or `/home/<USER>/intel/openvino_<version>/` will be referred as the standard OpenVINO `<INSTALL_DIR>` in this document.
|
||||
|
||||
The core components are now installed. Continue to the next section to install components.
|
||||
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, for example, `/home/<USER>/Intel/`, OpenVINO is then installed in `/home/<USER>/Intel/openvino_2022`. The path to the `openvino_2022` directory is also referred as `<INSTALL_DIR>` throughout the OpenVINO documentation.
|
||||
|
||||
### <a name="set-the-environment-variables"></a>Step 2: Configure the Environment
|
||||
|
||||
You must update several environment variables before you can compile and run OpenVINO™ applications. Set environment variables as follows:
|
||||
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 <INSTALL_DIR> is not `/opt/intel/openvino_2022`, use the correct one instead.
|
||||
|
||||
```sh
|
||||
source <INSTALL_DIR>/setupvars.sh
|
||||
source /opt/intel/openvino_2022/setupvars.sh
|
||||
```
|
||||
|
||||
If you have more than one OpenVINO™ version on your machine, you can easily switch its version by sourcing `setupvars.sh` of your choice.
|
||||
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**: You can also run this script every time you start a new terminal session. Open `~/.bashrc` in your favorite editor, and add `source <INSTALL_DIR>/setupvars.sh`. Next time when you open a terminal, you will see `[setupvars.sh] OpenVINO™ environment initialized`. Changing `.bashrc` is not recommended when you have many OpenVINO™ versions on your machine and want to switch among them, as each may require a different setup.
|
||||
> **NOTE**: The above command must be re-run every time you start a new terminal session. To set up Linux to automatically run the command every time a new terminal is opened, open `~/.bashrc` 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 `.bashrc` is not recommended when you have multiple OpenVINO versions on your machine and want to switch among them.
|
||||
|
||||
The environment variables are set. Next, you can download some additional tools.
|
||||
The environment variables are set. Continue to the next section if you want to download any additional components.
|
||||
|
||||
### <a name="model-optimizer">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.
|
||||
|
||||
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 only be installed via PyPI. See [Install OpenVINO™ Development Tools](installing-model-dev-tools.md) for detailed steps.
|
||||
See the [Install OpenVINO Development Tools](installing-model-dev-tools.md) 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](https://github.com/opencv/opencv/wiki/BuildOpenCV4OpenVINO).
|
||||
|
||||
### <a name="optional-steps"></a>Step 4 (Optional): Configure Inference on Non-CPU Devices
|
||||
|
||||
OpenVINO Runtime has a plugin architecture that enables you to run inference on multiple devices without rewriting your code. Supported devices include integrated GPUs, discrete GPUs, NCS2, VPUs, and GNAs. See the instructions below to set up OpenVINO on these devices.
|
||||
|
||||
@sphinxdirective
|
||||
.. tab:: GPU
|
||||
|
||||
@ -141,18 +160,35 @@ OpenCV is necessary to run demos from Open Model Zoo (OMZ). Some OpenVINO sample
|
||||
@endsphinxdirective
|
||||
|
||||
## <a name="get-started"></a>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 you are ready to try out the toolkit.
|
||||
@sphinxdirective
|
||||
.. tab:: Get started with Python
|
||||
|
||||
Start with some Python tutorials:
|
||||
* [Hello Image Classification](https://docs.openvino.ai/latest/notebooks/001-hello-world-with-output.html)
|
||||
* [Convert TensorFlow models with OpenVINO™](https://docs.openvino.ai/latest/notebooks/101-tensorflow-to-openvino-with-output.html)
|
||||
* [Convert a PyTorch model and remove the image background](https://docs.openvino.ai/latest/notebooks/205-vision-background-removal-with-output.html)
|
||||
Try the `Python Quick Start Example <https://docs.openvino.ai/2022.2/notebooks/201-vision-monodepth-with-output.html>`_ 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
|
||||
|
||||
To start with C++ samples, see <a href="openvino_docs_OV_UG_Samples_Overview.html#build-samples-linux">Build Sample Applications on Linux</a> first, and then you can try the following samples:
|
||||
* [Hello Classification C++ Sample](@ref openvino_inference_engine_samples_hello_classification_README)
|
||||
* [Hello Reshape SSD C++ Sample](@ref openvino_inference_engine_samples_hello_reshape_ssd_README)
|
||||
* [Image Classification Async C++ Sample](@ref openvino_inference_engine_samples_classification_sample_async_README)
|
||||
Visit the :ref:`Tutorials <notebook tutorials>` page for more Jupyter Notebooks to get you started with OpenVINO, such as:
|
||||
|
||||
* `OpenVINO Python API Tutorial <https://docs.openvino.ai/2022.2/notebooks/002-openvino-api-with-output.html>`_
|
||||
* `Basic image classification program with Hello Image Classification <https://docs.openvino.ai/2022.2/notebooks/001-hello-world-with-output.html>`_
|
||||
* `Convert a PyTorch model and use it for image background removal <https://docs.openvino.ai/2022.2/notebooks/205-vision-background-removal-with-output.html>`_
|
||||
|
||||
.. tab:: Get started with C++
|
||||
|
||||
Try the `C++ Quick Start Example <openvino_docs_get_started_get_started_demos.html>`_ 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 <code 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 <openvino_inference_engine_samples_hello_reshape_ssd_README.html>`_
|
||||
* `Automatic speech recognition C++ sample <openvino_inference_engine_samples_speech_sample_README.html>`_
|
||||
|
||||
@endsphinxdirective
|
||||
|
||||
## <a name="uninstall"></a>Uninstalling the Intel® Distribution of OpenVINO™ Toolkit
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user