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.

Sign up for GitHub

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

Jump to bottom

Python Model API package: add main documentation #3268

Merged
merged 35 commits into from
Mar 3, 2022
Merged

Python Model API package: add main documentation #3268

merged 35 commits into from
Mar 3, 2022

Conversation

anzhella-pankratova
Copy link
Contributor

@anzhella-pankratova anzhella-pankratova commented Feb 21, 2022 •
edited
Loading

  • The documentation for the package is created. The main purpose of the model_api/README.md is providing a general overview of the package and its structure and the description of each component
  • The "Python* model API package" section in demos/README.md is updated
  • The readme for object_detection_demo.py is modified with Model API section (as the example, later this section will be copypasted to the other Model API demos readme's)

eaidova
eaidova reviewed Feb 21, 2022
View reviewed changes
demos/common/python/openvino/model_zoo/model_api/README.md Outdated

For OpenVINO Model Server Adapter employment, you need to install the requirements:
```sh
pip install <omz_dir>/demos/common/python/requirements_ovms.txt
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can it be done with extra modules in model api install?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-r missed in command

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can it be done with extra modules in model api install?

I'll investigate it

eaidova
eaidova reviewed Feb 21, 2022
View reviewed changes
demos/common/python/openvino/model_zoo/model_api/README.md Outdated
To study the complex scenarios, refer to [Open Model Zoo Python* demos](https://github.com/openvinotoolkit/open_model_zoo/tree/master/demos), where the asynchronous inference is applied.

The list of Open Model Zoo demos with Model API support:
- BERT Named Entity Recognition Python* Demo
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably it make sense to provide link on demo readme

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added links to the demos

@vladimir-dudnik
Copy link
Contributor

@anzhella-pankratova doc check failed

12:51:56 running documentation checks...
12:51:58 demos/common/python/openvino/model_zoo/model_api/README.md: non-local OMZ Repo reference "https://github.com/openvinotoolkit/open_model_zoo/tree/master/demos" (replace it by <omz_dir>/master/demos)
12:51:58 demos/common/python/openvino/model_zoo/model_api/README.md: non-local OMZ Repo reference "https://github.com/openvinotoolkit/open_model_zoo/tree/master/demos/bert_named_entity_recognition_demo/python" (replace it by <omz_dir>/master/demos/bert_named_entity_recognition_demo/python)
12:51:58 demos/common/python/openvino/model_zoo/model_api/README.md: non-local OMZ Repo reference "https://github.com/openvinotoolkit/open_model_zoo/tree/master/demos/bert_question_answering_demo/python" (replace it by <omz_dir>/master/demos/bert_question_answering_demo/python)
12:51:58 demos/common/python/openvino/model_zoo/model_api/README.md: non-local OMZ Repo reference "https://github.com/openvinotoolkit/open_model_zoo/tree/master/demos/bert_question_answering_embedding_demo/python" (replace it by <omz_dir>/master/demos/bert_question_answering_embedding_demo/python)
12:51:58 demos/common/python/openvino/model_zoo/model_api/README.md: non-local OMZ Repo reference "https://github.com/openvinotoolkit/open_model_zoo/tree/master/demos/classification_demo/python" (replace it by <omz_dir>/master/demos/classification_demo/python)
12:51:58 demos/common/python/openvino/model_zoo/model_api/README.md: non-local OMZ Repo reference "https://github.com/openvinotoolkit/open_model_zoo/tree/master/demos/deblurring_demo/python" (replace it by <omz_dir>/master/demos/deblurring_demo/python)
12:51:58 demos/common/python/openvino/model_zoo/model_api/README.md: non-local OMZ Repo reference "https://github.com/openvinotoolkit/open_model_zoo/tree/master/demos/human_pose_estimation_demo/python" (replace it by <omz_dir>/master/demos/human_pose_estimation_demo/python)
12:51:58 demos/common/python/openvino/model_zoo/model_api/README.md: non-local OMZ Repo reference "https://github.com/openvinotoolkit/open_model_zoo/tree/master/demos/instance_segmentation_demo/python" (replace it by <omz_dir>/master/demos/instance_segmentation_demo/python)
12:51:58 demos/common/python/openvino/model_zoo/model_api/README.md: non-local OMZ Repo reference "https://github.com/openvinotoolkit/open_model_zoo/tree/master/demos/monodepth_demo/python" (replace it by <omz_dir>/master/demos/monodepth_demo/python)
12:51:58 demos/common/python/openvino/model_zoo/model_api/README.md: non-local OMZ Repo reference "https://github.com/openvinotoolkit/open_model_zoo/tree/master/demos/object_detection_demo/python" (replace it by <omz_dir>/master/demos/object_detection_demo/python)
12:51:58 demos/common/python/openvino/model_zoo/model_api/README.md: non-local OMZ Repo reference "https://github.com/openvinotoolkit/open_model_zoo/tree/master/demos/segmentation_demo/python" (replace it by <omz_dir>/master/demos/segmentation_demo/python)

@Wovchena Wovchena requested a review from nignatovsky February 24, 2022 16:55
@anzhella-pankratova
Copy link
Contributor Author

Jenkins please retry a build

@vladimir-dudnik vladimir-dudnik merged commit e315f1d into openvinotoolkit:master Mar 3, 2022
@anzhella-pankratova anzhella-pankratova deleted the model_api_documentation branch March 4, 2022 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vladimir-dudnik vladimir-dudnik vladimir-dudnik approved these changes

@Wovchena Wovchena Wovchena approved these changes

@eaidova eaidova eaidova left review comments

@ivikhrev ivikhrev ivikhrev approved these changes

@fzhar fzhar Awaiting requested review from fzhar

@akorobeinikov akorobeinikov Awaiting requested review from akorobeinikov

@VoronovaIntern VoronovaIntern Awaiting requested review from VoronovaIntern

@ntyukaev ntyukaev Awaiting requested review from ntyukaev

@andrew-zaytsev andrew-zaytsev Awaiting requested review from andrew-zaytsev

@nignatovsky nignatovsky Awaiting requested review from nignatovsky

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@anzhella-pankratova @vladimir-dudnik @Wovchena @eaidova @ivikhrev