openvino/src/bindings/python
Przemyslaw Wysocki a96f2af2f4
[PyOV] Upgrade mistune and remove import-order (#14356)
2022-12-05 10:16:24 +01:00
..
docs [PyOV] Add README.md and align structure-showing style (#14093) 2022-11-21 16:42:36 +01:00
src [PyOV] Upgrade mistune and remove import-order (#14356) 2022-12-05 10:16:24 +01:00
tests [CPU] New operations: IsFinite, IsInf, IsNaN. (#14314) 2022-12-01 16:34:39 +04:00
tests_compatibility [CPU] New operations: IsFinite, IsInf, IsNaN. (#14314) 2022-12-01 16:34:39 +04:00
thirdparty Bump pybind11 to v2.10.1 release tag (#13793) 2022-11-04 02:12:47 +04:00
wheel Made OpenVINO cmake scripts Linux flavors agnostic (#14384) 2022-12-04 22:55:52 +04:00
.clang-format Rename runtime to src (#8842) 2021-11-27 11:28:25 +03:00
.gitignore [PyOV] Making offline_transformations a private module (#13213) 2022-09-28 18:38:52 +02:00
BUILDING.md [PYTHON] Align versions for subpackages, add get_version method for all subpackages (#12220) 2022-08-26 11:21:24 +03:00
CMakeLists.txt Added older pugixml version support (#14260) 2022-11-28 11:54:54 +04:00
README.md [PyOV] Add README.md and align structure-showing style (#14093) 2022-11-21 16:42:36 +01:00
pyproject.toml [PYTHON API] Check new config (#11402) 2022-06-13 10:21:04 +02:00
requirements.txt [Install] Remove upper bound for NumPy for default installation and update upper bounds for extras (#13985) 2022-11-30 09:53:06 +04:00
requirements_test.txt [PyOV] Bump pygments version (#13947) 2022-11-13 14:09:50 +01:00
setup.cfg [PyOV] Fix mypy after bump, general refactor (#13913) 2022-11-08 19:26:39 +04:00
setup.py Fixes for brew support on OSX (#13476) 2022-10-15 00:15:03 +03:00

README.md

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.
  • tests - tests directory for current API.
  • tests_compatibility - tests directory for compatibility 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:

See also