Docs: Update "Install OpenVINO Runtime on Windows from Archive File" page (#13332)
* docs: big update to Windows archive install steps * docs: apply correct note format * docs: add link to archives * docs: minor update * docs: change archive download link to GitHub * Update docs/install_guides/installing-openvino-from-archive-windows.md Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com> * docs: typo fix * docs: minor change * docs: remove "For Python developers" in Software tab * docs: fix curl command * docs: clarify that archive install is for C++ users * docs: add link to PyPI page * docs: Change back to numbered instructions * Update docs/install_guides/installing-openvino-from-archive-windows.md * Update docs/install_guides/installing-openvino-from-archive-windows.md * Update docs/install_guides/installing-openvino-from-archive-windows.md * Apply suggestions from code review * Update installing-openvino-from-archive-windows.md * Update docs/install_guides/installing-openvino-from-archive-windows.md * Update installing-openvino-from-archive-windows.md * Update installing-openvino-from-archive-windows.md * Update installing-openvino-from-archive-windows.md * Update docs/install_guides/installing-openvino-from-archive-windows.md * Update installing-openvino-from-archive-windows.md * Update installing-openvino-from-archive-windows.md * Update installing-openvino-from-archive-windows.md * Update installing-openvino-from-archive-windows.md * Update docs/install_guides/installing-openvino-from-archive-windows.md * Update docs/install_guides/installing-openvino-from-archive-windows.md * Update installing-openvino-from-archive-windows.md Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com> Co-authored-by: Yuan Xu <yuan1.xu@intel.com>
This commit is contained in:
Evan
GitHub
parent
87f61cf822
commit
f1fe3a2f65
@ -1,17 +1,20 @@
|
||||
# Install OpenVINO™ Runtime on Windows 10 from an Archive File {#openvino_docs_install_guides_installing_openvino_from_archive_windows}
|
||||
# Install OpenVINO™ Runtime on Windows from an Archive File {#openvino_docs_install_guides_installing_openvino_from_archive_windows}
|
||||
|
||||
With the OpenVINO™ 2022.2 release, you can download and use archive files to install OpenVINO Runtime.
|
||||
With the OpenVINO™ 2022.2 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.
|
||||
|
||||
You can also check the [Release Notes](https://software.intel.com/en-us/articles/OpenVINO-RelNotes) for more information on updates in this release.
|
||||
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
|
||||
.. tab:: Operating Systems
|
||||
|
||||
Microsoft Windows 10, 64-bit
|
||||
* Microsoft Windows 10, x86, 64-bit
|
||||
* Microsoft Windows 11, x86, 64-bit
|
||||
|
||||
.. tab:: Hardware
|
||||
|
||||
@ -35,20 +38,19 @@ You can also check the [Release Notes](https://software.intel.com/en-us/articles
|
||||
|
||||
.. tab:: Software
|
||||
|
||||
* For C++ developers:
|
||||
* `Microsoft Visual Studio 2019 with MSBuild <http://visualstudio.microsoft.com/downloads/>`_
|
||||
* `CMake 3.14 or higher, 64-bit <https://cmake.org/download/>`_ (optional, only required for building sample applications)
|
||||
* For Python developers: `Python 3.6 - 3.10, 64-bit <https://www.python.org/downloads/windows/>`_
|
||||
* Note that OpenVINO is gradually stopping the support for Python 3.6. You are encouraged to use Python 3.7 - 3.10.
|
||||
* `Microsoft Visual Studio 2019 with MSBuild <https://visualstudio.microsoft.com/vs/older-downloads/>`_ or `Microsoft Visual Studio 2022 <http://visualstudio.microsoft.com/downloads/>`_
|
||||
* `CMake 3.14 or higher, 64-bit <https://cmake.org/download/>`_ (optional, only required for building sample applications)
|
||||
* `Python 3.6 - 3.10, 64-bit <https://www.python.org/downloads/windows/>`_
|
||||
* Note that OpenVINO is gradually phasing out support for Python 3.6. You are encouraged to use Python 3.7 - 3.10.
|
||||
|
||||
.. note::
|
||||
You can choose to download the Community version. Use `Microsoft Visual Studio installation guide <https://docs.microsoft.com/en-us/visualstudio/install/install-visual-studio?view=vs-2019>`_ to walk you through the installation. During installation in the **Workloads** tab, choose **Desktop development with C++**.
|
||||
To install Microsoft Visual Studio 2019, follow the `Microsoft Visual Studio installation guide <https://docs.microsoft.com/en-us/visualstudio/install/install-visual-studio?view=vs-2019>`_. You can choose to download the Community version. During installation in the **Workloads** tab, choose **Desktop development with C++**.
|
||||
|
||||
.. note::
|
||||
You can either use `cmake<version>.msi` which is the installation wizard or `cmake<version>.zip` where you have to go into the `bin` folder and then manually add the path to environmental variables.
|
||||
|
||||
.. important::
|
||||
As part of this installation, make sure you click the option **Add Python 3.x to PATH** to `add Python <https://docs.python.org/3/using/windows.html#installation-steps>`_ to your `PATH` environment variable.
|
||||
When installing Python, make sure you click the option **Add Python 3.x to PATH** to `add Python <https://docs.python.org/3/using/windows.html#installation-steps>`_ to your `PATH` environment variable.
|
||||
|
||||
@endsphinxdirective
|
||||
|
||||
@ -56,57 +58,67 @@ You can also check the [Release Notes](https://software.intel.com/en-us/articles
|
||||
|
||||
### <a name="install-openvino"></a>Step 1: Download and Install OpenVINO Core Components
|
||||
|
||||
1. Select and download the OpenVINO™ archive files from [Intel® Distribution of OpenVINO™ toolkit download page](https://software.intel.com/en-us/openvino-toolkit/choose-download).
|
||||
There are typically two files for you to download:
|
||||
```sh
|
||||
w_openvino_toolkit_<operating system>_<release version>_<package ID>_x86_64.zip
|
||||
w_openvino_toolkit_<operating system>_<release version>_<package ID>_x86_64.zip.sha256
|
||||
```
|
||||
where the `.sha256` file is used to verify the success of the download process.
|
||||
1. Create an `Intel` folder in the `C:\Program Files (x86)\` directory. Skip this step if the folder already exists.
|
||||
|
||||
2. Locate the downloaded files in your system. This document assumes the files are in your `Downloads` directory.
|
||||
|
||||
3. Open a command prompt terminal window, and run the following command with the `.zip` file:
|
||||
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
|
||||
CertUtil -hashfile <archive name>.zip SHA256
|
||||
mkdir "C:\Program Files (x86)\Intel"
|
||||
```
|
||||
Compare the returned value in the output with what's in the `<archive name>.zip.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).
|
||||
> **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.
|
||||
|
||||
4. Unzip the `<archive name>.zip` file using your preferred archive tool.
|
||||
> **NOTE**: The name of the archive file might be long. Make sure that you have [enabled long paths on Windows](https://docs.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry#enable-long-paths-in-windows-10-version-1607-and-later) to avoid possible errors in the unzipping process.
|
||||
2. Download the [OpenVINO Runtime archive file for Windows](https://storage.openvinotoolkit.org/repositories/openvino/packages/2022.2/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 <user_home>/Downloads
|
||||
curl -L https://storage.openvinotoolkit.org/repositories/openvino/packages/2022.2/windows/w_openvino_toolkit_windows_2022.2.0.7713.af16ea1d79a_x86_64.zip --output openvino_2022.2.0.7713.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.2.0.7713.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).
|
||||
|
||||
|
||||
The standard OpenVINO `<INSTALL_DIR>` used in this document is `C:\Program Files (x86)\Intel\openvino_<version>\`. You're recommended to move the extracted files to that directory.
|
||||
|
||||
For simplicity, you can also create a symbolic link to the latest installation: `C:\Program Files (x86)\Intel\openvino_2022\`.
|
||||
3. Use your favorite tool to extract the archive file, rename the extracted folder as `openvino_2022.2.0.7713`, 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.2.0.7713.zip
|
||||
ren w_openvino_toolkit_windows_2022.2.0.7713.af16ea1d79a_x86_64 openvino_2022.2.0.7713
|
||||
move openvino_2022.2.0.7713 "C:\Program Files (x86)\Intel"
|
||||
```
|
||||
|
||||
The core components are now installed. Continue to the next section to configure the environment.
|
||||
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.2.0.7713
|
||||
```
|
||||
> **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.
|
||||
|
||||
|
||||
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 `<INSTALL_DIR>` throughout the OpenVINO documentation.
|
||||
|
||||
### <a name="set-the-environment-variables"></a>Step 2: Configure the Environment
|
||||
|
||||
> **NOTE**: If you installed the Intel® Distribution of OpenVINO™ to a non-default install directory, replace `C:\Program Files (x86)\Intel` with that directory in this guide's instructions.
|
||||
|
||||
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:
|
||||
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 <INSTALL_DIR> is not `C:\Program Files (x86)\Intel\openvino_2022`, use the correct directory instead.
|
||||
|
||||
```sh
|
||||
"<INSTALL_DIR>\setupvars.bat"
|
||||
"C:\Program Files (x86)\Intel\openvino_2022\setupvars.bat"
|
||||
```
|
||||
|
||||
**Optional**: OpenVINO™ toolkit environment variables are removed when you close the command prompt window. You can permanently set the environment variables manually.
|
||||
> **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 when you know you installed it, your computer might not be able to find the program. 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. Next, you can download some additional tools.
|
||||
The environment variables are set. Continue to the next section if you want to download any additional components.
|
||||
|
||||
### <a name="model-optimizer">Step 3 (Optional): Install Additional Components</a>
|
||||
|
||||
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 are not part of the installer. The OpenVINO™ Development Tools can only be installed via PyPI now. See [Install OpenVINO™ Development Tools](installing-model-dev-tools.md) for detailed steps.
|
||||
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.
|
||||
|
||||
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).
|
||||
|
||||
### <a name="optional-steps"></a>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, NCS2, VPUs, and GNAs. See the instructions below to set up OpenVINO on these devices.
|
||||
|
||||
@sphinxdirective
|
||||
.. tab:: GPU
|
||||
@ -128,34 +140,59 @@ OpenCV is necessary to run demos from Open Model Zoo (OMZ). Some OpenVINO sample
|
||||
@endsphinxdirective
|
||||
|
||||
## <a name="get-started"></a>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.
|
||||
|
||||
Now you are ready to try out the toolkit.
|
||||
@sphinxdirective
|
||||
.. tab:: Get started with Python
|
||||
|
||||
Start with some Python tutorials:
|
||||
* [Hello Image Classification](https://docs.openvino.ai/latest/notebooks/001-hello-world-with-output.html)
|
||||
* [Convert TensorFlow models with OpenVINO™](https://docs.openvino.ai/latest/notebooks/101-tensorflow-to-openvino-with-output.html)
|
||||
* [Convert a PyTorch model and remove the image background](https://docs.openvino.ai/latest/notebooks/205-vision-background-removal-with-output.html)
|
||||
Try the `Python Quick Start Example <https://docs.openvino.ai/2022.2/notebooks/201-vision-monodepth-with-output.html>`_ 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
|
||||
|
||||
To start with C++ samples, see <a href="openvino_docs_OV_UG_Samples_Overview.html#build-samples-windows">Build Sample Applications on Windows</a> first, and then you can try the following samples:
|
||||
* [Hello Classification C++ Sample](@ref openvino_inference_engine_samples_hello_classification_README)
|
||||
* [Hello Reshape SSD C++ Sample](@ref openvino_inference_engine_samples_hello_reshape_ssd_README)
|
||||
* [Image Classification Async C++ Sample](@ref openvino_inference_engine_samples_classification_sample_async_README)
|
||||
|
||||
## <a name="uninstall"></a>Uninstalling the Intel® Distribution of OpenVINO™ Toolkit
|
||||
Visit the :ref:`Tutorials <notebook tutorials>` page for more Jupyter Notebooks to get you started with OpenVINO, such as:
|
||||
|
||||
* `OpenVINO Python API Tutorial <https://docs.openvino.ai/2022.2/notebooks/002-openvino-api-with-output.html>`_
|
||||
* `Basic image classification program with Hello Image Classification <https://docs.openvino.ai/2022.2/notebooks/001-hello-world-with-output.html>`_
|
||||
* `Convert a PyTorch model and use it for image background removal <https://docs.openvino.ai/2022.2/notebooks/205-vision-background-removal-with-output.html>`_
|
||||
|
||||
To uninstall the toolkit, follow the steps on the [Uninstalling page](uninstalling-openvino.md).
|
||||
.. tab:: Get started with C++
|
||||
|
||||
Try the `C++ Quick Start Example <openvino_docs_get_started_get_started_demos.html>`_ 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 <code 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 <openvino_inference_engine_samples_hello_reshape_ssd_README.html>`_
|
||||
* `Automatic speech recognition C++ sample <openvino_inference_engine_samples_speech_sample_README.html>`_
|
||||
|
||||
@endsphinxdirective
|
||||
|
||||
## <a name="uninstall"></a>Uninstalling OpenVINO Runtime
|
||||
|
||||
To uninstall OpenVINO, follow the steps on the [Uninstalling page](uninstalling-openvino.md).
|
||||
|
||||
## Additional Resources
|
||||
|
||||
## Additional Resources
|
||||
|
||||
@sphinxdirective
|
||||
|
||||
* :ref:`Troubleshooting Guide for OpenVINO Installation & Configuration <troubleshooting guide for install>`
|
||||
* Converting models for use with OpenVINO™: :ref:`Model Optimizer User Guide <deep learning model optimizer>`
|
||||
* Converting models for use with OpenVINO™: :ref:`Model Optimizer Developer Guide <deep learning model optimizer>`
|
||||
* Writing your own OpenVINO™ applications: :ref:`OpenVINO™ Runtime User Guide <deep learning openvino runtime>`
|
||||
* Sample applications: :ref:`OpenVINO™ Toolkit Samples Overview <code samples>`
|
||||
* Pre-trained deep learning models: :ref:`Overview of OpenVINO™ Toolkit Pre-Trained Models <model zoo>`
|
||||
* IoT libraries and code samples in the GitHub repository: `Intel® IoT Developer Kit`_
|
||||
|
||||
* IoT libraries and code samples in the GitHUB repository: `Intel® IoT Developer Kit`_
|
||||
|
||||
<!---
|
||||
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 Apache MXNet Model <convert model mxnet>`
|
||||
* :ref:`Convert Your Kaldi Model <convert model kaldi>`
|
||||
* :ref:`Convert Your ONNX Model <convert model onnx>`
|
||||
--->
|
||||
.. _Intel® IoT Developer Kit: https://github.com/intel-iot-devkit
|
||||
|
||||
@endsphinxdirective
|
||||
|
||||
Loading…
Reference in New Issue
Block a user