openvino/tools
tadamczx a3c7e15860
[DOCS] Docs file structure update with fixes (#23343)
- Updated paths in an entire documentation,
- updated scripts used in docs building process,
- updated docs cmake to handle new scripts,
- fixed links,
- fixed other errors found in docs.

---------

Co-authored-by: Maciej Smyk <maciejx.smyk@intel.com>
Co-authored-by: Sebastian Golebiewski <sebastianx.golebiewski@intel.com>
Co-authored-by: Karol Blaszczak <karol.blaszczak@intel.com>
Co-authored-by: Andrzej Kopytko <andrzejx.kopytko@intel.com>
Co-authored-by: Tatiana Savina <tatiana.savina@intel.com>
Co-authored-by: Vishniakov Nikolai <nikolai.vishniakov@intel.com>
2024-03-11 17:05:58 +00:00
..
benchmark_tool [DOCS] Docs file structure update with fixes (#23343) 2024-03-11 17:05:58 +00:00
mo Additional cleaning of `InferenceEngine` (#22959) 2024-02-20 13:26:53 +00:00
openvino_dev [DOCS] Update OpenVINO API references (#22884) 2024-02-19 09:27:14 +00:00
ovc [TF FE] Set single input tensor names in TF1 formats. (#22503) 2024-02-19 13:54:42 +00:00
.gitignore Align folder structure for Benchmark Tool (#6625) 2021-07-19 11:57:51 +03:00
CMakeLists.txt Drop POT (#21805) 2023-12-21 16:46:37 +04:00
README.md fix errors in documentation (#9384) 2022-01-27 19:39:49 +03:00
constraints.txt [ONNX] Switched to ONNX 1.15.0 (#20929) 2023-12-19 18:55:32 +00: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.