OpenVINO Python API

OpenVINO Python API is a part of the OpenVINO library. The component is responsible for:

• Bindings of OpenVINO - allowing users to use the OpenVINO library in their Python code. Python API provides bindings to basic and advanced APIs from OpenVINO Runtime.
• Extending OpenVINO with pythonic features - on top of direct translations from C++, Python API component:
  • Adds specific extensions to support numpy-based data.
  • Provides support for external frameworks inputs.
  • Provides shortcuts and helpers with more pythonic design.
  • Allows to apply advanced concepts, like shared memory, to take full advantage of OpenVINO.

OpenVINO Python API uses the common codestyle checks which are adjusted to project needs.

Key contacts

If you have any questions, feature requests or want us to review your PRs, send us a message or ping us on GitHub via openvino-ie-python-api-maintainers. You can always directly contact everyone from this group.

Components

OpenVINO PYTHON API has the following structure:

• docs - folder that contains developer documentation and code examples.
• src - folder with all source files for Python API.
  • src/openvino - Python sources.
  • src/openvino/preprocess - Torchvision to OpenVINO preprocessing converter.
  • src/pyopenvino - C++ sources.
• tests - tests directory for OpenVINO Python API.
• thirdparty - folder that contains third-party modules like pybind11.
• wheel - wheel-specific directory that contains all specific requirements and files used during wheel creation.

Tutorials

If you want to contribute to OpenVINO Python API, here is the list of learning materials and project guidelines:

• How to contribute
• How to extend OpenVINO Python API
• How to test OpenVINO Python API
• How to upgrade local Python version
• How we manage stub .pyi files

See also

• OpenVINO™ README
• OpenVINO™ Core Components
• OpenVINO™ Python API Reference
• OpenVINO™ Python API Advanced Inference
• OpenVINO™ Python API Exclusives
• pybind11 repository
• pybind11 documentation