Create README.md for AUTO plugin (#14861)
* Create README.md for AUTO plugin * link to contribuation guidance * Update README.md according to developer documentation guidance * Update for comments * Update components for review comments * Update folder for review comments * update for wording * update for comments
This commit is contained in:
parent
78995e9ac2
commit
413a461be4
51
src/plugins/auto/README.md
Normal file
51
src/plugins/auto/README.md
Normal file
@ -0,0 +1,51 @@
|
||||
# OpenVINO™ AUTO Plugin
|
||||
|
||||
The main responsibility of the AUTO plugin is to provide a unified device that enables developers to code deep learning applications once and deploy them anywhere.
|
||||
|
||||
Other capabilities of the AUTO plugin include:
|
||||
* Static device selection, which intelligently loads a network to one device or multiple devices.
|
||||
* CPU acceleration to start inferencing while the target device is still loading the network.
|
||||
* Model priority support for loading multiple networks to multiple devices.
|
||||
|
||||
The component is written in `C++`. If you want to contribute to the AUTO plugin, follow [the common coding style rules](../../../docs/dev/coding_style.md).
|
||||
|
||||
## Key contacts
|
||||
|
||||
In case of any questions, review and merge requests, contact the [AUTO Plugin maintainer group](https://github.com/orgs/openvinotoolkit/teams/openvino-ie-auto-multi-maintainers).
|
||||
|
||||
## Components
|
||||
|
||||
The AUTO plugin follows the OpenVINO™ plugin architecture and consists of several main components:
|
||||
* [docs](./docs) contains developer documentation for the AUTO plugin.
|
||||
* [current](./) folder contains sources of the AUTO plugin.
|
||||
|
||||
Learn more in the [OpenVINO™ Plugin Developer Guide](https://docs.openvino.ai/latest/openvino_docs_ie_plugin_dg_overview.html).
|
||||
|
||||
## Architecture
|
||||
The diagram below shows an overview of the components responsible for the basic inference flow:
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
|
||||
subgraph Application["Application"]
|
||||
end
|
||||
|
||||
subgraph OpenVINO Runtime["OpenVINO Runtime"]
|
||||
AUTO["AUTO Plugin"] --> CPU["CPU Plugin"]
|
||||
AUTO["AUTO Plugin"] --> GPU["GPU Plugin"]
|
||||
end
|
||||
|
||||
Application --> AUTO
|
||||
|
||||
style Application fill:#6c9f7f
|
||||
```
|
||||
Find more details in the [AUTO Plugin architecture](./docs/architecture.md) document.
|
||||
|
||||
## Tutorials
|
||||
* [Testing the AUTO Plugin](./docs/tests.md)
|
||||
* [Integrating a new hardware plugin with the AUTO plugin](./docs/integration.md)
|
||||
|
||||
## See also
|
||||
* [OpenVINO™ README](../../../README.md)
|
||||
* [OpenVINO Core Components](../../README.md)
|
||||
* [Developer documentation](../../../docs/dev/index.md)
|
8
src/plugins/auto/docs/architecture.md
Normal file
8
src/plugins/auto/docs/architecture.md
Normal file
@ -0,0 +1,8 @@
|
||||
# AUTO Plugin Architecture
|
||||
|
||||
TBD-100527
|
||||
|
||||
## See also
|
||||
* [AUTO Plugin README](../README.md)
|
||||
* [OpenVINO™ README](../../../../README.md)
|
||||
* [Developer documentation](../../../../docs/dev/index.md)
|
5
src/plugins/auto/docs/integration.md
Normal file
5
src/plugins/auto/docs/integration.md
Normal file
@ -0,0 +1,5 @@
|
||||
# AUTO Plugin Integration
|
||||
|
||||
## How to integrate a new hardware plugin
|
||||
|
||||
TBD-100527
|
9
src/plugins/auto/docs/tests.md
Normal file
9
src/plugins/auto/docs/tests.md
Normal file
@ -0,0 +1,9 @@
|
||||
# AUTO Plugin tests
|
||||
|
||||
## AUTO plugin testing places
|
||||
|
||||
TBD-100527
|
||||
|
||||
## How to run tests
|
||||
|
||||
TBD-100527
|
Loading…
Reference in New Issue
Block a user