Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python Model API package: add main documentation #3268

Merged
Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
853599a
add documentation to Model API
anzhella-pankratova Feb 18, 2022
cb9aabe
add readme.md
anzhella-pankratova Feb 18, 2022
e88ecb8
fix spelling
anzhella-pankratova Feb 21, 2022
70cf732
add Model API section to object_detection_demo readme
anzhella-pankratova Feb 21, 2022
94ffd56
remove extra whitespace
anzhella-pankratova Feb 21, 2022
71c9f9a
add bullet points
anzhella-pankratova Feb 21, 2022
e1320e4
Apply suggestions
anzhella-pankratova Feb 21, 2022
d581e16
modify the usage example
anzhella-pankratova Feb 21, 2022
c6bd178
Modify documentation
anzhella-pankratova Feb 22, 2022
b5739fd
add extra module
anzhella-pankratova Feb 24, 2022
8701286
don't check relative links for Model API package
anzhella-pankratova Feb 24, 2022
8cca162
update check-documentation.py
anzhella-pankratova Feb 24, 2022
4b5d7fa
prepare-documentation for Python Model API
anzhella-pankratova Feb 24, 2022
325e4bf
suggestions
anzhella-pankratova Feb 25, 2022
29d247b
move the list of supported demos to demos/README.md
anzhella-pankratova Feb 25, 2022
36eb8a9
remove list of demos, remove statement in documentation
anzhella-pankratova Feb 28, 2022
41398d2
add documentation to Model API
anzhella-pankratova Feb 18, 2022
94d3976
add readme.md
anzhella-pankratova Feb 18, 2022
3ec58fc
fix spelling
anzhella-pankratova Feb 21, 2022
6ff38da
add Model API section to object_detection_demo readme
anzhella-pankratova Feb 21, 2022
0b5e278
remove extra whitespace
anzhella-pankratova Feb 21, 2022
a0ac903
add bullet points
anzhella-pankratova Feb 21, 2022
3951fb2
Apply suggestions
anzhella-pankratova Feb 21, 2022
a78852d
modify the usage example
anzhella-pankratova Feb 21, 2022
6a8144a
Modify documentation
anzhella-pankratova Feb 22, 2022
31bf4d7
add extra module
anzhella-pankratova Feb 24, 2022
f543d57
don't check relative links for Model API package
anzhella-pankratova Feb 24, 2022
a4adf83
update check-documentation.py
anzhella-pankratova Feb 24, 2022
ee53da8
prepare-documentation for Python Model API
anzhella-pankratova Feb 24, 2022
ede0f45
suggestions
anzhella-pankratova Feb 25, 2022
19872b1
move the list of supported demos to demos/README.md
anzhella-pankratova Feb 25, 2022
384c1d9
remove list of demos, remove statement in documentation
anzhella-pankratova Feb 28, 2022
e1217b4
OMZ models instead of architectures, OV supported Python instead cert…
vladimir-dudnik Mar 1, 2022
52ed496
pull recent changes
anzhella-pankratova Mar 2, 2022
06d0e99
remove python in documentation, update package structure section
anzhella-pankratova Mar 2, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
OMZ models instead of architectures, OV supported Python instead cert…
…ain versions
  • Loading branch information
vladimir-dudnik committed Mar 1, 2022
commit e1217b4206cacd9e4b5b36222b747f260e09c8a1
8 changes: 4 additions & 4 deletions demos/common/python/openvino/model_zoo/model_api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ An application feeds model class with input data, then the model returns postpro

The Python* Model API consists of 3 libraries:
ivikhrev marked this conversation as resolved.
Show resolved Hide resolved
* _adapters_ implements a common interface to allow Model API wrappers usage with different executors: OpenVINO, OVMS. See [Model API adapters](#model-api-adapters) section
ivikhrev marked this conversation as resolved.
Show resolved Hide resolved
* _models_ implements wrappers for each architecture. See [Model API Wrappers](#model-api-wrappers) section
* _models_ implements wrappers for Open Model Zoo models. See [Model API Wrappers](#model-api-wrappers) section
* _pipelines_ implements pipelines for model inference and manage the synchronous/asynchronous execution. See [Model API Pipelines](#model-api-pipelines) section

### Prerequisites

The package requires
- Python (version 3.6 or higher)
- one of OpenVINO supported Python version (see OpenVINO documentation for the details)
- OpenVINO™ toolkit
Wovchena marked this conversation as resolved.
Show resolved Hide resolved

If you build Python* Model API package from source, you should install the OpenVINO™ toolkit. See the options:
Expand Down Expand Up @@ -66,7 +66,7 @@ The following tasks can be solved with wrappers usage:
| Instance Segmentation | <ul><li>`MaskRCNNModel`</li><li>`YolactModel`</li></ul> |
| Monocular Depth Estimation | <ul><li> `MonoDepthModel`</li></ul> |
| Named Entity Recognition | <ul><li>`BertNamedEntityRecognition`</li></ul> |
| Object Detection | <ul><li>`CenterNet`</li><li>`DETR`</li><li>`CTPN`</li><li>`FaceBoxes`</li><li>`RetinaFace`</li><li>`RetinaFacePyTorch`</li><li>`SSD`</li><li>`UltraLightweightFaceDetection`</li><li>`YOLO`</li><li>`YoloV3ONNX`</li><li>`YoloV4`</li><li>`YOLOF`</li><li>`YOLOX`</li></ul> |
| Object Detection | <ul><li>`CenterNet`</li><li>`DETR`</li><li>`CTPN`</li><li>`FaceBoxes`</li><li>`RetinaFace`</li><li>`RetinaFacePyTorch`</li><li>`SSD`</li><li>`UltraLightweightFaceDetection`</li><li>`YOLO`</li><li>`YoloV3ONNX`</li><li>`YoloV4`</li><li>`YOLOF`</li><li>`YOLOX`</li></ul> |
| Question Answering | <ul><li>`BertQuestionAnswering`</li></ul> |
| Salient Object Detection | <ul><li>`SalientObjectDetectionModel`</li></ul> |
| Semantic Segmentation | <ul><li>`SegmentationModel`</li></ul> |
Expand All @@ -88,7 +88,7 @@ It accepts a path to either `xml` model file or `onnx` model file.

Refer to __[`OVMSAdapter`](adapters/ovms_adapter.md)__ to learn about running demos with OVMS.

For OpenVINO Model Server Adapter employment, you need to install the package with extra module:
For using OpenVINO Model Server Adapter you need to install the package with extra module:
```sh
pip install <omz_dir>/demos/common/python[ovms]
```
Expand Down