openvino/src/bindings/python
Anastasia Kuporosova 771fdc3d1c
remove old py api from python snippets and docs (#22016)
* remove old api from python snippets and docs (#170)

* remove old api from python snippets

* pysnippets removal p2

* remove ngraph snippet

* remove old api from docs

* remove migration snippets

* remove from init
2024-01-08 16:34:07 +01:00
..
docs [PyOV] Delete compatibility tests (#21820) 2023-12-22 17:13:21 +01:00
src [DOCS] Hyperlink 23.3 update for master (#21908) 2024-01-08 12:40:54 +01:00
tests Remove more GNA related code (#21826) 2023-12-27 16:09:22 +00:00
thirdparty Added a WA for running Python API in debug mode (#18848) 2023-07-28 17:29:09 +04:00
wheel [DOCS] Moving files to new location for master (#21575) 2023-12-12 16:27:01 +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 [DOCS] Moving files to new location for master (#21575) 2023-12-12 16:27:01 +04:00
README.md remove old py api from python snippets and docs (#22016) 2024-01-08 16:34:07 +01:00
constraints.txt [ONNX] Switched to ONNX 1.15.0 (#20929) 2023-12-19 18:55:32 +00:00
pyproject.toml [PYTHON API] Check new config (#11402) 2022-06-13 10:21:04 +02:00
requirements.txt Switching telemetry to opt-out and disabling telemetry in CI jobs (#20391) 2023-10-19 15:26:21 +04:00
requirements_test.txt [PyOV] ngraph linter check update (#20870) 2023-11-07 10:42:46 +00:00
setup.cfg [PyOV] Delete compatibility tests (#21820) 2023-12-22 17:13:21 +01: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 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:

See also