Added initial documentation version for Inference component (#13439)

This commit is contained in:
Ilya Churaev 2022-10-13 08:38:32 +04:00 committed by GitHub
parent 22bfd50b5f
commit 01d332eb59
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 49 additions and 57 deletions

View File

@ -35,7 +35,7 @@ flowchart LR
```
* [core](./core/README.md) is responsible for model representation, contains a set of supported OpenVINO operations and base API for model modification.
* [inference](./inference) provides the API for model inference on different accelerators.
* [inference](./inference/README.md) provides the API for model inference on different accelerators.
* Transformations:
* [common transformations](../src/common/transformations) - a set of common transformations which are used for model optimization
* [low precision transformations](../src/common/low_precision_transformations) - a set of transformations which are needed to optimize quantized models

View File

@ -1,28 +0,0 @@
BasedOnStyle: Google
IndentWidth: 4
UseTab: Never
ColumnLimit: 120
Language: Cpp
Standard: Cpp11
AccessModifierOffset: -4
AlignConsecutiveMacros: true
AllowAllArgumentsOnNextLine: false
AllowAllConstructorInitializersOnNextLine: false
AllowAllParametersOfDeclarationOnNextLine: false
AllowShortFunctionsOnASingleLine: Empty
AllowShortIfStatementsOnASingleLine: Never
AllowShortLambdasOnASingleLine: Empty
AllowShortLoopsOnASingleLine: false
AlwaysBreakBeforeMultilineStrings: false
BinPackArguments: false
BinPackParameters: false
CommentPragmas: '^#'
DerivePointerAlignment: false
FixNamespaceComments: true
IndentCaseLabels: false
IndentPPDirectives: AfterHash
ForEachMacros:
- foreach
- FOREACH_CHILD

25
src/inference/README.md Normal file
View File

@ -0,0 +1,25 @@
# 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 uses [the common coding style rules](../../docs/dev/coding_style.md).
## Key person
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.
## 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 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/).
## See also
* [OpenVINO™ README](../../README.md)
* [OpenVINO Core Components](../README.md)
* [Developer documentation](../../docs/dev/index.md)

View File

@ -1,28 +0,0 @@
BasedOnStyle: Google
IndentWidth: 4
UseTab: Never
ColumnLimit: 120
Language: Cpp
Standard: Cpp11
AccessModifierOffset: -4
AlignConsecutiveMacros: true
AllowAllArgumentsOnNextLine: false
AllowAllConstructorInitializersOnNextLine: false
AllowAllParametersOfDeclarationOnNextLine: false
AllowShortFunctionsOnASingleLine: Empty
AllowShortIfStatementsOnASingleLine: Never
AllowShortLambdasOnASingleLine: Empty
AllowShortLoopsOnASingleLine: false
AlwaysBreakBeforeMultilineStrings: false
BinPackArguments: false
BinPackParameters: false
CommentPragmas: '^#'
DerivePointerAlignment: false
FixNamespaceComments: true
IndentCaseLabels: false
IndentPPDirectives: AfterHash
ForEachMacros:
- foreach
- FOREACH_CHILD

View File

@ -0,0 +1,23 @@
# OpenVINO Inference API
OpenVINO Inference API contains two folders:
* [ie](../include/ie/) - is a 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
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.
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).
## 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).
## See also
* [OpenVINO™ Core README](../README.md)
* [OpenVINO™ README](../../../README.md)
* [Developer documentation](../../../docs/dev/index.md)