* Extensibility guide with FE extensions and remove OV_FRAMEWORK_MAP from docs * Rework of Extensibility Intro, adopted examples to missing OPENVINO_FRAMEWORK_MAP * Removed OPENVINO_FRAMEWORK_MAP reference * Frontend extension detailed documentation * Fixed distributed snippets * Fixed snippet inclusion in FE extension document and chapter headers * Fixed wrong name in a snippet reference * Fixed test for template extension due to changed number of loaded extensions * Update docs/Extensibility_UG/frontend_extensions.md Co-authored-by: Ivan Tikhonov <ivan.tikhonov@intel.com> * Minor fixes in extension snippets * Small grammar fix Co-authored-by: Ivan Tikhonov <ivan.tikhonov@intel.com> Co-authored-by: Ivan Tikhonov <ivan.tikhonov@intel.com> * DOCS: transition banner (#10973) * transition banner * minor fix * update transition banner * updates * update custom.js * updates * updates * Documentation fixes (#11044) * Benchmark app usage * Fixed link to the devices * More fixes * Update docs/OV_Runtime_UG/multi_device.md Co-authored-by: Sergey Lyubimtsev <sergey.lyubimtsev@intel.com> * Removed several hardcoded links Co-authored-by: Sergey Lyubimtsev <sergey.lyubimtsev@intel.com> * Updated documentation for compile_tool (#11049) * Added deployment guide (#11060) * Added deployment guide * Added local distribution * Updates * Fixed more indentations * Removed obsolete code snippets (#11061) * Removed obsolete code snippets * NCC style * Fixed NCC for BA * Add a troubleshooting issue for PRC installation (#11074) * updates * adding gna to linux * add missing reference * update * Update docs/install_guides/installing-model-dev-tools.md Co-authored-by: Sergey Lyubimtsev <sergey.lyubimtsev@intel.com> * Update docs/install_guides/installing-model-dev-tools.md Co-authored-by: Sergey Lyubimtsev <sergey.lyubimtsev@intel.com> * Update docs/install_guides/installing-model-dev-tools.md Co-authored-by: Sergey Lyubimtsev <sergey.lyubimtsev@intel.com> * Update docs/install_guides/installing-model-dev-tools.md Co-authored-by: Sergey Lyubimtsev <sergey.lyubimtsev@intel.com> * Update docs/install_guides/installing-model-dev-tools.md Co-authored-by: Sergey Lyubimtsev <sergey.lyubimtsev@intel.com> * update * minor updates * add gna item to yum and apt * add gna to get started page * update reference formatting * merge commit * add a troubleshooting issue * update * update * fix CVS-71846 Co-authored-by: Sergey Lyubimtsev <sergey.lyubimtsev@intel.com> * DOCS: fixed hardcoded links (#11100) * Fixes * Use links * applying reviewers comments to the Opt Guide (#11093) * applying reviewrs comments * fixed refs, more structuring (bold, bullets, etc) * refactoring tput/latency sections * next iteration (mostly latency), also brushed the auto-batching and other sections * updates sync/async images * common opts brushed * WIP tput redesigned * minor brushing of common and auto-batching * Tput fully refactored * fixed doc name in the link * moved int8 perf counters to the right section * fixed links * fixed broken quotes * fixed more links * add ref to the internals to the TOC * Added a note on the batch size Co-authored-by: Andrey Zaytsev <andrey.zaytsev@intel.com> * [80085] New images for docs (#11114) * change doc structure * fix manager tools * fix manager tools 3 step * fix manager tools 3 step * new img * new img for OV Runtime * fix steps * steps * fix intendents * change list * fix space * fix space * code snippets fix * change display * Benchmarks 2022 1 (#11130) * Minor fixes * Updates for 2022.1 * Edits according to the review * Edits according to review comments * Edits according to review comments * Edits according to review comments * Fixed table * Edits according to review comments * Removed config for Intel® Core™ i7-11850HE * Removed forward-tacotron-duration-prediction-241 graph * Added resnet-18-pytorch * Add info about Docker images in Deployment guide (#11136) * Renamed user guides (#11137) * fix screenshot (#11140) * More conservative recommendations on dynamic shapes usage in docs (#11161) * More conservative recommendations about using dynamic shapes * Duplicated statement from C++ part to Python part of reshape doc (no semantical changes) * Update ShapeInference.md (#11168) * Benchmarks 2022 1 updates (#11180) * Updated graphs * Quick fix for TODO in Dynamic Shapes article * Anchor link fixes * Fixed DM config (#11199) * DOCS: doxy sphinxtabs (#11027) * initial implementation of doxy sphinxtabs * fixes * fixes * fixes * fixes * fixes * WA for ignored visibility attribute * Fixes Co-authored-by: Sergey Lyalin <sergey.lyalin@intel.com> Co-authored-by: Ivan Tikhonov <ivan.tikhonov@intel.com> Co-authored-by: Nikolay Tyukaev <nikolay.tyukaev@intel.com> Co-authored-by: Sergey Lyubimtsev <sergey.lyubimtsev@intel.com> Co-authored-by: Yuan Xu <yuan1.xu@intel.com> Co-authored-by: Maxim Shevtsov <maxim.y.shevtsov@intel.com> Co-authored-by: Andrey Zaytsev <andrey.zaytsev@intel.com> Co-authored-by: Tatiana Savina <tatiana.savina@intel.com> Co-authored-by: Ilya Naumov <ilya.naumov@intel.com> Co-authored-by: Evgenya Stepyreva <evgenya.stepyreva@intel.com>
12 KiB
Install and Configure Intel® Distribution of OpenVINO™ Toolkit for Linux
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 are not part of the installer. These tools are now only available on pypi.org.
System Requirements
@sphinxdirective .. tab:: Operating Systems
- Ubuntu 18.04 long-term support (LTS), 64-bit
- Ubuntu 20.04 long-term support (LTS), 64-bit
.. note:: Since the OpenVINO™ 2022.1 release, CentOS 7.6, 64-bit is not longer supported.
.. tab:: Hardware
Optimized for these processors:
- 6th to 12th generation Intel® Core™ processors and Intel® Xeon® processors
- 3rd generation Intel® Xeon® Scalable processor (formerly code named Cooper Lake)
- Intel® Xeon® Scalable processor (formerly Skylake and Cascade Lake)
- Intel Atom® processor with support for Intel® Streaming SIMD Extensions 4.1 (Intel® SSE4.1)
- Intel Pentium® processor N4200/5, N3350/5, or N3450/5 with Intel® HD Graphics
- Intel® Iris® Xe MAX Graphics
- Intel® Neural Compute Stick 2
- Intel® Vision Accelerator Design with Intel® Movidius™ VPUs
.. tab:: Processor Notes
Processor graphics are not included in all processors.
See Product Specifications_ for information about your processor.
.. _Product Specifications: https://ark.intel.com/
.. tab:: Software
CMake 3.13 or higher, 64-bit <https://cmake.org/download/>_- GCC 7.5.0 (for Ubuntu 18.04) or GCC 9.3.0 (for Ubuntu 20.04)
Python 3.6 - 3.9, 64-bit <https://www.python.org/downloads/windows/>_
@endsphinxdirective
Overview
This guide provides step-by-step instructions on how to install the Intel® Distribution of OpenVINO™ toolkit. Links are provided for each type of compatible hardware including downloads, initialization and configuration steps. The following steps will be covered:
- Install the Intel® Distribution of OpenVINO™ Toolkit
- Install External Software Dependencies
- Configure the Environment
- Download additional components (Optional)
- Configure Inference on non-CPU Devices (Optional)
- What's next?
@sphinxdirective
.. important::
Before you start your journey with installation of the Intel® Distribution of OpenVINO™, we encourage you to check our :ref:code samples <code samples> in C, C++, Python and :ref:notebook tutorials <notebook tutorials> that we prepared for you, so you could see all the amazing things that you can achieve with our tool.
@endsphinxdirective
Step 1: Install the Intel® Distribution of OpenVINO™ Toolkit
-
Select and download the Intel® Distribution of OpenVINO™ toolkit installer file from Intel® Distribution of OpenVINO™ toolkit for Linux.
-
Open a command prompt terminal window. You can use the keyboard shortcut: Ctrl+Alt+T
-
Change directories to where you downloaded the Intel Distribution of OpenVINO™ toolkit for Linux file.
If you downloaded the starter script to the current user'sDownloadsdirectory:cd ~/Downloads/You should find there a bootstrapper script
l_openvino_toolkit_p_<version>.sh. -
Add executable rights for the current user:
chmod +x l_openvino_toolkit_p_<version>.sh -
If you want to use graphical user interface (GUI) installation wizard, run the script without any parameters:
./l_openvino_toolkit_p_<version>.sh
You should see the following dialog box open up:@sphinxdirective
.. image:: _static/images/openvino-install.png :width: 400px :align: center
@endsphinxdirective
Otherwise, you can add parameters
-afor additional arguments and--clito run installation in command line (CLI):./l_openvino_toolkit_p_<version>.sh -a --cliNote
: To get additional information on all parameters that can be used, use the help option:
--help. Among others, you can find there-soption which offers silent mode, which together with--eula approveallows you to run whole installation with default values without any user inference. -
Follow the instructions on your screen. During the installation you will be asked to accept the license agreement. Your acceptance is required to continue. Check the installation process on the image below:
Click on the image to see the details.
By default, the Intel® Distribution of OpenVINO™ is installed to the following directory, referred to as<INSTALL_DIR>elsewhere in the documentation:- For root or administrator:
/opt/intel/openvino_<version>/ - For regular users:
/home/<USER>/intel/openvino_<version>/
For simplicity, a symbolic link to the latest installation is also created:/opt/intel/openvino_2022/or/home/<USER>/intel/openvino_2022/. - For root or administrator:
To check Release Notes please visit: Release Notes.
The core components are now installed. Continue to the next section to install additional dependencies.
Step 2: Install External Software Dependencies
This script enables you to install Linux platform development tools and components to work with the product.
-
Go to the
install_dependenciesdirectory:cd <INSTALL_DIR>/install_dependencies -
Run a script to download and install the external software dependencies:
sudo -E ./install_openvino_dependencies.shOnce the dependencies are installed, continue to the next section to set your environment variables.
Step 3: Configure the Environment
You must update several environment variables before you can compile and run OpenVINO™ applications. Set environment variables as follows:
source <INSTALL_DIR>/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.
Note
: You can also run this script every time when you start new terminal session. Open
~/.bashrcin your favorite editor, and addsource <INSTALL_DIR>/setupvars.sh. Next time when you open a terminal, you will see[setupvars.sh] OpenVINO™ environment initialized. Changing.bashrcis not recommended when you have many OpenVINO™ versions on your machine and want to switch among them, as each may require different setup.
The environment variables are set. Next, you can download some additional tools.
Step 4 (Optional): Download Additional Components
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 are not part of the installer. The OpenVINO™ Development Tools can only be installed via PyPI now. See Install OpenVINO™ Development Tools for detailed steps.
@sphinxdirective
.. dropdown:: OpenCV
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. The Intel® Distribution of OpenVINO™ provides a script to install OpenCV: <INSTALL_DIR>/extras/scripts/download_opencv.sh.
.. note::
Make sure you have 2 prerequisites installed: curl and tar.
Depending on how you have installed the Intel® Distribution of OpenVINO™, the script should be run either as root or regular user. After the execution of the script, you will find OpenCV extracted to <INSTALL_DIR>/extras/opencv.
@endsphinxdirective
Step 5 (Optional): Configure Inference on Non-CPU Devices
@sphinxdirective .. tab:: GNA
To enable the toolkit components to use Intel® Gaussian & Neural Accelerator (GNA) on your system, follow the steps in :ref:GNA Setup Guide <gna guide>.
.. tab:: GPU
To enable the toolkit components to use processor graphics (GPU) on your system, follow the steps in :ref:GPU Setup Guide <gpu guide>.
.. tab:: NCS 2
To perform inference on Intel® Neural Compute Stick 2 powered by the Intel® Movidius™ Myriad™ X VPU, follow the steps on :ref:NCS2 Setup Guide <ncs guide>.
.. tab:: VPU
To install and configure your Intel® Vision Accelerator Design with Intel® Movidius™ VPUs, see the :ref:VPU Configuration Guide <vpu guide>.
After configuration is done, you are ready to run the verification scripts with the HDDL Plugin for your Intel® Vision Accelerator Design with Intel® Movidius™ VPUs.
.. warning:: While working with either HDDL or NCS, choose one of them as they cannot run simultaneously on the same machine.
@endsphinxdirective
Step 6: What's Next?
Now you are ready to try out the toolkit.
Developing in Python:
- Start with TensorFlow models with OpenVINO™
- Start with ONNX and PyTorch models with OpenVINO™
- Start with PaddlePaddle models with OpenVINO™
Developing in C++:
- [Image Classification Async C++ Sample](@ref openvino_inference_engine_samples_classification_sample_async_README)
- [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)
Uninstalling the Intel® Distribution of OpenVINO™ Toolkit
To uninstall the toolkit, follow the steps on the Uninstalling page.
@sphinxdirective
.. dropdown:: Troubleshooting
PRC developers might encounter pip errors during Intel® Distribution of OpenVINO™ installation. To resolve the issues, try one of the following options:
- Add the download source using the
-iparameter with the Pythonpipcommand. For example:
.. code-block:: sh
pip install openvino-dev -i https://mirrors.aliyun.com/pypi/simple/
Use the --trusted-host parameter if the URL above is http instead of https.
- If you run into incompatibility issues between components after installing new Intel® Distribution of OpenVINO™ version, try running
requirements.txtwith the following command:
.. code-block:: sh
pip install -r <INSTALL_DIR>/tools/requirements.txt
@endsphinxdirective
@sphinxdirective
.. dropdown:: Additional Resources
- Converting models for use with OpenVINO™: :ref:
Model Optimizer Developer Guide <deep learning model optimizer> - Writing your own OpenVINO™ applications: :ref:
OpenVINO™ Runtime User Guide <deep learning openvino runtime> - Sample applications: :ref:
OpenVINO™ Toolkit Samples Overview <code samples> - Pre-trained deep learning models: :ref:
Overview of OpenVINO™ Toolkit Pre-Trained Models <model zoo> - IoT libraries and code samples in the GitHUB repository:
Intel® IoT Developer Kit_
.. _Intel® IoT Developer Kit: https://github.com/intel-iot-devkit
@endsphinxdirective