1910f42179
* [C API DOC] add c api docs Signed-off-by: xuejun <Xuejun.Zhai@intel.com> * Update OpenVINO_Runtime_C_API_User_Guide.md Add mapping relationship about C++ API 2.0 and C API * [C API][DG] Add some roles for developping C API Signed-off-by: xuejun <Xuejun.Zhai@intel.com> * [C API DOC][DG] Implement the developer guide Signed-off-by: xuejun <Xuejun.Zhai@intel.com> * [C API DOC][DG] Fix comments Signed-off-by: xuejun <Xuejun.Zhai@intel.com> * [C API DOC][DG] Fix format issue Signed-off-by: xuejun <Xuejun.Zhai@intel.com> * [C API][DG] Fix review issues including add reference link, clear description Signed-off-by: xuejun <Xuejun.Zhai@intel.com> * [C API][DOC] Fix review comments Signed-off-by: xuejun <Xuejun.Zhai@intel.com> * [C API][DOC] remove the mapping relationship of interface & object Signed-off-by: xuejun <Xuejun.Zhai@intel.com> * [C API][DOC] Fix review comments Signed-off-by: xuejun <Xuejun.Zhai@intel.com> * [C API][DOC] add descriptions for unit test Signed-off-by: xuejun <Xuejun.Zhai@intel.com> Signed-off-by: xuejun <Xuejun.Zhai@intel.com>
OpenVINO C API
OpenVINO C API is a key part of the OpenVINO extension for C API users. This component provides C API for OpenVINO Toolkit.
flowchart LR
c_application[("C Application")]
openvino_c{{openvino::c}}
openvino{{openvino}}
style c_application fill:#427cb0
style openvino_c fill:#6c9f7f
style openvino fill:#6c9f7f
c_application-->openvino_c-->openvino
OpenVINO C API uses the common coding style rules.
Key contacts
People from the openvino-c-api-maintainers group have the rights to approve and merge PRs to the C API component. They can assist with any questions about C API component.
Components
OpenVINO C API has the following structure:
- docs contains developer documentation for OpenVINO C APIs.
- include contains all provided C API headers. Learn more.
- src contains the implementations of all C APIs.
- tests contains all tests for OpenVINO C APIs. Learn more.
Note
: Using API 2.0 is strongly recommended. Legacy API (for C) header file, source file, unit test are also included in the component, but the legacy API is no longer extended.
Tutorials
- How to integrate OpenVINO C API with Your Application
- How to wrap OpenVINO objects with C
- How to wrap OpenVINO interfaces with C
- Samples implemented by OpenVINO C API
- How to debug C API issues
- How to write unit test
How to contribute to the OpenVINO repository
See CONTRIBUTING for details.