openvino/tools
Alexander Kozlov ed80e2eee8
Model optimizataion documentation update (#11072)
* Fixed Model Optimization Guide and NNCF docs

* Fixed the link to Optimum

* Updated installatin guide

* Changed API description

* Changes quantization documents

* Fixed links in the relevant components

* Fixed API description

* Revised CLI document

* Fixed formatting bugs in the main document

* Fixed formatting bugs in the main document

* Changed the structure. Added Default quantization usage via API

* Fixed E2E CLI example

* Added AccuracyAware usage description

* Revised structure and examples

* Fixed a link to POT intro

* Changed the structure for algorithms

* Fixed links

* Additional fixed of the links

* Revised Ranger documentation

* Some fixes

* Revised Best Practicies

* Fixed descriptions

* Fixed section names

* Changed the workflow one more time

* Additional fixes to the model structure

* Fixed AA usage

* Added DefaultQuantization flow image

* Fixed many issues

* Fixed many issues

* Applied many comments

* Additional fixes

* Fixed examples and provided links to them

* Changed DataLoader Example. Fixed FAQ

* Changed the main README for GitHub

* Fixed E2E CLI example

* Fixed links and code of DataLoader

* Fixed build issues

* Fixed more links

* Fixed one more documentation build issue

* Fixed more links

* Fixed code example

* Add multiple data loaders

* Add audio example

* Minor fixes in the code of sample loaders

* Add descriptions of dataloaders. Changed the behaviour of text loader

* Fixed typos

* Added a new item into the FAQ

* Apply wording corrections

* Update docs/OV_Runtime_UG/supported_plugins/CPU.md

Co-authored-by: Tatiana Savina <tatiana.savina@intel.com>

* Fixed comments

Co-authored-by: Tatiana Savina <tatiana.savina@intel.com>
2022-03-30 11:36:50 +03:00
..
benchmark_tool Update Benchmark guides (#11076) 2022-03-21 13:16:26 +03:00
compile_tool Updated documentation for compile_tool (#11049) 2022-03-22 19:28:02 +03:00
cross_check_tool [tools] cross check tool with api 2.0 (#10058) 2022-02-14 20:25:31 +03:00
deployment_manager Fixed DM config (#11199) 2022-03-24 15:50:48 +03:00
legacy/benchmark_app Legacy benchmark_app is added (#10239) 2022-02-28 12:26:41 +03:00
mo Update Model Optimizer User Guide (#10759) (#10934) 2022-03-14 19:12:34 +03:00
openvino_dev requirements markers clean up (#10179) 2022-02-09 10:18:24 +03:00
pot Model optimizataion documentation update (#11072) 2022-03-30 11:36:50 +03:00
.gitignore Align folder structure for Benchmark Tool (#6625) 2021-07-19 11:57:51 +03:00
CMakeLists.txt Enabled old BA only under ENABLE_SAMPLES (#10746) 2022-03-03 09:36:26 +03:00
README.md fix errors in documentation (#9384) 2022-01-27 19:39:49 +03:00
requirements_dev.in Add ability to generate requirements.txt files with dev tags (#9986) 2022-01-28 18:23:10 +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.