tools/accuracy_checker/README.md

   1 # Deep Learning accuracy validation framework
   2
   3 ## Installation
   4
   5 ### Prerequisites
   6
   7 Install prerequisites first:
   8
   9 #### 1. Python
  10
  11 **accuracy checker** uses **Python 3**. Install it first:
  12
  13 - [Python3][python3], [setuptools][setuptools]:
  14
  15 ```bash
  16 sudo apt-get install python3 python3-dev python3-setuptools python3-pip
  17 ```
  18
  19 Python setuptools and python package manager (pip) install packages into system directory by default. Installation of accuracy checker tested only via [virtual environment][virtualenv].
  20
  21 In order to use virtual environment you should install it first:
  22
  23 ```bash
  24 python3 -m pip install virtualenv
  25 python3 -m virtualenv -p `which python3` <directory_for_environment>
  26 ```
  27
  28 Before starting to work inside virtual environment, it should be activated:
  29
  30 ```bash
  31 source <directory_for_environment>/bin/activate
  32 ```
  33
  34 Virtual environment can be deactivated using command
  35
  36 ```bash
  37 deactivate
  38 ```
  39
  40 #### 2. Frameworks
  41
  42 The next step is installing backend frameworks for Accuracy Checker.
  43
  44 In order to evaluate some models required frameworks have to be installed. Accuracy-Checker supports these frameworks:
  45
  46 - [OpenVINO][openvino-get-started].
  47 - [Caffe][caffe-get-started].
  48
  49 You can use any of them or several at a time.
  50
  51 #### 3. Requirements installation
  52 ```bash
  53 pip3 install -r requirements.txt
  54
  55 [python3]: https://www.python.org/downloads/
  56 [setuptools]: https://pypi.python.org/pypi/setuptools
  57 [caffe-get-started]: accuracy_checker/launcher/caffe_installation_readme.md
  58 [virtual-environment]: https://docs.python.org/3/tutorial/venv.html
  59 [virtualenv]: https://virtualenv.pypa.io/en/stable
  60 [openvino-get-started]: https://software.intel.com/en-us/openvino-toolkit/documentation/get-started