[Docs][PyOV] Documentation for Custom Python Operation #25615
+167
−22
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
akuporos
force-pushed
the
akup/custom-op-docs
branch
from
073084e to
e0f40f9
Compare
p-wysocki
approved these changes
Jul 18, 2024
akuporos
commented
Jul 22, 2024
docs/articles_en/documentation/openvino-extensibility/custom-openvino-operations.rst
Outdated
Show resolved
Hide resolved
…penvino-operations.rst
akuporos
commented
Jul 22, 2024
kblaszczak-intel
approved these changes
Jul 25, 2024
akuporos
commented
Jul 30, 2024
Co-authored-by: Karol Blaszczak <karol.blaszczak@intel.com>
akuporos
commented
Jul 30, 2024
akuporos
force-pushed
the
akup/custom-op-docs
branch
from
638910e to
1c4732f
Compare
akuporos
commented
Aug 5, 2024
| OpenVINO™ Extension API allows you to register custom operations to support models with operations which OpenVINO™ does not support out-of-the-box. This capability requires writing code in C++, so if you are using Python to develop your application you need to build a separate shared library implemented in C++ first and load it in Python using ``add_extension`` API. Please refer to :ref:`Create library with extensions <create_a_library_with_extensions>` for more details on library creation and usage. The remaining part of this document describes how to implement an operation class. | ||
| OpenVINO™ Extension API allows you to register custom operations to support models with operations which OpenVINO™ does not support out-of-the-box. While this process historically involved writing C++ code and constructing a separate shared library to be subsequently loaded into Python using the ``add_extension`` API, it is now also possible to implement custom operations directly within the Python API with some known limitations. Operations implemented in python still won't be loaded into the runtime and may be used for building your own Model. | ||
|
|
||
| For those who still wish to use C++, the capability to create a shared library with custom operation implementations is maintained. Please refer to :ref:`Create library with extensions <create_a_library_with_extensions>` for more details on library creation and usage. The remaining part of this document describes how to implement an operation class using both the C++ API and Python API. |
There was a problem hiding this comment.
Suggested change
| For those who still wish to use C++, the capability to create a shared library with custom operation implementations is maintained. Please refer to :ref:`Create library with extensions <create_a_library_with_extensions>` for more details on library creation and usage. The remaining part of this document describes how to implement an operation class using both the C++ API and Python API. | |
| For those who wish to use C++, the capability to create a shared library with custom operation implementations is available. Please refer to :ref:`Create library with extensions <create_a_library_with_extensions>` for more details on library creation and usage. The remaining part of this document describes how to implement an operation class using both the C++ API and Python API. |
akuporos
commented
Aug 5, 2024
docs/articles_en/documentation/openvino-extensibility/custom-openvino-operations.rst
Outdated
Show resolved
Hide resolved
|
This PR will be closed in a week because of 2 weeks of no activity. |
|
Is there anything I can do to help publish this PR? |
…penvino-operations.rst Co-authored-by: Anastasia Kuporosova <anastasia.kuporosova@intel.com>
|
This PR will be closed in a week because of 2 weeks of no activity. |
|
This PR will be closed in a week because of 2 weeks of no activity. |
|
This PR will be closed in a week because of 2 weeks of no activity. |
|
Hey everyone, can we finalize this one? It has been hanging for a while and Anastasia did a lot of good work here, would be a shame to let it go to waste. Even if it is not perfect, maybe we could go through with some polishing, merge, publish, and then continue improving in a separate PR? |
|
Hi @kblaszczak-intel , I'd like to complete this PR first, and then return back to this one. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Details:
Tickets: