Update documentation (openvinotoolkit#3156)

* update documentation * Apply suggestions from code review Co-authored-by: Anastasiya Ageeva <[email protected]> * add info about omz_data_downloader * update omz-tools installation * update Inference Engine to OpenVINO * update build instructions * add information about model stages to docs * Apply suggestions from code review Co-authored-by: Andrey Zaytsev <[email protected]> * remove trailing whitespaces * update installation section of model tools * update docs Co-authored-by: Anastasiya Ageeva <[email protected]> Co-authored-by: Andrey Zaytsev <[email protected]>
avsanjay · Feb 21, 2022 · bf4c746 · bf4c746
1 parent 2483e0c
commit bf4c746
Show file tree

Hide file tree

Showing 204 changed files with 449 additions and 423 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -177,9 +177,9 @@ license: https://raw.githubusercontent.com/pudae/tensorflow-densenet/master/LICE
 
 ## Model Conversion
 
-Deep Learning Inference Engine (IE) supports models in the Intermediate Representation (IR) format. A model from any supported framework can be converted to IR using the Model Optimizer tool included in the OpenVINO&trade; toolkit. Find more information about conversion in the [Model Optimizer Developer Guide](https://docs.openvino.ai/latest/_docs_MO_DG_Deep_Learning_Model_Optimizer_DevGuide.html). After a successful conversion you get a model in the IR format, with the `*.xml` file representing the net graph and the `*.bin` file containing the net parameters.
+OpenVINO&trade; Runtime supports models in the Intermediate Representation (IR) format. A model from any supported framework can be converted to IR using the Model Optimizer tool included in the OpenVINO&trade; toolkit. Find more information about conversion in the [Model Optimizer Developer Guide](@ref openvino_docs_MO_DG_Deep_Learning_Model_Optimizer_DevGuide). After a successful conversion, you get a model in the IR format, with the `*.xml` file representing the net graph and the `*.bin` file containing the net parameters.
 
-> **NOTE 1**: Image preprocessing parameters (mean and scale) must be built into a converted model to simplify model usage.
+> **NOTE**: Image preprocessing parameters (mean and scale) must be built into a converted model to simplify model usage.
 
 > **NOTE 2**: If a model input is a color image, color channel order should be `BGR`.
 

diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ Intel is committed to the respect of human rights and avoiding complicity in hum
 * [Intel Pre-Trained Models](models/intel/index.md)
 * [Public Pre-Trained Models](models/public/index.md)
 * [Model Downloader](tools/model_tools/README.md) and other automation tools
-* [Demos](demos/README.md) that demonstrate models usage with Deep Learning Deployment Toolkit
+* [Demos](demos/README.md) that demonstrate models usage with OpenVINO™ Toolkit
 * [Accuracy Checker](tools/accuracy_checker/README.md) tool for models accuracy validation
 
 ## License

diff --git a/demos/3d_segmentation_demo/python/README.md b/demos/3d_segmentation_demo/python/README.md
@@ -18,7 +18,7 @@ python3 -mpip install --user -r <omz_dir>/demos/3d_segmentation_demo/python/requ
 
 For demo input image or video files, refer to the section **Media Files Available for Demos** in the [Open Model Zoo Demos Overview](../../README.md).
 The list of models supported by the demo is in `<omz_dir>/demos/3d_segmentation_demo/python/models.lst` file.
-This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO Inference Engine format (\*.xml + \*.bin).
+This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO IR format (\*.xml + \*.bin).
 
 An example of using the Model Downloader:
 

diff --git a/demos/README.md b/demos/README.md
@@ -2,8 +2,14 @@
 
 The Open Model Zoo demo applications are console applications that provide robust application templates to help you implement specific deep learning scenarios. These applications involve increasingly complex processing pipelines that gather analysis data from several models that run inference simultaneously, such as detecting a person in a video stream along with detecting the person's physical attributes, such as age, gender, and emotional state
 
-For the Intel® Distribution of OpenVINO™ toolkit, the demos are available after installation in the following directory: `<INSTALL_DIR>/deployment_tools/open_model_zoo/demos`.
-The demos can also be obtained from the Open Model Zoo [GitHub repository](https://github.com/openvinotoolkit/open_model_zoo/).
+Source code of the demos can be obtained from the Open Model Zoo [GitHub repository](https://github.com/openvinotoolkit/open_model_zoo/).
+
+```sh
+git clone https://github.com/openvinotoolkit/open_model_zoo.git
+cd open_model_zoo
+git submodule update --init --recursive
+```
+
 C++, C++ G-API and Python\* versions are located in the `cpp`, `cpp_gapi` and `python` subdirectories respectively.
 
 The Open Model Zoo includes the following demos:
@@ -78,22 +84,33 @@ To run the demo applications, you can use images and videos from the media files
 
 ## Demos that Support Pre-Trained Models
 
-> **NOTE:** Inference Engine HDDL plugin is available in [proprietary](https://software.intel.com/en-us/openvino-toolkit) distribution only.
+> **NOTE:** OpenVINO™ Runtime HDDL plugin is available in [proprietary](https://software.intel.com/en-us/openvino-toolkit) distribution only.
 
 You can download the [Intel pre-trained models](../models/intel/index.md) or [public pre-trained models](../models/public/index.md) using the OpenVINO [Model Downloader](../tools/model_tools/README.md).
 
 ## Build the Demo Applications
 
-To be able to build demos you need to source Inference Engine and OpenCV environment from a binary package which is available as [proprietary](https://software.intel.com/en-us/openvino-toolkit) distribution.
-Please run the following command before the demos build (assuming that the binary package was installed to `<INSTALL_DIR>`):
+To build the demos, you need to source OpenVINO™ and OpenCV environment. You can install the OpenVINO™ toolkit using the installation package for [Intel® Distribution of OpenVINO™ toolkit](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit-download.html) or build the open-source version available in the [OpenVINO GitHub repository](https://github.com/openvinotoolkit/openvino) using the [build instructions](https://github.com/openvinotoolkit/openvino/wiki/BuildingCode).
+For the Intel® Distribution of OpenVINO™ toolkit installed to the `<INSTALL_DIR>` directory on your machine, run the following commands to download OpenCV and set environment variables before building the demos:
 
 ```sh
-source <INSTALL_DIR>/deployment_tools/bin/setupvars.sh
+<INSTALL_DIR>/extras/scripts/download_opencv.sh
+source <INSTALL_DIR>/setupvars.sh
 ```
 
-You can also build demos manually using Inference Engine built from the [openvino](https://github.com/openvinotoolkit/openvino) repo. In this case please set `InferenceEngine_DIR` environment variable to a folder containing `InferenceEngineConfig.cmake` and `ngraph_DIR` to a folder containing `ngraphConfig.cmake` in a build folder. Please also set the `OpenCV_DIR` to point to the OpenCV package to use. The same OpenCV version should be used both for Inference Engine and demos build. Alternatively these values can be provided via command line while running `cmake`. See [CMake's search procedure](https://cmake.org/cmake/help/latest/command/find_package.html#search-procedure).
-Please refer to the Inference Engine [build instructions](https://github.com/openvinotoolkit/openvino/wiki/BuildingCode)
-for details. Please also add path to built Inference Engine libraries to `LD_LIBRARY_PATH` (Linux*) or `PATH` (Windows*) variable before building the demos.
+> **NOTE:** If you plan to use Python\* demos only, you can install the OpenVINO Python\* package.
+> ```sh
+> pip install openvino
+> ```
+
+For the open-source version of OpenVINO, set the following variables:
+* `InferenceEngine_DIR` pointing to a folder containing `InferenceEngineConfig.cmake`
+* `OpenVINO_DIR` pointing to a folder containing `OpenVINOConfig.cmake`
+* `ngraph_DIR` pointing to a folder containing `ngraphConfig.cmake`.
+* `OpenCV_DIR` pointing to OpenCV. The same OpenCV version should be used both for OpenVINO and demos build.
+
+Alternatively, these values can be provided via command line while running `cmake`. See [CMake search procedure](https://cmake.org/cmake/help/latest/command/find_package.html#search-procedure).
+Also add paths to the built OpenVINO™ Runtime libraries to the `LD_LIBRARY_PATH` (Linux) or `PATH` (Windows) variable before building the demos.
 
 ### <a name="build_demos_linux"></a>Build the Demo Applications on Linux*
 
@@ -270,15 +287,15 @@ build_demos_msvc.bat --target="classification_demo segmentation_demo"
 
 ### Get Ready for Running the Demo Applications on Linux*
 
-Before running compiled binary files, make sure your application can find the Inference Engine and OpenCV libraries.
+Before running compiled binary files, make sure your application can find the OpenVINO™ and OpenCV libraries.
 If you use a [proprietary](https://software.intel.com/en-us/openvino-toolkit) distribution to build demos,
 run the `setupvars` script to set all necessary environment variables:
 
 ```sh
-source <INSTALL_DIR>/bin/setupvars.sh
+source <INSTALL_DIR>/setupvars.sh
 ```
 
-If you use your own Inference Engine and OpenCV binaries to build the demos please make sure you have added them
+If you use your own OpenVINO™ and OpenCV binaries to build the demos please make sure you have added them
 to the `LD_LIBRARY_PATH` environment variable.
 
 **(Optional)**: The OpenVINO environment variables are removed when you close the
@@ -293,7 +310,7 @@ vi <user_home_directory>/.bashrc
 2. Add this line to the end of the file:
 
 ```sh
-source <INSTALL_DIR>/bin/setupvars.sh
+source <INSTALL_DIR>/setupvars.sh
 ```
 
 3. Save and close the file: press the **Esc** key, type `:wq` and press the **Enter** key.
@@ -313,16 +330,16 @@ list above.
 
 ### Get Ready for Running the Demo Applications on Windows*
 
-Before running compiled binary files, make sure your application can find the Inference Engine and OpenCV libraries.
-Optionally download OpenCV community FFmpeg plugin. There is a downloader script in the OpenVINO package: `<INSTALL_DIR>\opencv\ffmpeg-download.ps1`.
-If you use a [proprietary](https://software.intel.com/en-us/openvino-toolkit) distribution to build demos,
+Before running compiled binary files, make sure your application can find the OpenVINO™ and OpenCV libraries.
+Optionally, download the OpenCV community FFmpeg plugin using the downloader script in the OpenVINO package: `<INSTALL_DIR>\extras\opencv\ffmpeg-download.ps1`.
+If you use the [Intel® Distribution of OpenVINO™ toolkit](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/overview.html) distribution to build demos,
 run the `setupvars` script to set all necessary environment variables:
 
 ```bat
-<INSTALL_DIR>\bin\setupvars.bat
+<INSTALL_DIR>\setupvars.bat
 ```
 
-If you use your own Inference Engine and OpenCV binaries to build the demos please make sure you have added
+If you use your own OpenVINO™ and OpenCV binaries to build the demos please make sure you have added
 to the `PATH` environment variable.
 
 To run Python demo applications that require native Python extension modules, you must additionally
@@ -336,7 +353,7 @@ set PYTHONPATH=%PYTHONPATH%;<bin_dir>
 To debug or run the demos on Windows in Microsoft Visual Studio, make sure you
 have properly configured **Debugging** environment settings for the **Debug**
 and **Release** configurations. Set correct paths to the OpenCV libraries, and
-debug and release versions of the Inference Engine libraries.
+debug and release versions of the OpenVINO™ libraries.
 For example, for the **Debug** configuration, go to the project's
 **Configuration Properties** to the **Debugging** category and set the `PATH`
 variable in the **Environment** field to the following:

diff --git a/demos/action_recognition_demo/python/README.md b/demos/action_recognition_demo/python/README.md
@@ -38,7 +38,7 @@ You can change the value of `num_requests` in `action_recognition_demo.py` to fi
 
 For demo input image or video files, refer to the section **Media Files Available for Demos** in the [Open Model Zoo Demos Overview](../../README.md).
 The list of models supported by the demo is in `<omz_dir>/demos/action_recognition_demo/python/models.lst` file.
-This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO Inference Engine format (\*.xml + \*.bin).
+This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO IR format (\*.xml + \*.bin).
 
 An example of using the Model Downloader:
 

diff --git a/demos/background_subtraction_demo/cpp_gapi/README.md b/demos/background_subtraction_demo/cpp_gapi/README.md
@@ -34,7 +34,7 @@ The demo workflow is the following:
 
 For demo input image or video files, refer to the section **Media Files Available for Demos** in the [Open Model Zoo Demos Overview](../../README.md).
 The list of models supported by the demo is in `<omz_dir>/demos/background_subtraction_demo/cpp_gapi/models.lst` file.
-This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO Inference Engine format (\*.xml + \*.bin).
+This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO IR format (\*.xml + \*.bin).
 
 An example of using the Model Downloader:
 

diff --git a/demos/background_subtraction_demo/python/README.md b/demos/background_subtraction_demo/python/README.md
@@ -59,7 +59,7 @@ The demo workflow is the following:
 
 For demo input image or video files, refer to the section **Media Files Available for Demos** in the [Open Model Zoo Demos Overview](../../README.md).
 The list of models supported by the demo is in `<omz_dir>/demos/instance_segmentation_demo/python/models.lst` file.
-This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO Inference Engine format (\*.xml + \*.bin).
+This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO IR format (\*.xml + \*.bin).
 
 An example of using the Model Downloader:
 

diff --git a/demos/bert_named_entity_recognition_demo/python/README.md b/demos/bert_named_entity_recognition_demo/python/README.md
@@ -11,7 +11,7 @@ The text is then used to search named entities.
 ## Preparing to Run
 
 The list of models supported by the demo is in `<omz_dir>/demos/bert_named_entity_recognition_demo/python/models.lst` file.
-This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO Inference Engine format (\*.xml + \*.bin).
+This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO IR format (\*.xml + \*.bin).
 
 An example of using the Model Downloader:
 

diff --git a/demos/bert_question_answering_demo/python/README.md b/demos/bert_question_answering_demo/python/README.md
@@ -11,7 +11,7 @@ The text is then used to search answers for user-provided questions.
 ## Preparing to Run
 
 The list of models supported by the demo is in `<omz_dir>/demos/bert_question_answering_demo/python/models.lst` file.
-This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO Inference Engine format (\*.xml + \*.bin).
+This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO IR format (\*.xml + \*.bin).
 
 An example of using the Model Downloader:
 

diff --git a/demos/bert_question_answering_embedding_demo/python/README.md b/demos/bert_question_answering_embedding_demo/python/README.md
@@ -20,7 +20,7 @@ If second (conventional SQuAD-tuned) Bert model is provided as well, it is used
 ## Preparing to Run
 
 The list of models supported by the demo is in `<omz_dir>/demos/bert_question_answering_embedding_demo/python/models.lst` file.
-This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO Inference Engine format (\*.xml + \*.bin).
+This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO IR format (\*.xml + \*.bin).
 
 An example of using the Model Downloader:
 

diff --git a/demos/classification_benchmark_demo/cpp/README.md b/demos/classification_benchmark_demo/cpp/README.md
@@ -19,7 +19,7 @@ You can stop the demo by pressing "Esc" or "Q" button. After that, the average m
 ## Preparing to Run
 
 The list of models supported by the demo is in `<omz_dir>/demos/classification_benchmark_demo/cpp/models.lst` file.
-This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO Inference Engine format (\*.xml + \*.bin).
+This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO IR format (\*.xml + \*.bin).
 
 An example of using the Model Downloader:
 

diff --git a/demos/classification_demo/python/README.md b/demos/classification_demo/python/README.md
@@ -15,7 +15,7 @@ You can stop the demo by pressing "Esc" or "Q" button. After that, the average m
 ## Preparing to Run
 
 The list of models supported by the demo is in `<omz_dir>/demos/classification_demo/python/models.lst` file.
-This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO Inference Engine format (\*.xml + \*.bin).
+This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO IR format (\*.xml + \*.bin).
 
 An example of using the Model Downloader:
 

diff --git a/demos/colorization_demo/python/README.md b/demos/colorization_demo/python/README.md
@@ -14,7 +14,7 @@ On startup, the application reads command-line parameters and loads one network
 
 For demo input image or video files, refer to the section **Media Files Available for Demos** in the [Open Model Zoo Demos Overview](../../README.md).
 The list of models supported by the demo is in `<omz_dir>/demos/colorization_demo/python/models.lst` file.
-This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO Inference Engine format (\*.xml + \*.bin).
+This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO IR format (\*.xml + \*.bin).
 
 An example of using the Model Downloader:
 

diff --git a/demos/crossroad_camera_demo/cpp/README.md b/demos/crossroad_camera_demo/cpp/README.md
@@ -39,7 +39,7 @@ REID value is assigned. Otherwise, the vector is added to a global list, and new
 
 For demo input image or video files, refer to the section **Media Files Available for Demos** in the [Open Model Zoo Demos Overview](../../README.md).
 The list of models supported by the demo is in `<omz_dir>/demos/crossroad_camera_demo/cpp/models.lst` file.
-This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO Inference Engine format (\*.xml + \*.bin).
+This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO IR format (\*.xml + \*.bin).
 
 An example of using the Model Downloader:
 

diff --git a/demos/deblurring_demo/python/README.md b/demos/deblurring_demo/python/README.md
@@ -21,7 +21,7 @@ For each image demo performs the following steps:
 
 For demo input image or video files, refer to the section **Media Files Available for Demos** in the [Open Model Zoo Demos Overview](../../README.md).
 The list of models supported by the demo is in `<omz_dir>/demos/deblurring_demo/python/models.lst` file.
-This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO Inference Engine format (\*.xml + \*.bin).
+This file can be used as a parameter for [Model Downloader](../../../tools/model_tools/README.md) and Converter to download and, if necessary, convert models to OpenVINO IR format (\*.xml + \*.bin).
 
 An example of using the Model Downloader: