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

PyPi install guides improvements #5756

Merged

Conversation

slyubimt
Copy link
Contributor

Details:

  • Human rights notice
  • Components descriptions update & console scripts
  • Extras requirements definition
  • Change verification step to Model Optimizer call

Tickets:

  - Human rights notice
  - Components descriptions update & console scripts
  - Extras requirements definition
  - Change verification step to Model Optimizer call
@openvino-pushbot openvino-pushbot added the category: docs OpenVINO documentation label May 24, 2021
@slyubimt
Copy link
Contributor Author

@helena-intel , @ryanloney You do not mind if we add a link to OpenVINO™ Notebooks in Additional Resources? This will provide a quick start for OpenVINO Python API users.

@helena-intel
Copy link
Contributor

@helena-intel , @ryanloney You do not mind if we add a link to OpenVINO™ Notebooks in Additional Resources? This will provide a quick start for OpenVINO Python API users.

I think that is useful indeed, thanks! A minor note: our README also covers installing openvino-dev, so it has some overlap with this README. In a feature branch our README is more aligned, we have an "if you already installed openvino-dev, skip to step 3" message. That will be merged soon.

@slyubimt slyubimt requested a review from IRDonch May 26, 2021 16:07
@slyubimt
Copy link
Contributor Author

Improved document codestyle according to @andrew-zaytsev recommendations.

Copy link
Contributor

@SDxKeeper SDxKeeper left a comment

Choose a reason for hiding this comment

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

looks nice! especially section with openvino-dev[extras]
@slyubimt Am I right that MO dependencies will be installed in this scenario?

@andrew-zaytsev andrew-zaytsev merged commit 9a86cbf into openvinotoolkit:master May 31, 2021
@slyubimt slyubimt deleted the feature/pip_install_guides branch May 31, 2021 12:45
yekruglov pushed a commit to yekruglov/openvino that referenced this pull request Jun 7, 2021
* Update for install guides:

  - Human rights notice
  - Components descriptions update & console scripts
  - Extras requirements definition
  - Change verification step to Model Optimizer call

* Update docs/install_guides/pypi-openvino-dev.md

Co-authored-by: Helena Kloosterman <[email protected]>

* Update docs/install_guides/pypi-openvino-dev.md

Co-authored-by: Roman Donchenko <[email protected]>

* Update docs/install_guides/pypi-openvino-dev.md

Co-authored-by: Roman Donchenko <[email protected]>

* Update docs/install_guides/pypi-openvino-dev.md

Co-authored-by: Roman Donchenko <[email protected]>

* Update docs/install_guides/pypi-openvino-dev.md

Co-authored-by: Roman Donchenko <[email protected]>

* order

* fix grammar

* Update according to recommendations from InfoDev

* high-quality

* Caffe2*

* Update document style

Add additional verification step

* specify Ubuntu version for troubleshooting

* Add reference  to POT API.

Co-authored-by: Helena Kloosterman <[email protected]>
Co-authored-by: Roman Donchenko <[email protected]>
Copy link
Contributor

@baychub baychub left a comment

Choose a reason for hiding this comment

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

Here are language edits for Andrey to incorporate (just the Component table):

