Files
openvino/inference-engine/ie_bridges/python/docs/api_overview.md
Andrey Zaytsev 5e4cd1127b Integrate UAT fixes (#5517)
* Added info on DockerHub CI Framework

* Feature/azaytsev/change layout (#3295)

* Changes according to feedback comments

* Replaced @ref's with html links

* Fixed links, added a title page for installing from repos and images, fixed formatting issues

* Added links

* minor fix

* Added DL Streamer to the list of components installed by default

* Link fixes

* Link fixes

* ovms doc fix (#2988)

* added OpenVINO Model Server

* ovms doc fixes

Co-authored-by: Trawinski, Dariusz <dariusz.trawinski@intel.com>

* Updated openvino_docs.xml

* Edits to MO

Per findings spreadsheet

* macOS changes

per issue spreadsheet

* Fixes from review spreadsheet

Mostly IE_DG fixes

* Consistency changes

* Make doc fixes from last round of review

* integrate changes from baychub/master

* Update Intro.md

* Update Cutting_Model.md

* Update Cutting_Model.md

* Fixed link to Customize_Model_Optimizer.md

Co-authored-by: Trawinski, Dariusz <dariusz.trawinski@intel.com>
Co-authored-by: baychub <cbay@yahoo.com>
2021-05-06 15:37:13 +03:00

1.7 KiB

Overview of Inference Engine Python* API

This API provides a simplified interface for Inference Engine functionality that allows you to:

  • Handle the models
  • Load and configure Inference Engine plugins based on device names
  • Perform inference in synchronous and asynchronous modes with arbitrary number of infer requests (the number of infer requests may be limited by target device capabilities)

Supported OSes

Inference Engine Python* API is supported on Ubuntu* 18.04 and 20.04, CentOS* 7.3 OSes, Raspbian* 9, Windows* 10 and macOS* 10.x.

Supported Python* versions:

Operating System Supported Python* versions:
Ubuntu* 18.04 3.6, 3.7
Ubuntu* 20.04 3.6, 3.7, 3.8
Windows* 10 3.6, 3.7, 3.8
CentOS* 7.3 3.6, 3.7
macOS* 10.x 3.6, 3.7
Raspbian* 9 3.6, 3.7

Set Up the Environment

To configure the environment for the Inference Engine Python* API, run:

  • On Ubuntu* 18.04 or 20.04: source <INSTALL_DIR>/bin/setupvars.sh .
  • On CentOS* 7.4: source <INSTALL_DIR>/bin/setupvars.sh .
  • On macOS* 10.x: source <INSTALL_DIR>/bin/setupvars.sh .
  • On Raspbian* 9,: source <INSTALL_DIR>/bin/setupvars.sh .
  • On Windows* 10: call <INSTALL_DIR>\bin\setupvars.bat

The script automatically detects latest installed Python* version and configures required environment if the version is supported. If you want to use certain version of Python*, set the environment variable PYTHONPATH=<INSTALL_DIR>/python/<desired_python_version> after running the environment configuration script.

API Reference

For the complete API Reference, see Inference Engine Python* API Reference