bf5b7a5fec
* Add developer guide for conditional compilation Change-Id: If769ce1afc045e678b5816ed6ae903ba48a5a320 * Use reference to real code as example Change-Id: I21f6aa47dfdf4ab7e92424a3ccc3d7524cc4b762 * Add table for macros Change-Id: I9503d801ebe67ea5c6e525e02a21a7295ba56bc6 * Update for more clear description Change-Id: I83b39f4a2462fb47ad1537e9747a2bb4a031dab9 * Use refer link replace code snippet Change-Id: I5e63302718ab02eb4bd7a28ae994c8e5e26e0e02 * Add README.md for CC Change-Id: I90abe73297deb5f55f219c15b093a02a30f9e8b5 * Update README.md Change-Id: I8199252cb24fdacba16ea8b9fac63f6f47e4f1e3 * Add link list to doc Change-Id: Id9a512cf8998cf18795cc0ac096fbbf89b28941c
116 lines
4.1 KiB
Markdown
116 lines
4.1 KiB
Markdown
# OpenVINO™ Developer Documentation
|
|
|
|
Welcome to the OpenVINO™ Developer Documentation. This documentation helps deeper understand the OpenVINO architecture and gives detailed information on the concepts and ideas used inside.
|
|
|
|
The OpenVINO™ provides a functionality to load models from different frameworks and run them on different accelerators.
|
|
|
|
```mermaid
|
|
flowchart LR
|
|
subgraph models [Models]
|
|
ir[("IR (*.xml)")]
|
|
onnx[("ONNX (*.onnx)")]
|
|
paddle[("PaddlePaddle (*.pdmodel)")]
|
|
tf[("Tensorflow (*.pb)")]
|
|
|
|
style ir fill:#427cb0
|
|
style onnx fill:#427cb0
|
|
style paddle fill:#427cb0
|
|
style tf fill:#427cb0
|
|
|
|
style models fill:#aeb6ba
|
|
|
|
click onnx "https://github.com/onnx/onnx"
|
|
end
|
|
|
|
mo{{Model Optimizer}}
|
|
|
|
style mo fill:#6c9f7f
|
|
|
|
onnx--convert--->mo
|
|
paddle--convert--->mo
|
|
tf--convert--->mo
|
|
mo--->ir
|
|
|
|
subgraph plugins [OV Plugins]
|
|
auto(["AUTO"])
|
|
cpu(["Intel_CPU"])
|
|
gpu(["Intel_GPU"])
|
|
end
|
|
subgraph frontends [OV Frontends]
|
|
ir_fe["IR Frontend"]
|
|
onnx_fe["ONNX Frontend"]
|
|
paddle_fe["Paddle Frontend"]
|
|
end
|
|
openvino(openvino library)
|
|
ir--Read ir---ir_fe
|
|
onnx--Read onnx--- onnx_fe
|
|
paddle--Read paddle---paddle_fe
|
|
ir_fe--->openvino
|
|
onnx_fe--->openvino
|
|
paddle_fe--->openvino
|
|
|
|
openvino--infer--->cpu
|
|
openvino--infer--->gpu
|
|
openvino--infer--->auto
|
|
```
|
|
|
|
## [Get Started](./get_started.md)
|
|
|
|
* [Build OpenVINO](./build.md)
|
|
* How to:
|
|
* [Add new operation](../../src/core/docs/operation_enabling_flow.md)
|
|
* [Add new conditional compilation](../../src/common/conditional_compilation/docs/develop_cc_for_new_component.md)
|
|
* [Add new transformation](#todo)
|
|
* [Get code coverage report](./test_coverage.md)
|
|
* [Add component developer documentation](./dev_doc_guide.md)
|
|
* [OpenVINO contributing guidelines](../../CONTRIBUTING.md)
|
|
* [OpenVINO debug capabilities](./debug_capabilities.md)
|
|
|
|
## OpenVINO Repository Structure
|
|
|
|
The repository is organized in such a way that the components contain all dependencies (for example, third-party, tests, documentation, and others).
|
|
|
|
The OpenVINO Repository includes the following components. Click on the component name to get more information:
|
|
<pre>
|
|
<code>
|
|
<a href="../../README.md">openvino/</a> // OpenVINO Repository
|
|
.ci/ // CI settings for Azure
|
|
.github/ // Github actions and PR templates
|
|
cmake/ // Global CMake scripts
|
|
docs/ // OpenVINO documentation
|
|
licensing/ // Licenses
|
|
samples/ // OpenVINO samples
|
|
scripts/ // Helper scripts
|
|
<a href="../../src/README.md">src/</a> // Folder with core OpenVINO components
|
|
tests/ // Infrastructure tests which validate full pipelines
|
|
thirdparty/ // Common third-party dependencies
|
|
tools/ // OpenVINO tools
|
|
</code>
|
|
</pre>
|
|
|
|
### OpenVINO Component Structure
|
|
|
|
The OpenVINO component contains all dependencies (for example, third-party, tests, documentation, and others). An example component structure with comments and marks for optional folders is presented below.
|
|
|
|
```
|
|
ov_component/ // Component folder
|
|
cmake/ // (optional) CMake scripts that are related only to this component
|
|
dev_api/ // (optional) Developer API is used when the component provides API for internal developers
|
|
docs/ // (optional) Contains detailed component documentation
|
|
include/ // (optional) Public component API
|
|
src/ // Sources of the component
|
|
tests/ // Tests for the component
|
|
thirdparty/ // (optional) Third-party dependencies
|
|
CMakeLists.txt // Main CMake script
|
|
README.md // (optional) Entry point for the developer documentation
|
|
```
|
|
|
|
|
|
## Features
|
|
|
|
* [Conditional Compilation](./conditional_compilation.md)
|
|
|
|
## See Also
|
|
|
|
* [OpenVINO README](../../README.md)
|