From 66ae71454aa20592b5114cdd69d43e046f2cc70a Mon Sep 17 00:00:00 2001 From: Sebastian Golebiewski Date: Thu, 23 Mar 2023 10:09:43 +0100 Subject: [PATCH] DOCS shift to rst - Install OpenVINO on Windows (#16502) --- .../installing-openvino-docker-windows.md | 266 +++++++++++------- ...nstalling-openvino-from-archive-windows.md | 232 ++++++++------- .../installing-openvino-windows-header.md | 18 +- 3 files changed, 312 insertions(+), 204 deletions(-) diff --git a/docs/install_guides/installing-openvino-docker-windows.md b/docs/install_guides/installing-openvino-docker-windows.md index b42034cb7bc..d10bf08df67 100644 --- a/docs/install_guides/installing-openvino-docker-windows.md +++ b/docs/install_guides/installing-openvino-docker-windows.md @@ -1,97 +1,124 @@ # Install Intel® Distribution of OpenVINO™ toolkit for Windows from Docker Image {#openvino_docs_install_guides_installing_openvino_docker_windows} +@sphinxdirective + This guide provides steps for creating a Docker image with Intel® Distribution of OpenVINO™ toolkit for Windows and using the Docker image on different devices. -## System Requirements +.. _system-requirements-docker-windows: + +System Requirements +#################### + -@sphinxdirective .. tab:: Target Operating System with Python Versions - +------------------------------------+--------------------------+ - | Operating System | Supported Python Version | - +====================================+==========================+ - | Windows Server Core base LTSC 2019 | 3.8 | - +------------------------------------+--------------------------+ - | Windows 10, version 20H2 | 3.8 | - +------------------------------------+--------------------------+ + .. list-table:: + :header-rows: 1 + + * - Operating System + - Supported Python Version + * - Windows Server Core base LTSC 2019 + - 3.8 + * - Windows 10, version 20H2 + - 3.8 .. tab:: Host Operating Systems - * Windows 10, 64-bit Pro, Enterprise or Education (1607 Anniversary Update, Build 14393 or later) editions - * Windows Server 2016 or higher + * Windows 10, 64-bit Pro, Enterprise or Education (1607 Anniversary Update, Build 14393 or later) editions + * Windows Server 2016 or higher -@endsphinxdirective -### Additional Requirements for GPU +Additional Requirements for GPU ++++++++++++++++++++++++++++++++ To use GPU Acceleration in Windows containers, make sure that the following requirements for Windows host, OpenVINO and Docker are met: -- [Windows requirements](https://docs.microsoft.com/en-us/virtualization/windowscontainers/deploy-containers/gpu-acceleration): +- `Windows requirements `__: + - The container host must be running Windows Server 2019 or Windows 10 of version 1809 or higher. - - The container base image must be `mcr.microsoft.com/windows:1809` or higher. Windows Server Core and Nano Server container images are not currently supported. + - The container base image must be ``mcr.microsoft.com/windows:1809`` or higher. Windows Server Core and Nano Server container images are not currently supported. - The container host must be running Docker Engine 19.03 or higher. - The container host must have GPU running display drivers of version WDDM 2.5 or higher. -- GPU requirement for OpenVINO: Intel Graphics Driver for Windows of version 15.65 or higher. -- [Docker isolation mode requirements](https://docs.microsoft.com/en-us/virtualization/windowscontainers/manage-containers/hyperv-container): - - Windows host and container version tags must match. - - [Windows host and container isolation process support](https://docs.microsoft.com/en-us/virtualization/windowscontainers/deploy-containers/version-compatibility). -## Installation Flow +- GPU requirement for OpenVINO: Intel Graphics Driver for Windows of version 15.65 or higher. +- `Docker isolation mode requirements `__: + + - Windows host and container version tags must match. + - `Windows host and container isolation process support `__. + +Installation Flow +#################### There are two ways to install OpenVINO with Docker. You can choose either of them according to your needs: -* Use a prebuilt image. Do the following steps: - 1. Get a prebuilt image from provided sources. - 2. Run the image on different devices. -* If you want to customize your image, you can also build a Docker image manually by using the following steps: - 1. Prepare a Dockerfile. - 2. Configure the Docker image. - 3. Run the image on different devices. -## Getting a Prebuilt Image from Provided Sources +* Use a prebuilt image. Do the following steps: + + 1. `Get a prebuilt image from provided sources <#getting-a-prebuilt-image-from-provided-sources>`__. + 2. `Run the image on different devices <#running-the-docker-image-on-different-devices>`__. + +* If you want to customize your image, you can also build a Docker image manually by using the following steps: + + 1. `Prepare a Dockerfile <#preparing-a-dockerfile>`__. + 2. `Configure the Docker image <#configuring-the-docker-image-for-different-devices>`__. + 3. `Run the image on different devices <#running-the-docker-image-on-different-devices>`__. + +Getting a Prebuilt Image from Provided Sources +############################################## You can find prebuilt images on: -- [Docker Hub](https://hub.docker.com/u/openvino) -- [Azure Marketplace](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/intel_corporation.openvino) +- `Docker Hub `__ +- `Azure Marketplace `__ -## Preparing a Dockerfile +Preparing a Dockerfile +###################### -You can use the [available Dockerfiles on GitHub](https://github.com/openvinotoolkit/docker_ci/tree/master/dockerfiles) or generate a Dockerfile with your settings via [DockerHub CI Framework](https://github.com/openvinotoolkit/docker_ci) which can generate a Dockerfile, build, test and deploy an image with the Intel® Distribution of OpenVINO™ toolkit. +You can use the `available Dockerfiles on GitHub `__ or generate a Dockerfile with your settings via `DockerHub CI Framework `__ which can generate a Dockerfile, build, test and deploy an image with the Intel® Distribution of OpenVINO™ toolkit. -## Configuring the Docker Image for Different Devices +Configuring the Docker Image for Different Devices +################################################## -### Installing Additional Dependencies for CPU +Installing Additional Dependencies for CPU +++++++++++++++++++++++++++++++++++++++++++ -#### Installing CMake +Installing CMake +---------------- + +To add CMake to the image, add the following commands to the Dockerfile: + +.. code-block:: bat - To add CMake to the image, add the following commands to the Dockerfile: - ```bat RUN powershell.exe -Command ` Invoke-WebRequest -URI https://cmake.org/files/v3.14/cmake-3.14.7-win64-x64.msi -OutFile %TMP%\\cmake-3.14.7-win64-x64.msi ; ` Start-Process %TMP%\\cmake-3.14.7-win64-x64.msi -ArgumentList '/quiet /norestart' -Wait ; ` Remove-Item %TMP%\\cmake-3.14.7-win64-x64.msi -Force RUN SETX /M PATH "C:\Program Files\CMake\Bin;%PATH%" - ``` - In case of proxy issues, please add the `ARG HTTPS_PROXY` and `-Proxy %%HTTPS_PROXY%` settings to the `powershell.exe` command to the Dockerfile. Then build a Docker image: - ```bat + +In case of proxy issues, please add the ``ARG HTTPS_PROXY`` and ``-Proxy %%HTTPS_PROXY%`` settings to the ``powershell.exe`` command to the Dockerfile. Then build a Docker image: + +.. code-block:: bat + docker build . -t ` --build-arg HTTPS_PROXY= - ``` - -#### Installing Microsoft Visual Studio Build Tools - You can add Microsoft Visual Studio Build Tools to a Windows OS Docker image using the [offline](https://docs.microsoft.com/en-us/visualstudio/install/create-an-offline-installation-of-visual-studio?view=vs-2019) or [online](https://docs.microsoft.com/en-us/visualstudio/install/build-tools-container?view=vs-2019) installers for Build Tools. - - Microsoft Visual Studio Build Tools are licensed as a supplement your existing Microsoft Visual Studio license. - - Any images built with these tools should be for your personal use or for use in your organization in accordance with your existing Visual Studio and Windows licenses. - To add MSBuild 2019 to the image, add the following commands to the Dockerfile: - ```bat +Installing Microsoft Visual Studio Build Tools +---------------------------------------------- + +You can add Microsoft Visual Studio Build Tools to a Windows OS Docker image using the `offline `__ or `online `__ installers for Build Tools. + +Microsoft Visual Studio Build Tools are licensed as a supplement your existing Microsoft Visual Studio license. + +Any images built with these tools should be for your personal use or for use in your organization in accordance with your existing Visual Studio and Windows licenses. + +To add MSBuild 2019 to the image, add the following commands to the Dockerfile: + +.. code-block:: bat + RUN powershell.exe -Command Invoke-WebRequest -URI https://aka.ms/vs/16/release/vs_buildtools.exe -OutFile %TMP%\\vs_buildtools.exe - + RUN %TMP%\\vs_buildtools.exe --quiet --norestart --wait --nocache ` --installPath "C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools" ` --add Microsoft.VisualStudio.Workload.MSBuildTools ` @@ -101,75 +128,110 @@ You can use the [available Dockerfiles on GitHub](https://github.com/openvinotoo --remove Microsoft.VisualStudio.Component.Windows10SDK.10586 ` --remove Microsoft.VisualStudio.Component.Windows10SDK.14393 ` --remove Microsoft.VisualStudio.Component.Windows81SDK || IF "%ERRORLEVEL%"=="3010" EXIT 0 && powershell set-executionpolicy remotesigned - ``` - In case of proxy issues, please use the [offline installer for Build Tools](https://docs.microsoft.com/en-us/visualstudio/install/create-an-offline-installation-of-visual-studio?view=vs-2019). -### Configuring the Image for GPU +In case of proxy issues, please use the `offline installer for Build Tools `__. -> **NOTE**: Since GPU is not supported in prebuilt images or [default Dockerfiles](https://github.com/openvinotoolkit/docker_ci/tree/master/dockerfiles), you must make sure the Additional Requirements for GPU in System Requirements are met, and do the following steps to build the image manually. +Configuring the Image for GPU ++++++++++++++++++++++++++++++ + +.. note:: + + Since GPU is not supported in `prebuilt images <#getting-a-prebuilt-image-from-provided-sources>`__ or `default Dockerfiles `__, you must make sure the Additional Requirements for GPU in `System Requirements <#system-requirements>`__ are met, and do the following steps to build the image manually. + +1. Reuse one of `available Dockerfiles `__. You can also use your own Dockerfile. +2. Check your `Windows host and container isolation process compatibility `__. +3. Find the appropriate Windows container base image on `DockerHub `__ and set up your host/container version in the ``FROM`` Dockerfile instruction. + + For example, in the ``openvino_c_dev_.dockerfile``, change: + + .. code-block:: bat + + FROM mcr.microsoft.com/windows/servercore:ltsc2019 AS ov_base -1. Reuse one of [available Dockerfiles](https://github.com/openvinotoolkit/docker_ci/tree/master/dockerfiles). You can also use your own Dockerfile. -2. Check your [Windows host and container isolation process compatibility](https://docs.microsoft.com/en-us/virtualization/windowscontainers/deploy-containers/version-compatibility). -3. Find the appropriate Windows container base image on [DockerHub](https://hub.docker.com/_/microsoft-windows) and set up your host/container version in the `FROM` Dockerfile instruction. - For example, in the `openvino_c_dev_.dockerfile`, change: - ```bat - FROM mcr.microsoft.com/windows/servercore:ltsc2019 AS ov_base - ``` to: - ```bat - FROM mcr.microsoft.com/windows:20H2 - ``` + + .. code-block:: bat + + FROM mcr.microsoft.com/windows:20H2 + + 4. Build the Docker image by running the following command: - ```bat - docker build --build-arg package_url= -f -t . - ``` -5. Copy `OpenCL.dll` from your `C:\Windows\System32` host folder to any `temp` directory: - ```bat - mkdir C:\tmp - copy C:\Windows\System32\OpenCL.dll C:\tmp - ``` -## Running the Docker Image on Different Devices + .. code-block:: bat -### Running the Image on CPU + docker build --build-arg package_url= -f -t . + + +5. Copy ``OpenCL.dll`` from your ``C:\Windows\System32`` host folder to any ``temp`` directory: + + .. code-block:: bat + + mkdir C:\tmp + copy C:\Windows\System32\OpenCL.dll C:\tmp + + +Running the Docker Image on Different Devices +############################################# + +Running the Image on CPU +++++++++++++++++++++++++ To start the interactive session, run the following command: -```bat -docker run -it --rm -``` + +.. code-block:: bat + + docker run -it --rm + If you want to try some samples, run the image with the following command: -```bat -docker run -it --rm -cmd /S /C "omz_downloader --name googlenet-v1 --precisions FP16 && omz_converter --name googlenet-v1 --precision FP16 && curl -kO https://storage.openvinotoolkit.org/data/test_data/images/car_1.bmp && python samples\python\hello_classification\hello_classification.py public\googlenet-v1\FP16\googlenet-v1.xml car_1.bmp CPU" -``` -### Running the Image on GPU +.. code-block:: bat -> **NOTE**: Since GPU is not supported in prebuilt images or [default Dockerfiles](https://github.com/openvinotoolkit/docker_ci/tree/master/dockerfiles), you must make sure the Additional Requirements for GPU in System Requirements are met, and configure and build the image manually before you can run inferences on a GPU. + docker run -it --rm + cmd /S /C "omz_downloader --name googlenet-v1 --precisions FP16 && omz_converter --name googlenet-v1 --precision FP16 && curl -kO https://storage.openvinotoolkit.org/data/test_data/images/car_1.bmp && python samples\python\hello_classification\hello_classification.py public\googlenet-v1\FP16\googlenet-v1.xml car_1.bmp CPU" + + +Running the Image on GPU +++++++++++++++++++++++++ + +.. note:: + + Since GPU is not supported in `prebuilt images <#getting-a-prebuilt-image-from-provided-sources>`__ or `default Dockerfiles `__, you must make sure the Additional Requirements for GPU in `System Requirements <#system-requirements>`__ are met, and `configure and build the image manually <#configuring-the-image-for-gpu>`__ before you can run inferences on a GPU. 1. To try inference on a GPU, run the image with the following command: - ```bat - docker run -it --rm -u ContainerAdministrator --isolation process --device class/5B45201D-F2F2-4F3B-85BB-30FF1F953599 -v C:\Windows\System32\DriverStore\FileRepository\iigd_dch.inf_amd64_518f2921ba495409:C:\Windows\System32\DriverStore\FileRepository\iigd_dch.inf_amd64_518f2921ba495409 -v C:\tmp:C:\tmp - ``` + + .. code-block:: bat + + docker run -it --rm -u ContainerAdministrator --isolation process --device class/5B45201D-F2F2-4F3B-85BB-30FF1F953599 -v C:\Windows\System32\DriverStore\FileRepository\iigd_dch. inf_amd64_518f2921ba495409:C:\Windows\System32\DriverStore\FileRepository\iigd_dch.inf_amd64_518f2921ba495409 -v C:\tmp:C:\tmp + + where - - `--device class/5B45201D-F2F2-4F3B-85BB-30FF1F953599` is a reserved interface class GUID for a GPU device. - - `C:\Windows\System32\DriverStore\FileRepository\iigd_dch.inf_amd64_518f2921ba495409` is the path to OpenCL driver home directory. To find it on your PC, run the `C:\Windows\System32\DriverStore\FileRepository\iigd_dch.inf_amd64_*` regular expression. - - `C:\tmp` is the folder with the copy of `OpenCL.dll` from your `C:\Windows\System32` host folder. -2. Copy `OpenCL.dll` to the `C:\Windows\System32` folder inside the container and set appropriate registry entry. Now you can run inference on a GPU device: - ```bat - copy C:\tmp\OpenCL.dll C:\Windows\System32\ && reg add "HKLM\SOFTWARE\Khronos\OpenCL\Vendors" /v "C:\Windows\System32\DriverStore\FileRepository\iigd_dch.inf_amd64_518f2921ba495409\ocl\bin\x64\intelocl64.dll" /t REG_DWORD /d 0 - ``` - For example, run the `Hello Classification Python` sample with the following command: - ```bat - omz_downloader --name googlenet-v1 --precisions FP16 && omz_converter --name googlenet-v1 --precision FP16 && curl -kO https://storage.openvinotoolkit.org/data/test_data/images/car_1.bmp && python samples\python\hello_classification\hello_classification.py public\googlenet-v1\FP16\googlenet-v1.xml car_1.bmp GPU - ``` + + - ``--device class/5B45201D-F2F2-4F3B-85BB-30FF1F953599`` is a reserved interface class GUID for a GPU device. + - ``C:\Windows\System32\DriverStore\FileRepository\iigd_dch.inf_amd64_518f2921ba495409`` is the path to OpenCL driver home directory. To find it on your PC, run the ``C:\Windows\System32\DriverStore\FileRepository\iigd_dch.inf_amd64_*`` regular expression. + - ``C:\tmp`` is the folder with the copy of ``OpenCL.dll`` from your ``C:\Windows\System32`` host folder. + +2. Copy ``OpenCL.dll`` to the ``C:\Windows\System32`` folder inside the container and set appropriate registry entry. Now you can run inference on a GPU device: + + .. code-block:: bat + + copy C:\tmp\OpenCL.dll C:\Windows\System32\ && reg add "HKLM\SOFTWARE\Khronos\OpenCL\Vendors" /v "C:\Windows\System32\DriverStore\FileRepository\iigd_dch. inf_amd64_518f2921ba495409\ocl\bin\x64\intelocl64.dll" /t REG_DWORD /d 0 -## Additional Resources + For example, run the ``Hello Classification Python`` sample with the following command: -- [DockerHub CI Framework](https://github.com/openvinotoolkit/docker_ci) for Intel® Distribution of OpenVINO™ toolkit. The Framework can generate a Dockerfile, build, test, and deploy an image with the Intel® Distribution of OpenVINO™ toolkit. You can reuse available Dockerfiles, add your layer and customize the image of OpenVINO™ for your needs. -- Intel® Distribution of OpenVINO™ toolkit home page: [https://software.intel.com/en-us/openvino-toolkit](https://software.intel.com/en-us/openvino-toolkit) -- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) \ No newline at end of file + .. code-block:: bat + + omz_downloader --name googlenet-v1 --precisions FP16 && omz_converter --name googlenet-v1 --precision FP16 && curl -kO https://storage.openvinotoolkit.org/data/test_data/images/ car_1.bmp && python samples\python\hello_classification\hello_classification.py public\googlenet-v1\FP16\googlenet-v1.xml car_1.bmp GPU + + +Additional Resources +#################### + +- `DockerHub CI Framework `__ for Intel® Distribution of OpenVINO™ toolkit. The Framework can generate a Dockerfile, build, test, and deploy an image with the Intel® Distribution of OpenVINO™ toolkit. You can reuse available Dockerfiles, add your layer and customize the image of OpenVINO™ for your needs. +- Intel® Distribution of OpenVINO™ toolkit home page: `https://software.intel.com/en-us/openvino-toolkit `__ +- `OpenVINO Installation Selector Tool `__ + +@endsphinxdirective diff --git a/docs/install_guides/installing-openvino-from-archive-windows.md b/docs/install_guides/installing-openvino-from-archive-windows.md index 2300a1dceb8..a0bc2b7649c 100644 --- a/docs/install_guides/installing-openvino-from-archive-windows.md +++ b/docs/install_guides/installing-openvino-from-archive-windows.md @@ -1,112 +1,158 @@ # Install OpenVINO™ Runtime on Windows from an Archive File {#openvino_docs_install_guides_installing_openvino_from_archive_windows} -With the OpenVINO™ 2022.3 release, you can download and use archive files to install OpenVINO Runtime. The archive files contain pre-built binaries and library files needed for OpenVINO Runtime, as well as code samples. - -Installing OpenVINO Runtime from archive files is recommended for C++ developers. If you are working with Python, the PyPI package has everything needed for Python development and deployment on CPU and GPUs. See the [Install OpenVINO from PyPI](installing-openvino-pip.md) page for instructions on how to install OpenVINO Runtime for Python using PyPI. - -> **NOTE**: Since the OpenVINO™ 2022.1 release, the following development tools: Model Optimizer, Post-Training Optimization Tool, Model Downloader and other Open Model Zoo tools, Accuracy Checker, and Annotation Converter can be installed via [pypi.org](https://pypi.org/project/openvino-dev/) only. - -See the [Release Notes](https://software.intel.com/en-us/articles/OpenVINO-RelNotes) for more information on updates in the latest release. - -## System Requirements - @sphinxdirective + +With the OpenVINO™ 2022.3 release, you can download and use archive files to install OpenVINO Runtime. The archive files contain pre-built binaries and library files needed for OpenVINO Runtime, as well as code samples. + +Installing OpenVINO Runtime from archive files is recommended for C++ developers. If you are working with Python, the PyPI package has everything needed for Python development and deployment on CPU and GPUs. See the :doc:`Install OpenVINO from PyPI ` page for instructions on how to install OpenVINO Runtime for Python using PyPI. + +.. note:: + + Since the OpenVINO™ 2022.1 release, the following development tools: Model Optimizer, Post-Training Optimization Tool, Model Downloader and other Open Model Zoo tools, Accuracy Checker, and Annotation Converter can be installed via `pypi.org `__ only. + + +See the `Release Notes `__ for more information on updates in the latest release. + +System Requirements +#################### + .. tab:: System Requirements | Full requirement listing is available in: | `System Requirements Page `_ - + .. tab:: Processor Notes - Processor graphics are not included in all processors. - See `Product Specifications`_ for information about your processor. - - .. _Product Specifications: https://ark.intel.com/ + Processor graphics are not included in all processors. + See `Product Specifications`_ for information about your processor. + + .. _Product Specifications: https://ark.intel.com/ .. tab:: Software - * `Microsoft Visual Studio 2019 with MSBuild `_ or `Microsoft Visual Studio 2022 `_ - * `CMake 3.14 or higher, 64-bit `_ (optional, only required for building sample applications) - * `Python 3.7 - 3.10, 64-bit `_ + * `Microsoft Visual Studio 2019 with MSBuild `_ or `Microsoft Visual Studio 2022 `_ + * `CMake 3.14 or higher, 64-bit `_ (optional, only required for building sample applications) + * `Python 3.7 - 3.10, 64-bit `_ - .. note:: - To install Microsoft Visual Studio 2019, follow the `Microsoft Visual Studio installation guide `_. You can choose to download the Community version. During installation in the **Workloads** tab, choose **Desktop development with C++**. + .. note:: - .. note:: - You can either use `cmake.msi` which is the installation wizard or `cmake.zip` where you have to go into the `bin` folder and then manually add the path to environmental variables. - - .. important:: - When installing Python, make sure you click the option **Add Python 3.x to PATH** to `add Python `_ to your `PATH` environment variable. + To install Microsoft Visual Studio 2019, follow the `Microsoft Visual Studio installation guide `_. You can choose to download the Community version. During installation in the **Workloads** tab, choose **Desktop development with C++**. -@endsphinxdirective + .. note:: -## Installing OpenVINO Runtime + You can either use `cmake.msi` which is the installation wizard or `cmake.zip` where you have to go into the `bin` folder and then manually add the path to environmental variables. -### Step 1: Download and Install OpenVINO Core Components + .. important:: + + When installing Python, make sure you click the option **Add Python 3.x to PATH** to `add Python `_ to your `PATH` environment variable. + + + +Installing OpenVINO Runtime +########################### + +.. _install-openvino-archive-windows: + +Step 1: Download and Install OpenVINO Core Components ++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +1. Create an ``Intel`` folder in the ``C:\Program Files (x86)\`` directory. Skip this step if the folder already exists. -1. Create an `Intel` folder in the `C:\Program Files (x86)\` directory. Skip this step if the folder already exists. - You can also do this via command-lines. Open a new command prompt window as administrator by right-clicking **Command Prompt** from the Start menu and select **Run as administrator**, and then run the following command: - ```sh - mkdir "C:\Program Files (x86)\Intel" - ``` - > **NOTE**: `C:\Program Files (x86)\Intel` is the recommended folder. You may also use a different path if desired or if you don't have administrator privileges on your computer. -2. Download the [OpenVINO Runtime archive file for Windows](https://storage.openvinotoolkit.org/repositories/openvino/packages/2022.3/windows/) to your local `Downloads` folder. - + .. code-block:: sh + + mkdir "C:\Program Files (x86)\Intel" + + + .. note:: + + ``C:\Program Files (x86)\Intel`` is the recommended folder. You may also use a different path if desired or if you don't have administrator privileges on your computer. + + +2. Download the `OpenVINO Runtime archive file for Windows `__ to your local ``Downloads`` folder. + If you prefer using command-lines, run the following commands in the command prompt window you opened: - ```sh - cd /Downloads - curl -L https://storage.openvinotoolkit.org/repositories/openvino/packages/2022.3/windows/w_openvino_toolkit_windows_2022.3.0.9052.9752fafe8eb_x86_64.zip --output openvino_2022.3.0.zip - ``` - > **NOTE**: A `.sha256` file is provided together with the archive file to validate your download process. To do that, download the `.sha256` file from the same repository and run `CertUtil -hashfile openvino_2022.3.0.zip SHA256`. Compare the returned value in the output with what's in the `.sha256` file: if the values are the same, you have downloaded the correct file successfully; if not, create a Support ticket [here](https://www.intel.com/content/www/us/en/support/contact-intel.html). + + .. code-block:: sh + + cd /Downloads + curl -L https://storage.openvinotoolkit.org/repositories/openvino/packages/2022.3/windows/w_openvino_toolkit_windows_2022.3.0.9052.9752fafe8eb_x86_64.zip --output openvino_2022. 3.0.zip -3. Use your favorite tool to extract the archive file, rename the extracted folder, and move it to the `C:\Program Files (x86)\Intel` directory. - + .. note:: + + A ``.sha256`` file is provided together with the archive file to validate your download process. To do that, download the ``.sha256`` file from the same repository and run ``CertUtil -hashfile openvino_2022.3.0.zip SHA256``. Compare the returned value in the output with what's in the ``.sha256`` file: if the values are the same, you have downloaded the correct file successfully; if not, create a Support ticket `here `__. + + +3. Use your favorite tool to extract the archive file, rename the extracted folder, and move it to the ``C:\Program Files (x86)\Intel`` directory. + To do this step using command-lines, run the following commands in the command prompt window you opened: - ```sh - tar -xf openvino_2022.3.0.zip - ren w_openvino_toolkit_windows_2022.3.0.9052.9752fafe8eb_x86_64 openvino_2022.3.0 - move openvino_2022.3.0 "C:\Program Files (x86)\Intel" - ``` + + .. code-block:: sh + + tar -xf openvino_2022.3.0.zip + ren w_openvino_toolkit_windows_2022.3.0.9052.9752fafe8eb_x86_64 openvino_2022.3.0 + move openvino_2022.3.0 "C:\Program Files (x86)\Intel" + 4. For simplicity, it is useful to create a symbolic link. Open a command prompt window as administrator (see Step 1 for how to do this) and run the following commands: - ```sh - cd C:\Program Files (x86)\Intel - mklink /D openvino_2022 openvino_2022.3.0 - ``` - > **NOTE**: If you have already installed a previous release of OpenVINO 2022, a symbolic link to the `openvino_2022` folder may already exist. If you want to override it, nagivate to the `C:\Program Files (x86)\Intel` folder and delete the existing linked folder before running the `mklink` command. + + .. code-block:: sh + + cd C:\Program Files (x86)\Intel + mklink /D openvino_2022 openvino_2022.3.0 -Congratulations, you finished the installation! The `C:\Program Files (x86)\Intel\openvino_2022` folder now contains the core components for OpenVINO. If you used a different path in Step 1, you will find the `openvino_2022` folder there. The path to the `openvino_2022` directory is also referred as `` throughout the OpenVINO documentation. + .. note:: -### Step 2: Configure the Environment + If you have already installed a previous release of OpenVINO 2022, a symbolic link to the ``openvino_2022`` folder may already exist. If you want to override it, nagivate to the ``C:\Program Files (x86)\Intel`` folder and delete the existing linked folder before running the ``mklink`` command. -You must update several environment variables before you can compile and run OpenVINO™ applications. Open the Command Prompt, and run the `setupvars.bat` batch file to temporarily set your environment variables. If your is not `C:\Program Files (x86)\Intel\openvino_2022`, use the correct directory instead. -```sh -"C:\Program Files (x86)\Intel\openvino_2022\setupvars.bat" -``` +Congratulations, you finished the installation! The ``C:\Program Files (x86)\Intel\openvino_2022`` folder now contains the core components for OpenVINO. If you used a different path in Step 1, you will find the ``openvino_2022`` folder there. The path to the ``openvino_2022`` directory is also referred as ```` throughout the OpenVINO documentation. -> **Important**: The above command must be re-run every time a new Command Prompt window is opened. +.. _set-the-environment-variables-windows: + +Step 2: Configure the Environment ++++++++++++++++++++++++++++++++++ + +You must update several environment variables before you can compile and run OpenVINO™ applications. Open the Command Prompt, and run the ``setupvars.bat`` batch file to temporarily set your environment variables. If your ```` is not ``C:\Program Files (x86)\Intel\openvino_2022``, use the correct directory instead. + +.. code-block: sh + + "C:\Program Files (x86)\Intel\openvino_2022\setupvars.bat" + + +.. important:: + + The above command must be re-run every time a new Command Prompt window is opened. + + +.. note:: + + If you see an error indicating Python is not installed, Python may not be added to the PATH environment variable (as described `here `__). Check your system environment variables, and add Python if necessary. -> **NOTE**: If you see an error indicating Python is not installed, Python may not be added to the PATH environment variable (as described [here](https://docs.python.org/3/using/windows.html#finding-the-python-executable)). Check your system environment variables, and add Python if necessary. The environment variables are set. Continue to the next section if you want to download any additional components. -### Step 3 (Optional): Install Additional Components +.. _model-optimizer-windows: + +Step 3 (Optional): Install Additional Components +++++++++++++++++++++++++++++++++++++++++++++++++ OpenVINO Development Tools is a set of utilities for working with OpenVINO and OpenVINO models. It provides tools like Model Optimizer, Benchmark Tool, Post-Training Optimization Tool, and Open Model Zoo Downloader. If you install OpenVINO Runtime using archive files, OpenVINO Development Tools must be installed separately. -See the [Install OpenVINO Development Tools](installing-model-dev-tools.md) page for step-by-step installation instructions. +See the :doc:`Install OpenVINO Development Tools ` page for step-by-step installation instructions. -OpenCV is necessary to run demos from Open Model Zoo (OMZ). Some OpenVINO samples can also extend their capabilities when compiled with OpenCV as a dependency. To install OpenCV for OpenVINO, see the [instructions on GitHub](https://github.com/opencv/opencv/wiki/BuildOpenCV4OpenVINO). +OpenCV is necessary to run demos from Open Model Zoo (OMZ). Some OpenVINO samples can also extend their capabilities when compiled with OpenCV as a dependency. To install OpenCV for OpenVINO, see the `instructions on GitHub `. + +.. _optional-steps-windows: + +Step 4 (Optional): Configure Inference on non-CPU Devices ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -### Step 4 (Optional): Configure Inference on non-CPU Devices OpenVINO Runtime has a plugin architecture that enables you to run inference on multiple devices without rewriting your code. Supported devices include integrated GPUs, discrete GPUs and GNAs. See the instructions below to set up OpenVINO on these devices. -@sphinxdirective .. tab:: GPU To enable the toolkit components to use processor graphics (GPU) on your system, follow the steps in :ref:`GPU Setup Guide `. @@ -114,69 +160,67 @@ OpenVINO Runtime has a plugin architecture that enables you to run inference on .. tab:: GNA To enable the toolkit components to use Intel® Gaussian & Neural Accelerator (GNA) on your system, follow the steps in :ref:`GNA Setup Guide `. - -@endsphinxdirective -## What's Next? + +.. _get-started-windows: + +What's Next? +#################### + Now that you've installed OpenVINO Runtime, you're ready to run your own machine learning applications! Learn more about how to integrate a model in OpenVINO applications by trying out the following tutorials. -@sphinxdirective + .. tab:: Get started with Python - Try the `Python Quick Start Example `_ to estimate depth in a scene using an OpenVINO monodepth model in a Jupyter Notebook inside your web browser. - + Try the `Python Quick Start Example `__ to estimate depth in a scene using an OpenVINO monodepth model in a Jupyter Notebook inside your web browser. + .. image:: https://user-images.githubusercontent.com/15709723/127752390-f6aa371f-31b5-4846-84b9-18dd4f662406.gif :width: 400 Visit the :ref:`Tutorials ` page for more Jupyter Notebooks to get you started with OpenVINO, such as: - - * `OpenVINO Python API Tutorial `_ - * `Basic image classification program with Hello Image Classification `_ - * `Convert a PyTorch model and use it for image background removal `_ + + * `OpenVINO Python API Tutorial `__ + * `Basic image classification program with Hello Image Classification `__ + * `Convert a PyTorch model and use it for image background removal `__ .. tab:: Get started with C++ Try the `C++ Quick Start Example `_ for step-by-step instructions on building and running a basic image classification C++ application. - + .. image:: https://user-images.githubusercontent.com/36741649/127170593-86976dc3-e5e4-40be-b0a6-206379cd7df5.jpg :width: 400 Visit the :ref:`Samples ` page for other C++ example applications to get you started with OpenVINO, such as: - + * `Basic object detection with the Hello Reshape SSD C++ sample `_ * `Automatic speech recognition C++ sample `_ -@endsphinxdirective -## Uninstalling OpenVINO Runtime +.. _uninstall-from-windows: -To uninstall OpenVINO, follow the steps on the [Uninstalling page](uninstalling-openvino.md). +Uninstalling OpenVINO Runtime +############################# -## Additional Resources +To uninstall OpenVINO, follow the steps on the :doc:`Uninstalling page ` -## Additional Resources - -@sphinxdirective +Additional Resources +#################### +* `OpenVINO Installation Selector Tool `__ * :ref:`Troubleshooting Guide for OpenVINO Installation & Configuration ` * Converting models for use with OpenVINO™: :ref:`Model Optimizer Developer Guide ` * Writing your own OpenVINO™ applications: :ref:`OpenVINO™ Runtime User Guide ` * Sample applications: :ref:`OpenVINO™ Toolkit Samples Overview ` * Pre-trained deep learning models: :ref:`Overview of OpenVINO™ Toolkit Pre-Trained Models ` -* IoT libraries and code samples in the GitHUB repository: `Intel® IoT Developer Kit`_ - - -.. _Intel® IoT Developer Kit: https://github.com/intel-iot-devkit +---> @endsphinxdirective - -## Additional Resources - -- [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html) \ No newline at end of file diff --git a/docs/install_guides/installing-openvino-windows-header.md b/docs/install_guides/installing-openvino-windows-header.md index 2b0489fd384..f5480a6a350 100644 --- a/docs/install_guides/installing-openvino-windows-header.md +++ b/docs/install_guides/installing-openvino-windows-header.md @@ -10,12 +10,14 @@ From PyPI Using Docker + +If you want to install OpenVINO™ Runtime on Windows, you have the following options: + +* :doc:`Install OpenVINO Runtime from an Archive File ` +* :doc:`Install OpenVINO from PyPI ` +* :doc:`Install OpenVINO with Docker ` + +For a full selection of distribution channels, +see the `OpenVINO Installation Selector Tool `__ + @endsphinxdirective - -If you want to install OpenVINO™ Runtime on Windows, you have the following options: - -* [Install OpenVINO Runtime from an Archive File](installing-openvino-from-archive-windows.md) -* [Install OpenVINO from PyPI](installing-openvino-pip.md) -* [Install OpenVINO with Docker](installing-openvino-docker-windows.md) - -For a full selection of distribution channels, see the [OpenVINO Installation Selector Tool](https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/download.html)