Files
openvino/docs/install_guides/installing-model-dev-tools.md
Yuan Xu a5362a4d58 Apply same changes from 22/1 to master (#11035)
* 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
2022-03-18 12:07:07 +00:00

148 lines
5.7 KiB
Markdown

# Install OpenVINO™ Development Tools {#openvino_docs_install_guides_install_dev_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
To avoid dependency conflicts, use a virtual environment. Skip this step only if you do want to install all dependencies globally.
Use the following command to create a virtual environment:
@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:
```sh
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**: For TensorFlow, 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):
```sh
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](installing-openvino-linux.md), [Windows](installing-openvino-windows.md), or [macOS](installing-openvino-macos.md)), [APT for Linux](installing-openvino-apt.md) or [YUM for Linux](installing-openvino-yum.md).
* 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:
### Recommended: Install Using the Requirements Files
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**: For TensorFlow, use the `tensorflow2` value as much as possible. The `tensorflow` value is provided only for compatibility reasons.
For more details, see <https://pypi.org/project/openvino-dev/>.
## What's Next?
Now you may continue with the following tasks:
* To convert models for use with OpenVINO, see [Model Optimizer Developer Guide](../MO_DG/Deep_Learning_Model_Optimizer_DevGuide.md).
* See pre-trained deep learning models in our [Open Model Zoo](../model_zoo.md).
* Try out OpenVINO via [OpenVINO Notebooks](https://docs.openvino.ai/latest/notebooks/notebooks.html).
* To write your own OpenVINO™ applications, see [OpenVINO Runtime User Guide](../OV_Runtime_UG/openvino_intro.md).
* See sample applications in [OpenVINO™ Toolkit Samples Overview](../OV_Runtime_UG/Samples_Overview.md).
## Additional Resources
- Intel® Distribution of OpenVINO™ toolkit home page: <https://software.intel.com/en-us/openvino-toolkit>
- For IoT Libraries & Code Samples, see [Intel® IoT Developer Kit](https://github.com/intel-iot-devkit).