tools/README.md

   1 # OpenVINO™ Python* openvino.tools package
   2
   3 ## General
   4 `openvino.tools` package includes:
   5 * openvino.tools.accuracy_checker
   6 * openvino.tools.benchmark
   7 * openvino.tools.calibration
   8 * openvino.tools.utils
   9
  10 Please, refer to https://docs.openvinotoolkit.org for details.
  11
  12 ## Installation
  13 Choose neccessary Python\* version and define `PYTHONPATH` environment variable.
  14
  15 ### Prerequisites
  16
  17 Install prerequisites first:
  18
  19 #### 1. Python
  20
  21 **openvino.tools** is **Python 3** library. Install it first:
  22
  23 - [Python3][python3]
  24 - [setuptools][setuptools]
  25
  26 ```bash
  27 sudo apt-get install python3 python3-dev python3-setuptools python3-pip
  28 ```
  29
  30 Python setuptools and python package manager (pip) install packages into system directory by default. There are several options:
  31
  32 - work inside [virtual environment][virtualenv] (best solution).
  33 - use `--user` option for all `pip` commands.
  34 - install all dependencies with *sudo* permissions.
  35
  36 In order to use virtual environment you should install it:
  37
  38 ```bash
  39 python3 -m pip install virtualenv
  40 python3 -m virtualenv -p `which python3` <directory_for_environment>
  41 ```
  42
  43 Before starting to work inside virtual environment, it should be activated:
  44
  45 ```bash
  46 source <directory_for_environment>/bin/activate
  47 ```
  48
  49 Virtual environment can be deactivated using command
  50
  51 ```bash
  52 deactivate
  53 ```
  54
  55 #### 2. Install package prerequisites
  56
  57 The next step is installing package prerequisites.
  58
  59 ```bash
  60 python3 -m pip install -r accuracy_checker/requirements.txt benchmark/requirements.txt calibration/requirements.txt
  61 ```
  62
  63 ### Configuration
  64
  65 Each subpackage has specific configuration. Please, refer to specific subpackage documentation for details.
  66
  67 [python3]: https://www.python.org/downloads/
  68 [setuptools]: https://pypi.python.org/pypi/setuptools
  69