Component Console Script Description
Model Optimizer mo Model Optimizer imports, converts, and optimizes models that were trained in popular frameworks to a format usable by Intel tools, especially the Inference Engine.
Supported frameworks include Caffe*, TensorFlow*, MXNet*, and ONNX*.
Benchmark Tool benchmark_app Benchmark Application allows you to estimate deep learning inference performance on supported devices in synchronous and asynchronous modes.
Accuracy Checker and
Annotation Converter
accuracy_check
convert_annotation
Accuracy Checker is a deep learning accuracy validation tool that allows you collect accuracy metrics against popular datasets. The main advantages of the tool are the flexibility of configuration and an impressive set of supported datasets, preprocessing, postprocessing, and metrics.
Annotation Converter is a utility for offline conversion dataset to suitable for metric evaluation format used in Accuracy Checker.
Post-Training Optimization Tool pot Post-Training Optimization Tool allows you to optimize trained models with advanced capabilities, such as quantization and low-precision optimizations, without the need to re-train or fine-tune models.
Model Downloader and other OMZ tools omz_downloader
omz_converter
omz_quantizer
omz_info_dumper
Model Downloader is a tool for getting access to collection of high quality and extremely fast pre-trained deep learning public and intel-trained models. These free pre-trained models can be used instead of training your own models, to speed up the development and production deployment process. The purpose of the tool is as follows: it downloads model files from online sources and, if necessary, patches them to make them more usable with Model Optimizer. A number of additional tools are also provided to automate the process of working with downloaded models:
Model Converter is a tool for conversion the models that are stored not in the Inference Engine IR format into that format using Model Optimizer.
Model Quantizer is a tool for automatic quantization full-precision models in the IR format into low-precision versions using the Post-Training Optimization Tool.
Model Information Dumper is a helper utility for dumping information about the models to a stable, machine-readable format.

@helena-intel
Copy link
Contributor

A few suggestions about the edited table:

"Model Quantizer is a tool for automatic quantization full-precision models in the IR format into low-precision versions using the Post-Training Optimization Tool." suggest changing to "quantization of full-precision models"

Model Converter is a tool for conversion the models suggest changing to "conversion of the models" or "converting the models"

that are stored not in suggest changing to "that are not stored in"

Model Downloader is a tool for getting access to collection suggest changing to "getting access to a collection"

Accuracy Checker is a deep learning accuracy validation tool that allows you collect accuracy metrics suggest changing to "allows you to collect"

Annotation Converter is a utility for offline conversion dataset to suitable for metric evaluation format There are a few words missing in this sentence

an impressive set of supported datasets, preprocessing, postprocessing, and metrics. An impressive set of preprocessing? Suggest adding a noun.

Would it be helpful to modify the description for model converter and quantizer to say "OMZ models" instead of models, because these tools only work for OMZ models? omz is in the name of the command, but not everyone may make the connection to "only for OMZ models".

@ryanloney
Copy link
Contributor

ryanloney commented Jun 13, 2021

Thank @helena-intel for catching these typos.

My suggestion is to change Annotation Converter is a utility for offline conversion dataset to suitable for metric evaluation format to "Annotation Converter is a utility that converts datasets to a format suitable for accuracy measurement"

Using the word impressive does not seem appropriate here. I suggest removing it.

I agree with Helena that we should be specific about Model Converter being for Open Model Zoo models. It causes confusion about Model Optimizer with such a similar name.

rnugmanx pushed a commit to rnugmanx/openvino that referenced this pull request Aug 26, 2021
* Update for install guides:

  - Human rights notice
  - Components descriptions update & console scripts
  - Extras requirements definition
  - Change verification step to Model Optimizer call

* Update docs/install_guides/pypi-openvino-dev.md

Co-authored-by: Helena Kloosterman <[email protected]>

* Update docs/install_guides/pypi-openvino-dev.md

Co-authored-by: Roman Donchenko <[email protected]>

* Update docs/install_guides/pypi-openvino-dev.md

Co-authored-by: Roman Donchenko <[email protected]>

* Update docs/install_guides/pypi-openvino-dev.md

Co-authored-by: Roman Donchenko <[email protected]>

* Update docs/install_guides/pypi-openvino-dev.md

Co-authored-by: Roman Donchenko <[email protected]>

* order

* fix grammar

* Update according to recommendations from InfoDev

* high-quality

* Caffe2*

* Update document style

Add additional verification step

* specify Ubuntu version for troubleshooting

* Add reference  to POT API.

Co-authored-by: Helena Kloosterman <[email protected]>
Co-authored-by: Roman Donchenko <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: docs OpenVINO documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.