Install OpenVINO™ Development Tools¶

OpenVINO Development Tools is a set of utilities that make it easy to develop and optimize models and applications for OpenVINO. It provides the following tools:

• Model Optimizer

• Benchmark Tool

• Accuracy Checker and Annotation Converter

• Post-Training Optimization Tool

The instructions on this page show how to install OpenVINO Development Tools. If you are a Python developer, it only takes a few simple steps to install the tools with PyPI. If you are developing in C++, OpenVINO Runtime must be installed separately before installing OpenVINO Development Tools.

In both cases, Python 3.6 - 3.9 need be installed on your machine before starting.

Note

From the 2022.1 release, the OpenVINO™ Development Tools can only be installed via PyPI.

For Python Developers¶

If you are a Python developer, follow the steps in the Installing OpenVINO Development Tools section on this page to install it. Installing OpenVINO Development Tools will also install OpenVINO Runtime as a dependency, so you don’t need to install OpenVINO Runtime separately. This option is recommended for new users.

For C++ Developers¶

If you are a C++ developer, you must first install OpenVINO Runtime separately to set up the C++ libraries, sample code, and dependencies for building applications with OpenVINO. These files are not included with the PyPI distribution. See the Install OpenVINO Runtime page to install OpenVINO Runtime from an archive file for your operating system.

Installing OpenVINO™ Development Tools¶

Follow these step-by-step instructions to install OpenVINO Development Tools on your computer.

Step 1. Set Up Python Virtual Environment¶

Create a virtual Python environment to avoid dependency conflicts. To create a virtual environment, use the following command:

python3 -m venv openvino_env

python -m venv openvino_env


Step 2. Activate Virtual Environment¶

Activate the newly created Python virtual environment by issuing this command:

source openvino_env/bin/activate

openvino_env\Scripts\activate


Important

The above command must be re-run every time a new command terminal window is opened.

Step 3. Set Up and Update PIP to the Highest Version¶

Make sure pip is installed in your environment and upgrade it to the latest version by issuing the following command:

python -m pip install --upgrade pip

Step 4. Install the Package¶

To install and configure the components of the development package for working with specific frameworks, use the commands below.

Note that the commands are different for a Python installation and a C++ installation. If you want to develop with Python only, follow the instructions in the Python tab. If you want to develop with C++, first make sure you have installed OpenVINO Runtime using archive files as stated in the For C++ Developers section, then follow the instructions in the C++ tab.

To install and configure the components of the development package for working with specific frameworks, use the following command:

pip install openvino-dev[extras]


where the extras parameter specifies one or more deep learning frameworks via these values: caffe, kaldi, mxnet, onnx, pytorch, tensorflow, tensorflow2. Make sure that you install the corresponding frameworks for your models.

For example, to install and configure the components for working with TensorFlow 2.x and ONNX, use the following command:

pip install openvino-dev[tensorflow2,onnx]


Note

Model Optimizer support for TensorFlow 1.x environment has been deprecated. Use the tensorflow2 parameter to install a TensorFlow 2.x environment that can convert both TensorFlow 1.x and 2.x models. If your model isn’t compatible with the TensorFlow 2.x environment, use the tensorflow parameter to install the TensorFlow 1.x environment. The TF 1.x environment is provided only for legacy compatibility reasons.

When using OpenVINO Development Tools for C++ development, it’s important to install the same version as OpenVINO Runtime. Following the instructions below will ensure that you are installing a version that matches that of OpenVINO Runtime.

Recommended: Install Using the Requirements Files After you have installed OpenVINO Runtime from an archive file, you can find a set of requirements files in the <INSTALL_DIR>toolsdirectory. The requirements files will install the matching version of OpenVINO Development Tools and its dependencies.

1. Install the OpenVINO Development Tools mandatory requirements using the following command:

pip install -r <INSTALL_DIR>\tools\requirements.txt

1. If you are using additional frameworks, you must also install the requirements for those frameworks using the corresponding requirements file. For example, if you are using a TensorFlow model, use the following command to install requirements for TensorFlow:

pip install -r <INSTALL_DIR>\tools\requirements_tensorflow2.txt


Alternative: Install the openvino-dev Package from PyPI You can also install OpenVINO Development Tools from PyPI using the following command.

Important

Make sure to specify the openvino-dev version that matches your installed version of OpenVINO Runtime. Otherwise, compatibility errors are likely to occur.

pip install openvino-dev[EXTRAS]==2022.1


where the EXTRAS parameter specifies one or more deep learning frameworks via these values: caffe, kaldi, mxnet, onnx, pytorch, tensorflow, tensorflow2. Make sure that you install the corresponding frameworks for your models. For example:

pip install openvino-dev[tensorflow2,onnx]==2022.1


Note

Model Optimizer support for TensorFlow 1.x environment has been deprecated. Use the tensorflow2 parameter or to install a TensorFlow 2.x environment that can convert both TensorFlow 1.x and 2.x models. If your model isn’t compatible with the TensorFlow 2.x environment, use the tensorflow parameter to install the TensorFlow 1.x environment. The TF 1.x environment is provided only for legacy compatibility reasons.

For more details on the openvino-dev PyPI package, see https://pypi.org/project/openvino-dev/.

Step 5. Verify the Installation¶

To verify the package is properly installed, run the command below (this may take a few seconds):

mo -h

You will see the help message for Model Optimizer if installation finished successfully. If you get an error, refer to the Troubleshooting Guide for possible solutions.

Congratulations! You finished installing OpenVINO Development Tools with C++ capability. Now you can start exploring OpenVINO’s functionality through example C++ applications. See the “What’s Next?” section to learn more!

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.

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.

Visit the Tutorials page for more Jupyter Notebooks to get you started with OpenVINO, such as:

Try the C++ Quick Start Example for step-by-step instructions on building and running a basic image classification C++ application.

Visit the Samples page for other C++ example applications to get you started with OpenVINO, such as:

Learn OpenVINO Development Tools¶

• Explore a variety of pre-trained deep learning models in the Open Model Zoo and deploy them in demo applications to see how they work.

• Want to import a model from another framework and optimize its performance with OpenVINO? Visit the Model Optimizer Developer Guide.

• Accelerate your model’s speed even further with quantization and other compression techniques using Post-Training Optimization Tool.

• Benchmark your model’s inference speed with one simple command using the Benchmark Tool.