IntenseWebs/openvino
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

DOCS: Developer documentation Inference component update (#13895)

Browse Source 
* dev docs fixes

* fix space

* fix paragraphs
This commit is contained in:
Tatiana Savina 2022-11-08 04:42:10 +01:00 committed by GitHub
parent e1f014ac15
commit 07a0ff58f2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 44 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/dev/get_started.md
View File

@ -1,17 +1,18 @@
# Get started
Welcome to the OpenVINO Developer guides. These documents teach you how to build OpenVINO, provide the general ideas about OpenVINO architecture and help to start contribution to OpenVINO.
Welcome to the OpenVINO Developer guides. These documents describe how to build OpenVINO, provide general ideas about its architecture and help you start contributing to OpenVINO.
If you're brand new to OpenVINO and want to jump into code, start with the [Build OpenVINO guilde](./build.md).
If you're brand new to OpenVINO and want to jump right into code, start with the [Build OpenVINO guide](./build.md).
Explore other resources to learn more about OpenVINO:
And check out these other resources to get more infromation about OpenVINO:
* [OpenVINO official user documentation](https://docs.openvino.ai/)
* [OpenVINO repository structure](./intex.md#openvino-repository-structure)
* [OpenVINO repository structure](./index.md#openvino-repository-structure)
* [OpenVINO core components](../../src/README.md)
* [OpenVINO contribution guideline](../../CONTRIBUTING.md)
* [OpenVINO contributing guidelines](../../CONTRIBUTING.md)
* [OpenVINO conditional compilation](./conditional_compilation.md)
* [OpenVINO Tutorials](../../README.md#tutorials)
## See also
* [OpenVINO Developer documentation](./index.md)
* [OpenVINO Developer Documentation](./index.md)
* [OpenVINO Samples](../../samples)

34
docs/dev/index.md
View File

@ -1,8 +1,8 @@
# OpenVINO™ Developer Documentation
Welcome to the OpenVINO™ Toolkit Developer Documentation. This documentation helps to deeper understand the ideology of OpenVINO, provides the complete information about ideas which are applied inside.
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™ Toolkit provides a functionality to load model from different frameworks and run it on different accelerators.
The OpenVINO™ provides a functionality to load models from different frameworks and run them on different accelerators.
```mermaid
flowchart LR
@ -54,7 +54,7 @@ flowchart LR
openvino--infer--->auto
```
## [Get started](./get_started.md)
## [Get Started](./get_started.md)
* [Build OpenVINO](./build.md)
* How to:
@ -62,15 +62,14 @@ flowchart LR
* [Add new transformation](#todo)
* [Get code coverage report](./test_coverage.md)
* [Add component developer documentation](./dev_doc_guide.md)
* [OpenVINO contribution guideline](../../CONTRIBUTING.md)
* [OpenVINO Debug Capabilities](./debug_capabilities.md)
* [OpenVINO contributing guidelines](../../CONTRIBUTING.md)
* [OpenVINO debug capabilities](./debug_capabilities.md)
## OpenVINO repository structure
## OpenVINO Repository Structure
The repository is organized in such a way that the components contain all dependencies inside (for example, thirdparty, tests, documentation, and other).
With this approach, groups of developers, who are concentrated on different components, can efficiently work together.
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 compositions from next components, click on the component name to get more information about it:
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
@ -82,7 +81,7 @@ The OpenVINO Repository compositions from next components, click on the componen
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
tests/ // Infrastructure tests which validate full pipelines
thirdparty/ // Common third-party dependencies
tools/ // OpenVINO tools
</code>
@ -90,19 +89,19 @@ The OpenVINO Repository compositions from next components, click on the componen
### OpenVINO Component Structure
The OpenVINO component should contain all dependencies inside (for example, thirdparty, tests, documentation, and other). The abstract component structure with comments and marks for optional folders is presented below.
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 which are related only for this component
dev_api/ // (optional) Developer API is used in case if component wants to provide some API for internal developers
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 on the component
tests/ // Tests for the component
thirdparty/ // (optional) Third-party dependencies
CMakeLists.txt // Main CMake script
README.md // (optional) Endtry point for the developer documentation
README.md // (optional) Entry point for the developer documentation
```
@ -110,5 +109,6 @@ ov_component/ // Component folder
* [Conditional Compilation](./conditional_compilation.md)
## See also
* [OpenVINO™ README](../../README.md)
## See Also
* [OpenVINO README](../../README.md)

25
src/inference/README.md
View File

@ -1,25 +1,26 @@
# OpenVINO™ Inference
OpenVINO Inference is a part of OpenVINO Runtime library.
The component is responsible for model inference on hardware device, provides API for OpenVINO Plugin development.
OpenVINO Inference is a part of the OpenVINO Runtime library.
The component is responsible for model inference on hardware devices and provides API for OpenVINO Plugin development.
OpenVINO Inference uses [the common coding style rules](../../docs/dev/coding_style.md).
## Key person
## Key contacts
People from the [openvino-ie-maintainers](https://github.com/orgs/openvinotoolkit/teams/openvino-ie-maintainers) allows to approve and merge PRs to the inference component. These guys can help in case of any questions about the component.
People from the [openvino-ie-maintainers](https://github.com/orgs/openvinotoolkit/teams/openvino-ie-maintainers) group have the rights to approve and merge PRs to the inference component. They can assist with any questions about the component.
## Components
OpenVINO Inference has the next structure:
* [dev_api](./dev_api) contains developer API which is needed to develop OpenVINO Plugins. In order to use this API, you need to link your component against `openvino::runtime::dev`.
* [include](./include) contains public API. Detailed information about provided API can be found [here](./docs/api_details.md).
* [src](./src) folder contains sources of the component.
OpenVINO Inference has the following structure:
* [dev_api](./dev_api) contains developer API required to develop OpenVINO Plugins. To use this API, link your component against `openvino::runtime::dev`.
* [include](./include) contains public API. Find more information in the [OpenVINO Inference API](./docs/api_details.md) document.
* [src](./src) contains sources of the component.
OpenVINO Inference has unit and functional tests. Unit tests are located in [src/tests/unit/inference_engine](../tests/unit/inference_engine/), functional tests locates [src/tests/functional/inference_engine](../tests/functional/inference_engine/).
OpenVINO Inference has unit and functional tests. Unit tests are located in [src/tests/unit/inference_engine](../tests/unit/inference_engine/), functional tests are located in [src/tests/functional/inference_engine](../tests/functional/inference_engine/).
## See also
* [OpenVINO™ README](../../README.md)
* [OpenVINO Core Components](../README.md)
* [Developer documentation](../../docs/dev/index.md)
* [OpenVINO README](../../README.md)
* [OpenVINO Core Components](../README.md)
* [Developer Documentation](../../docs/dev/index.md)

14
src/inference/docs/api_details.md
View File

@ -1,20 +1,20 @@
# OpenVINO Inference API
OpenVINO Inference API contains two folders:
* [ie](../include/ie/) - is a legacy API, this API is no longer being developed.
* [ie](../include/ie/) - legacy API, this API is no longer being developed,
* [openvino](../include/openvino/) - current public API, this part is described below.
## Components of public OpenVINO Inference API
## Components of Public OpenVINO Inference API
Public OpenVINO Inference API defines global header [openvino/openvino.hpp](../include/openvino/openvino.hpp) what includes all common OpenVINO headers.
All Inference components are concentrated inside the [openvino/runtime](../include/openvino/runtime) folder.
Public OpenVINO Inference API defines global header [openvino/openvino.hpp](../include/openvino/openvino.hpp) which includes all common OpenVINO headers.
All Inference components are placed inside the [openvino/runtime](../include/openvino/runtime) folder.
To get more information about using of Inference API please read [How to integrate OpenVINO with your application](https://docs.openvino.ai/nightly/openvino_docs_OV_UG_Integrate_OV_with_your_application.html).
Also the diagram of dependencies is presented on the [OpenVINO Architecture page](../../docs/architecture.md#openvino-inference-pipeline).
To learn more about the Inference API usage, read [How to integrate OpenVINO with your application](https://docs.openvino.ai/nightly/openvino_docs_OV_UG_Integrate_OV_with_your_application.html).
The diagram with dependencies is presented on the [OpenVINO Architecture page](../../docs/architecture.md#openvino-inference-pipeline).
## Components of OpenVINO Developer API
OpenVINO Developer API is needed for OpenVINO plugin development. This process is detailed explained in the [OpenVINO Plugin Development Guide](https://docs.openvino.ai/nightly/openvino_docs_ie_plugin_dg_overview.html).
OpenVINO Developer API is required for OpenVINO plugin development. This process is described in the [OpenVINO Plugin Development Guide](https://docs.openvino.ai/nightly/openvino_docs_ie_plugin_dg_overview.html).
## See also
* [OpenVINO™ Core README](../README.md)