openvino/tools
Karol Blaszczak a5c616bc3c
[Documentation]: Added description for NNCF PTQ (#14437) (#14665)
authored-by: Alexander Kozlov <alexander.kozlov@intel.com>
2022-12-15 15:05:47 +01:00
..
benchmark_tool [AUTO][Benchmark APP] sync config parsing logic of benchmark python version with benchmark c++ version (#14328) 2022-12-06 17:28:25 +08:00
compile_tool Fixing assert when handling iop, iol and ioml (#13526) 2022-10-19 12:14:00 +03:00
cross_check_tool [Install] Remove upper bound for NumPy for default installation and update upper bounds for extras (#13985) 2022-11-30 09:53:06 +04:00
deployment_manager [Deployment Manager Configs] Updated with actual 2022.3.0 structure (#14585) 2022-12-12 22:23:11 +04:00
legacy/benchmark_app DOCS-menu-recreate-structure-step5 (#14637) 2022-12-14 18:33:02 +01:00
mo [TF FE] Add info messages in Model Optimizer (#14593) 2022-12-13 13:24:23 +01:00
openvino_dev Added Debian, Raspbian, Ubuntu 22.10 support to install dependencies (#14226) 2022-11-25 11:13:43 +04:00
pot [Documentation]: Added description for NNCF PTQ (#14437) (#14665) 2022-12-15 15:05:47 +01:00
.gitignore Align folder structure for Benchmark Tool (#6625) 2021-07-19 11:57:51 +03:00
CMakeLists.txt Added Debian, Raspbian, Ubuntu 22.10 support to install dependencies (#14226) 2022-11-25 11:13:43 +04:00
README.md fix errors in documentation (#9384) 2022-01-27 19:39:49 +03:00

README.md

OpenVINO™ Python* development tools

General

OpenVINO includes following tools:

  • openvino.tools.benchmark

Please, refer to https://docs.openvino.ai for details.

Installation

Prerequisites

Install prerequisites first:

1. Python

Install Python prerequisites:

Run following command to install these prerequisites on Ubuntu*:

sudo apt-get install python3 python3-dev python3-setuptools python3-pip

Python setuptools and python package manager (pip) install packages into system directory by default. There are several options:

  • work inside [virtual environment][virtualenv] (best solution).
  • use --user option for all pip commands.
  • install all dependencies with sudo permissions.

In order to use virtual environment you should install it:

python3 -m pip install virtualenv
python3 -m virtualenv -p `which python3` <directory_for_environment>

Before starting to work inside virtual environment, it should be activated:

source <directory_for_environment>/bin/activate

Virtual environment can be deactivated using command

deactivate

2. Install packages

You can install tools by specifying path to tool with setup.py in pip install command:

python3 -m pip install <tools_folder>/

For example, to install Benchmark Tool, use the following command:

python3 -m pip install benchmark_tool/

Configuration

Each subpackage has specific configuration. Please, refer to specific subpackage documentation for details.