-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOCS: Developer documentation Inference component update (#13895)
* dev docs fixes * fix space * fix paragraphs
- Loading branch information
Showing
4 changed files
with
43 additions
and
41 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 README](../../README.md) | ||
* [OpenVINO Core Components](../README.md) | ||
* [Developer documentation](../../docs/dev/index.md) | ||
* [Developer Documentation](../../docs/dev/index.md) | ||
|
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