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
Show file tree
Hide file tree
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
add documentation to Model API
  • Loading branch information
anzhella-pankratova authored and vladimir-dudnik committed Mar 1, 2022
commit 41398d2640643487e3c52fe6c95c9d1e8c32724c
30 changes: 1 addition & 29 deletions demos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -276,35 +276,7 @@ cmake -A x64 <open_model_zoo>/demos

### <a name="model_api_installation"></a>Python\* model API installation

Python Model API with model wrappers and pipelines can be installed as a part of OpenVINO&trade; toolkit or from source.
Installation from source is as follows:

1. Install Python (version 3.6 or higher), [setuptools](https://pypi.org/project/setuptools/):

2. Build the wheel with the following command:

```sh
python <omz_dir>/demos/common/python/setup.py bdist_wheel
```
The built wheel should appear in the dist folder;
Name example: `openmodelzoo_modelapi-0.0.0-py3-none-any.whl`

3. Install the package in the clean environment with `--force-reinstall` key:
```sh
python -m pip install openmodelzoo_modelapi-0.0.0-py3-none-any.whl --force-reinstall
```
Alternatively, instead of building the wheel you can use the following command inside `<omz_dir>/demos/common/python/` directory to build and install the package:
```sh
python -m pip install .
```

When the model API package is installed, you can import it as follows:
```sh
python -c "from openvino.model_zoo import model_api"
```

> **NOTE**: On Linux and macOS, you may need to type `python3` instead of `python`. You may also need to [install pip](https://pip.pypa.io/en/stable/installation/).
> For example, on Ubuntu execute the following command to get pip installed: `sudo apt install python3-pip`.
To run Python demo applications, you need to install the Python Model API package. Refer to [Python Model API documentation](common/python/openvino/model_zoo/model_api/README.md#building-python*-model-api-package) to learn about its installation.

### <a name="build_python_extensions"></a>Build the Native Python\* Extension Modules

Expand Down
1 change: 1 addition & 0 deletions demos/common/python/requirements_openvino.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
openvino-dev
eaidova marked this conversation as resolved.
Show resolved Hide resolved