openvino/src/bindings/python
Ilya Lavrenov 00618a429b
Relocatable OpenVINO Dev package improvements (#20461)
2023-10-16 12:54:30 +04:00
..
docs Use FindPython3.cmake (#19847) 2023-09-26 20:57:29 +02:00
src Removed custom python usage in Azure pipelines (#20433) 2023-10-14 01:18:27 +04:00
tests [Opset13][pyAPI] Python API Multinomial-13 (#20400) 2023-10-13 10:50:02 +00:00
tests_compatibility Revert "[CI] [GHA] Skip `test_div_uint8_cpu` on macOS only; unskip `test_onnx/test_backend.py` in GHA workflows (#20367)" (#20402) 2023-10-12 03:00:14 +04:00
thirdparty Added a WA for running Python API in debug mode (#18848) 2023-07-28 17:29:09 +04:00
wheel Use RPATH instead of RUNPATH for wheel package (#20239) 2023-10-06 13:50:44 +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
CMakeLists.txt Relocatable OpenVINO Dev package improvements (#20461) 2023-10-16 12:54:30 +04:00
README.md [DOCS] Link adjustment for dev docs + fix to build.md CPU link for master (#17744) 2023-05-31 13:27:20 +04:00
constraints.txt Bump pytest-timeout from 2.1.0 to 2.2.0 in /src/bindings/python (#20310) 2023-10-15 03:14:14 +04:00
pyproject.toml [PYTHON API] Check new config (#11402) 2022-06-13 10:21:04 +02:00
requirements.txt Revert "Switch telemetry to opt-out approach. (#20290)" (#20370) 2023-10-10 22:08:20 +04:00
requirements_test.txt [PyOV] Add `sympy` dependency for torchvision preprocessor tests (#19112) 2023-08-11 12:03:59 +02:00
setup.cfg [PyOV] Add torchvision to OpenVINO preprocessing converter (#17934) 2023-08-02 16:44:30 +04: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