Files
openvino/docs/install_guides/installing-model-dev-tools.md
Yuan Xu 7963ba20f4 Update Get Started Guide structure (#11875)
* Add Overview page

* Revert "Add Overview page"

* fix errors & formatting

* fix article usage according to the styles

* fix errors

* update according to PXT comments

* CVS-80775

* update support matrix with Python version

* fix formatting

* fix formatting

* CVS-71745

* update formatting

* fix formatting

* fix formatting

* fix links & errors

* fix formatting

* update bullet points

* update

* adjust the order

* update

* update

* updates

* update references

* update

* update

* apply same updates with 22/1

* minor fix

* update reference link

* fix CVS-71846

* test

* add troubleshooting steps

* restructure get started home page

* update navigation menu

* update formatting

* fix mistakes

* update wording

* update

* rename configurations files

* update wording

* adjust the structure

* update formatting

* reverse the heading

* test with formatting

* 2nd version of Get Started homepage

* add line breaks

* change to ordered list

* update wording

* update content

* updates

* update DL workbench reference

* update wording

* update references to pip installations

* remove redundant files

* update headings

* update

* update

* restructure

* rename

* updates

* remove a comment

* correct grammar

* correct grammar

* update structure

* update headings

* restructure

* fix formatting

* change the capitalization

* update heading

* update PyPI install

* updates

* update formatting

* Update docs/install_guides/troubleshooting-steps.md

Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com>

* Update docs/install_guides/troubleshooting-steps.md

Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com>

* integrating comments

* update

* update

* correct an error

* correct an error

* update

* update

* update wording

* typo

* typo

* hiding CentOS issues

* update headings

* update heading

* Update docs/get_started/get_started_demos.md

Co-authored-by: Karol Blaszczak <karol.blaszczak@intel.com>

* Update docs/get_started/get_started_demos.md

Co-authored-by: Karol Blaszczak <karol.blaszczak@intel.com>

* Update docs/install_guides/installing-model-dev-tools.md

Co-authored-by: Karol Blaszczak <karol.blaszczak@intel.com>

* Update docs/install_guides/installing-model-dev-tools.md

Co-authored-by: Karol Blaszczak <karol.blaszczak@intel.com>

* Update docs/install_guides/pypi-openvino-dev.md

* Update docs/install_guides/pypi-openvino-dev.md

Co-authored-by: Karol Blaszczak <karol.blaszczak@intel.com>

Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com>
Co-authored-by: Karol Blaszczak <karol.blaszczak@intel.com>
2022-06-15 05:59:17 +00:00

5.9 KiB

Install OpenVINO™ Development Tools

If you want to download, convert, optimize and tune pre-trained deep learning models, install OpenVINO™ Development Tools, which provides the following tools:

  • Model Optimizer
  • Benchmark Tool
  • Accuracy Checker and Annotation Converter
  • Post-Training Optimization Tool
  • Model Downloader and other Open Model Zoo tools

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, you can find the main steps below to install OpenVINO Development Tools. For more details, see https://pypi.org/project/openvino-dev.

While installing OpenVINO Development Tools, OpenVINO Runtime will also be installed as a dependency, so you don't need to install OpenVINO Runtime separately.

Step 1. Set Up Python Virtual Environment

Use a virtual environment to avoid dependency conflicts.

To create a virtual environment, use the following command:

@sphinxdirective

.. tab:: Linux and macOS

.. code-block:: sh

  python3 -m venv openvino_env

.. tab:: Windows

.. code-block:: sh

  python -m venv openvino_env

@endsphinxdirective

Step 2. Activate Virtual Environment

@sphinxdirective

.. tab:: Linux and macOS

.. code-block:: sh

  source openvino_env/bin/activate

.. tab:: Windows

.. code-block:: sh

  openvino_env\Scripts\activate

@endsphinxdirective

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

Use 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 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 TensorFlow 2.x environment to convert both TensorFlow 1.x and 2.x models. Use the tensorflow2 value as much as possible. The tensorflow value is provided only for compatibility reasons.

Step 5. Verify the Installation

To verify if 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.

For C++ Developers

Note the following things:

  • To install OpenVINO Development Tools, you must have OpenVINO Runtime installed first. You can install OpenVINO Runtime through an installer (Linux, Windows, or macOS), APT for Linux or YUM for Linux.
  • Ensure that the version of OpenVINO Development Tools you are installing matches that of OpenVINO Runtime.

Use either of the following ways to install OpenVINO Development Tools:

  1. After you have installed OpenVINO Runtime from an installer, APT or YUM repository, you can find a set of requirements files in the <INSTALLDIR>\tools\ directory. Select the most suitable ones to use.
  2. Install the same version of OpenVINO Development Tools by using the requirements files. To install mandatory requirements only, use the following command:
    pip install -r <INSTALLDIR>\tools\requirements.txt
    
  3. Make sure that you also install your additional frameworks with the corresponding requirements files. For example, if you are using a TensorFlow model, use the following command to install requirements for TensorFlow:
pip install -r <INSTALLDIR>\tools\requirements_tensorflow2.txt

Alternative: Install from the openvino-dev Package

You can also use the following command to install the latest package version available in the index:

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.

If you have installed OpenVINO Runtime via the installer, to avoid version conflicts, specify your version in the command. For example:

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

Note

: Model Optimizer support for TensorFlow 1.x environment has been deprecated. Use TensorFlow 2.x environment to convert both TensorFlow 1.x and 2.x models. The tensorflow value is provided only for compatibility reasons, use the tensorflow2 value instead.

For more details, see https://pypi.org/project/openvino-dev/.

What's Next?

Now you may continue with the following tasks:

Additional Resources