IntenseWebs/openvino
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor updates to Linux/macOS/Windows installation guide (#10955)

Browse Source 
* Add Overview page

* Revert "Add Overview page"

* CVS-71745

* fix links & errors

* fix formatting

* update bullet points
This commit is contained in:
Yuan Xu 2022-03-15 17:06:30 +08:00 committed by GitHub
parent c58ef365b5
commit e71a05d94d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 48 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/OV_Runtime_UG/openvino_temporary.md
View File

@ -2,8 +2,6 @@
@sphinxdirective
.. _deep learning inference engine:
.. toctree::
:maxdepth: 1
:hidden:

8
docs/install_guides/installing-openvino-config-ivad-vpu.md
View File

@ -2,6 +2,8 @@
@sphinxdirective
.. _vpu guide:
.. toctree::
:maxdepth: 2
:hidden:
@ -44,6 +46,12 @@ Now the dependencies are installed and you are ready to use the Intel® Vision A
For advanced configuration steps for your **IEI Mustang-V100-MX8-R10** accelerator, see [Configurations for IEI Mustang-V100-MX8-R10 card](movidius-setup-guide.md). **IEI Mustang-V100-MX8-R11** accelerator doesn't require any additional steps.
@sphinxdirective
.. _vpu guide windows:
@endsphinxdirective
## Windows
To enable inference on Intel® Vision Accelerator Design with Intel® Movidius™ VPUs, the following additional installation steps are required:

26
docs/install_guides/installing-openvino-linux.md
View File

@ -49,7 +49,7 @@ This guide provides step-by-step instructions on how to install the Intel® Dist
@sphinxdirective
.. important::
Before you start your journey with installation of the Intel® Distribution of OpenVINO™, we encourage you to check up our :ref:`code samples <code samples>` in C, C++, and Python and :ref:`notebook tutorials <notebook tutorials>` that we prepared for you, so you could see all amazing things that you can achieve with our tool.
Before you start your journey with installation of the Intel® Distribution of OpenVINO™, we encourage you to check our :ref:`code samples <code samples>` in C, C++, Python and :ref:`notebook tutorials <notebook tutorials>` that we prepared for you, so you could see all the amazing things that you can achieve with our tool.
@endsphinxdirective
@ -85,9 +85,9 @@ This guide provides step-by-step instructions on how to install the Intel® Dist
```sh
./l_openvino_toolkit_p_<version>.sh -a --cli
```
> **NOTE**: To get additional information on all parameters that can be used, check up the help option: `--help`. Among others, you can find there `-s` option which offers silent mode, which together with `--eula approve` allows you to run whole installation with default values without any user inference.
> **NOTE**: To get additional information on all parameters that can be used, use the help option: `--help`. Among others, you can find there `-s` option which offers silent mode, which together with `--eula approve` allows you to run whole installation with default values without any user inference.
6. Follow the instructions on your screen. During the installation you will be asked to accept the license agreement. The acceptance is required to continue. Check out the installation process on the image below:<br>
6. Follow the instructions on your screen. During the installation you will be asked to accept the license agreement. Your acceptance is required to continue. Check the installation process on the image below:<br>
![](../img/openvino-install-linux-run-boostrapper-script.gif)
Click on the image to see the details.
@ -104,7 +104,7 @@ The core components are now installed. Continue to the next section to install a
## <a name="install-external-dependencies"></a>Step 2: Install External Software Dependencies
This script allows to install Linux platform development tools and components to work with the product.
This script enables you to install Linux platform development tools and components to work with the product.
1. Go to the `install_dependencies` directory:
```sh
@ -153,17 +153,17 @@ The environment variables are set. Next, you can download some additional tools.
@sphinxdirective
.. tab:: GPU
Only if you want to enable the toolkit components to use processor graphics (GPU) on your system, follow the steps in :ref:`GPU Setup Guide <gpu guide>`.
To enable the toolkit components to use processor graphics (GPU) on your system, follow the steps in :ref:`GPU Setup Guide <gpu guide>`.
.. tab:: NCS 2
Only if you want to perform inference on Intel® Neural Compute Stick 2 powered by the Intel® Movidius™ Myriad™ X VPU, follow the steps on :ref:`NCS2 Setup Guide <ncs guide>`.
To perform inference on Intel® Neural Compute Stick 2 powered by the Intel® Movidius™ Myriad™ X VPU, follow the steps on :ref:`NCS2 Setup Guide <ncs guide>`.
<!--For more details, see the `Get Started page for Intel® Neural Compute Stick 2 <https://software.intel.com/en-us/neural-compute-stick/get-started>`.-->
.. tab:: VPU
To install and configure your Intel® Vision Accelerator Design with Intel® Movidius™ VPUs, see the :ref:`VPUs Configuration Guide <vpu guide>`.
After configuration is done, you are ready to run the verification scripts with the HDDL Plugin for your Intel® Vision Accelerator Design with Intel® Movidius™ VPUs. Check up our :ref:`Movidius VPU demos <vpu demos>`.
To install and configure your Intel® Vision Accelerator Design with Intel® Movidius™ VPUs, see the :ref:`VPU Configuration Guide <vpu guide>`.
After configuration is done, you are ready to run the verification scripts with the HDDL Plugin for your Intel® Vision Accelerator Design with Intel® Movidius™ VPUs.
.. warning::
While working with either HDDL or NCS, choose one of them as they cannot run simultaneously on the same machine.
@ -222,11 +222,11 @@ To uninstall the toolkit, follow the steps on the [Uninstalling page](uninstalli
To learn more about converting models from specific frameworks, go to:
* :ref:`Convert Your Caffe Model <convert model caffe>`
* :ref:`Convert Your TensorFlow Model <convert model tf>`
* :ref:`Convert Your MXNet Modele <convert model mxnet>`
* :ref:`Convert Your Kaldi Model <convert model kaldi>`
* :ref:`Convert Your ONNX Model <convert model onnx>`
* :ref:`Convert Your Caffe Model <openvino_docs_MO_DG_prepare_model_convert_model_Convert_Model_From_Caffe>`
* :ref:`Convert Your TensorFlow Model <openvino_docs_MO_DG_prepare_model_convert_model_Convert_Model_From_TensorFlow>`
* :ref:`Convert Your MXNet Model <openvino_docs_MO_DG_prepare_model_convert_model_Convert_Model_From_MxNet>`
* :ref:`Convert Your Kaldi Model <openvino_docs_MO_DG_prepare_model_convert_model_Convert_Model_From_Kaldi>`
* :ref:`Convert Your ONNX Model <openvino_docs_MO_DG_prepare_model_convert_model_Convert_Model_From_ONNX>`
.. _Intel® IoT Developer Kit: https://github.com/intel-iot-devkit

14
docs/install_guides/installing-openvino-macos.md
View File

@ -26,7 +26,7 @@
.. tab:: Software Requirements
* `CMake 3.13 or higher <https://cmake.org/download/>`_ (choose "macOS 10.13 or later"). Add `/Applications/CMake.app/Contents/bin` to path (for default install).
* `Python 3.6 - 3.9 <https://www.python.org/downloads/mac-osx/>`_ (choose 3.6.x - 3.9.x). Install and add to path.
* `Python 3.6 - 3.9 <https://www.python.org/downloads/mac-osx/>`_ (choose 3.6 - 3.9). Install and add to path.
* Apple Xcode Command Line Tools. In the terminal, run `xcode-select --install` from any directory
* (Optional) Apple Xcode IDE (not required for OpenVINO™, but useful for development)
@ -60,7 +60,7 @@ This guide provides step-by-step instructions on how to install the Intel® Dist
@endsphinxdirective
5. Follow the instructions on your screen. During the installation you will be asked to accept the license agreement. The acceptance is required to continue.
5. Follow the instructions on your screen. During the installation you will be asked to accept the license agreement. Your acceptance is required to continue.
![](../img/openvino-install-macos-run-boostrapper-script.gif)
Click on the image to see the details.
@ -150,11 +150,11 @@ To uninstall the toolkit, follow the steps on the [Uninstalling page](uninstalli
To learn more about converting models from specific frameworks, go to:
* :ref:`Convert Your Caffe Model <convert model caffe>`
* :ref:`Convert Your TensorFlow Model <convert model tf>`
* :ref:`Convert Your MXNet Modele <convert model mxnet>`
* :ref:`Convert Your Kaldi Model <convert model kaldi>`
* :ref:`Convert Your ONNX Model <convert model onnx>`
* :ref:`Convert Your Caffe Model <openvino_docs_MO_DG_prepare_model_convert_model_Convert_Model_From_Caffe>`
* :ref:`Convert Your TensorFlow Model <openvino_docs_MO_DG_prepare_model_convert_model_Convert_Model_From_TensorFlow>`
* :ref:`Convert Your MXNet Model <openvino_docs_MO_DG_prepare_model_convert_model_Convert_Model_From_MxNet>`
* :ref:`Convert Your Kaldi Model <openvino_docs_MO_DG_prepare_model_convert_model_Convert_Model_From_Kaldi>`
* :ref:`Convert Your ONNX Model <openvino_docs_MO_DG_prepare_model_convert_model_Convert_Model_From_ONNX>`
.. _Intel® IoT Developer Kit: https://github.com/intel-iot-devkit

35
docs/install_guides/installing-openvino-windows.md
View File

@ -71,7 +71,7 @@ This guide provides step-by-step instructions on how to install the Intel® Dist
@endsphinxdirective
3. Follow the instructions on your screen. During the installation you will be asked to accept the license agreement. The acceptance is required to continue. Check out the installation process in the image below:<br>
3. Follow the instructions on your screen. During the installation you will be asked to accept the license agreement. Your acceptance is required to continue. Check out the installation process in the image below:<br>
![](../img/openvino-install-win-run-boostrapper-script.gif)
Click on the image to see the details.
<br>
@ -112,18 +112,23 @@ The environment variables are set. Next, you can download some additional tools.
.. note::
No prerequisites are needed.
There are 3 ways to run the script:
There are three ways to run the script:
* GUI: right-click the script and select ``Run with PowerShell``.
* Command prompt (CMD) console:
a. GUI: right click and select ``Run with PowerShell``
b. Command prompt (CMD) console:
.. code-block:: sh
powershell <INSTALL_DIR>\extras\scripts\download_opencv.ps1
c. PowerShell console:
* PowerShell console:
.. code-block:: sh
.\<INSTALL_DIR>\scripts\download_opencv.ps1
If the Intel® Distribution of OpenVINO™ is installed to the system location (e.g. ``Program Files (x86)``) then privilege elevation dialog will be shown. The script can be run from CMD/PowerShell Administrator console to avoid this dialog in case of system-wide installation.
The script is interactive by default, so during the execution it will wait for user to press ``Enter`` If you want to avoid this, use the ``-batch`` option, e.g. ``powershell <openvino>\extras\scripts\download_opencv.ps1 -batch``. After the execution of the script, you will find OpenCV extracted to ``<INSTALL_DIR>/extras/opencv``.
@ -135,11 +140,11 @@ The environment variables are set. Next, you can download some additional tools.
@sphinxdirective
.. tab:: GPU
Only do this if you want to enable the toolkit components to use processor graphics (GPU) on your system, follow the steps in :ref:`GPU Setup Guide <gpu guide windows>`.
To enable the toolkit components to use processor graphics (GPU) on your system, follow the steps in :ref:`GPU Setup Guide <gpu guide windows>`.
.. tab:: VPU
To install and configure your Intel® Vision Accelerator Design with Intel® Movidius™ VPUs, see the :ref:`VPUs Configuration Guide <vpu guide windows>`.
To install and configure your Intel® Vision Accelerator Design with Intel® Movidius™ VPUs, see the :ref:`VPU Configuration Guide <vpu guide windows>`.
@endsphinxdirective
@ -173,11 +178,11 @@ To uninstall the toolkit, follow the steps on the [Uninstalling page](uninstalli
To learn more about converting models from specific frameworks, go to:
* :ref:`Convert Your Caffe Model <convert model caffe>`
* :ref:`Convert Your TensorFlow Model <convert model tf>`
* :ref:`Convert Your MXNet Modele <convert model mxnet>`
* :ref:`Convert Your Kaldi Model <convert model kaldi>`
* :ref:`Convert Your ONNX Model <convert model onnx>`
* :ref:`Convert Your Caffe Model <openvino_docs_MO_DG_prepare_model_convert_model_Convert_Model_From_Caffe>`
* :ref:`Convert Your TensorFlow Model <openvino_docs_MO_DG_prepare_model_convert_model_Convert_Model_From_TensorFlow>`
* :ref:`Convert Your MXNet Model <openvino_docs_MO_DG_prepare_model_convert_model_Convert_Model_From_MxNet>`
* :ref:`Convert Your Kaldi Model <openvino_docs_MO_DG_prepare_model_convert_model_Convert_Model_From_Kaldi>`
* :ref:`Convert Your ONNX Model <openvino_docs_MO_DG_prepare_model_convert_model_Convert_Model_From_ONNX>`
.. _Intel® IoT Developer Kit: https://github.com/intel-iot-devkit