[DOCS] Update to filenames and structure in install guide section for 2024.0 (#23145)

Port from https://github.com/openvinotoolkit/openvino/pull/23140

- Removed "-overview" and "-header" suffixes in filenames in install
guide scection.
- Moved files from install-guide-shared to install-openvino folder
This commit is contained in:
Maciej Smyk 2024-02-28 17:31:06 +01:00 committed by GitHub
parent 717875cd43
commit 1f4476525b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
36 changed files with 197 additions and 197 deletions

View File

@ -160,9 +160,9 @@ You can also check out [Awesome OpenVINO](https://github.com/openvinotoolkit/awe
## System requirements
The system requirements vary depending on platform and are available on dedicated pages:
- [Linux](https://docs.openvino.ai/2024/get-started/install-openvino-overview/install-openvino-linux-header.html)
- [Windows](https://docs.openvino.ai/2024/get-started/install-openvino-overview/install-openvino-windows-header.html)
- [macOS](https://docs.openvino.ai/2024/get-started/install-openvino-overview/install-openvino-macos-header.html)
- [Linux](https://docs.openvino.ai/2024/get-started/install-openvino/install-openvino-linux.html)
- [Windows](https://docs.openvino.ai/2024/get-started/install-openvino/install-openvino-windows.html)
- [macOS](https://docs.openvino.ai/2024/get-started/install-openvino/install-openvino-macos.html)
## How to build

View File

@ -77,7 +77,7 @@ Support Change and Deprecation Notices
* `Deployment Manager <https://docs.openvino.ai/2023.3/openvino_docs_install_guides_deployment_manager_tool.html>`__
is deprecated and will be supported for two years according to our LTS policy.
Visit our :doc:`selector tool <../get-started/install-openvino-overview>` to see
Visit our :doc:`selector tool <../get-started/install-openvino>` to see
package distribution options or our :doc:`deployment guide <../openvino-workflow/deployment-locally>`
../documentation.
* Accuracy Checker is deprecated and will be discontinued with 2024.0.

View File

@ -93,10 +93,10 @@ Intel® Neural Processing Unit
.. tab-item:: Additional considerations
* These Accelerators require :doc:`drivers <../get-started/configurations-header/configurations-intel-npu>`
* These Accelerators require :doc:`drivers <../get-started/configurations/configurations-intel-npu>`
that are not included in the Intel® Distribution of OpenVINO™ toolkit package.
* Users can access the NPU plugin through the OpenVINO archives on
the :doc:`download page <../get-started/install-openvino-overview>`.
the :doc:`download page <../get-started/install-openvino>`.
Intel® Gaussian & Neural Accelerator

View File

@ -35,7 +35,7 @@ If you are a Python developer, follow the steps in the :ref:`Installing OpenVINO
For C/C++ Developers
#######################
If you are a C/C++ developer, you must first install OpenVINO Runtime separately to set up the C/C++ libraries, sample code, and dependencies for building applications with OpenVINO. These files are not included with the PyPI distribution. See the :doc:`Selector Tool <../../get-started/install-openvino-overview>` page to install OpenVINO Runtime from an archive file for your operating system.
If you are a C/C++ developer, you must first install OpenVINO Runtime separately to set up the C/C++ libraries, sample code, and dependencies for building applications with OpenVINO. These files are not included with the PyPI distribution. See the :doc:`Selector Tool <../../get-started/install-openvino>` page to install OpenVINO Runtime from an archive file for your operating system.
Once OpenVINO Runtime is installed, you may install OpenVINO Development Tools for access to tools like ``mo``, Model Downloader, Benchmark Tool, and other utilities that will help you optimize your model and develop your application. Follow the steps in the :ref:`Installing OpenVINO Development Tools <install_dev_tools>` section on this page to install it.

View File

@ -5,16 +5,16 @@ GET STARTED
.. meta::
:description: Learn how to install Intel® Distribution of OpenVINO™ toolkit
on Windows, macOS, and Linux operating systems, using various
:description: Learn how to install Intel® Distribution of OpenVINO™ toolkit
on Windows, macOS, and Linux operating systems, using various
installation methods.
.. toctree::
:maxdepth: 1
:hidden:
Install OpenVINO <get-started/install-openvino-overview>
Additional Hardware Setup <get-started/configurations-header>
Install OpenVINO <get-started/install-openvino>
Additional Hardware Setup <get-started/configurations>
Troubleshooting <get-started/troubleshooting-install-config>
System Requirements <about-openvino/system-requirements>
@ -25,10 +25,10 @@ GET STARTED
<p id="GSG_introtext">Welcome to OpenVINO! This guide introduces installation and learning materials for Intel® Distribution of OpenVINO™ toolkit. The guide walks through the following steps:<br />
<a href="notebooks/201-vision-monodepth-with-output.html" >Quick Start Example</a>
<a href="get-started/install-openvino-overview.html" >Install OpenVINO</a>
<a href="get-started/install-openvino.html" >Install OpenVINO</a>
<a href="#learn-openvino" >Learn OpenVINO</a>
</p>
<div style="clear:both;"> </div>
<div style="clear:both;"> </div>
.. _quick-start-example:
@ -44,16 +44,16 @@ Try out OpenVINO's capabilities with this `quick start example <notebooks/201-vi
2. Install OpenVINO
###################
See the :doc:`installation overview page <get-started/install-openvino-overview>` for options to install OpenVINO and set up a development environment on your device.
See the :doc:`installation overview page <get-started/install-openvino>` for options to install OpenVINO and set up a development environment on your device.
.. _get-started-learn-openvino/interactive-tutorials-python:
3. Learn OpenVINO
#################
OpenVINO provides a wide array of examples and documentation showing how to work with models, run inference, and deploy applications. Step through the sections below to learn the basics of OpenVINO and explore its advanced optimization features. For further details, visit :doc:`OpenVINO documentation <documentation>`.
OpenVINO users of all experience levels can try `Intel® DevCloud <https://www.intel.com/content/www/us/en/developer/tools/devcloud/edge/overview.html>`__ , a free web-based service for developing, testing, and running OpenVINO applications on an online cluster of the latest Intel® hardware.
.. _openvino-basics:
@ -62,7 +62,7 @@ OpenVINO Basics
+++++++++++++++
Learn the basics of working with models and inference in OpenVINO. Begin with “Hello World” Interactive Tutorials that show how to prepare models, run inference, and retrieve results using the OpenVINO API. Then, explore other examples from the Open Model Zoo and OpenVINO Code Samples that can be adapted for your own application.
.. _interactive-learn-openvino/interactive-tutorials-python:
Interactive Tutorials - Jupyter Notebooks
@ -81,7 +81,7 @@ OpenVINO Code Samples
---------------------
View :doc:`sample code <learn-openvino/openvino-samples>` for various C++ and Python applications that can be used as a starting point for your own application. For C++ developers, step through the :doc:`Get Started with C++ Samples <learn-openvino/openvino-samples/get-started-demos>` to learn how to build and run an image classification program that uses OpenVINOs C++ API.
.. _integrate-openvino:
Integrate OpenVINO With Your Application
@ -124,7 +124,7 @@ Pipeline and model configuration features in OpenVINO Runtime allow you to easil
* :doc:`Performance Hints <openvino-workflow/running-inference/optimize-inference/high-level-performance-hints>` automatically adjust runtime parameters to prioritize for low latency or high throughput
* :doc:`Dynamic Shapes <openvino-workflow/running-inference/dynamic-shapes>` reshapes models to accept arbitrarily-sized inputs, increasing flexibility for applications that encounter different data shapes
* :doc:`Benchmark Tool <learn-openvino/openvino-samples/benchmark-tool>` characterizes model performance in various hardware and pipeline configurations
.. _additional-about-openvino/additional-resources:
Additional Resources

View File

@ -14,8 +14,8 @@ Additional Configurations For Hardware
:maxdepth: 2
:hidden:
For GPU <configurations-header/configurations-intel-gpu>
For NPU <configurations-header/configurations-intel-npu>
For GPU <configurations/configurations-intel-gpu>
For NPU <configurations/configurations-intel-npu>
For certain use cases, you may need to install additional software, to use the full
potential of OpenVINO™. Check the following list for components for elements used in
@ -23,14 +23,14 @@ your workflow:
| **GPU drivers**
| If you want to run inference on a GPU, make sure your GPU's drivers are properly installed.
See the :doc:`guide on GPU configuration <configurations-header/configurations-intel-gpu>`
See the :doc:`guide on GPU configuration <configurations/configurations-intel-gpu>`
for details.
| **NPU drivers**
| Intel's Neural Processing Unit introduced with the Intel® Core™ Ultra generation of CPUs
(formerly known as Meteor Lake), is a low-power solution for offloading neural network computation.
If you want to run inference on an NPU, make sure your NPU's drivers are properly installed.
See the :doc:`guide on NPU configuration <configurations-header/configurations-intel-npu>`
See the :doc:`guide on NPU configuration <configurations/configurations-intel-npu>`
for details.
| **Open Computer Vision Library**

View File

@ -5,8 +5,8 @@ Configurations for Intel® Processor Graphics (GPU) with OpenVINO™
.. meta::
:description: Learn how to provide additional configuration for Intel®
Processor Graphics (GPU) to work with Intel® Distribution of
:description: Learn how to provide additional configuration for Intel®
Processor Graphics (GPU) to work with Intel® Distribution of
OpenVINO™ toolkit on your system.
@ -19,12 +19,12 @@ Linux
To use a GPU device for OpenVINO inference, you must install OpenCL runtime packages.
If you are using a discrete GPU (for example Arc 770), you must also be using a supported Linux kernel as per `documentation. <https://dgpu-docs.intel.com/driver/kernel-driver-types.html>`__
If you are using a discrete GPU (for example Arc 770), you must also be using a supported Linux kernel as per `documentation. <https://dgpu-docs.intel.com/driver/kernel-driver-types.html>`__
- For Arc GPU, kernel 6.2 or higher is recommended.
- For Arc GPU, kernel 6.2 or higher is recommended.
- For Max and Flex GPU, or Arc with kernel version lower than 6.2, you must also install the ``intel-i915-dkms`` and ``xpu-smi`` kernel modules as described in the installation ../../documentation for `Max/Flex <https://dgpu-docs.intel.com/driver/installation.html>`__ or `Arc. <https://dgpu-docs.intel.com/driver/client/overview.html>`__
Below are the instructions on how to install the OpenCL packages on supported Linux distributions. These instructions install the `Intel(R) Graphics Compute Runtime for oneAPI Level Zero and OpenCL(TM) Driver <https://github.com/intel/compute-runtime/releases/tag/23.22.26516.18>`__ and its dependencies:
Below are the instructions on how to install the OpenCL packages on supported Linux distributions. These instructions install the `Intel(R) Graphics Compute Runtime for oneAPI Level Zero and OpenCL(TM) Driver <https://github.com/intel/compute-runtime/releases/tag/23.22.26516.18>`__ and its dependencies:
- `Intel Graphics Memory Management Library <https://github.com/intel/gmmlib>`__
- `Intel® Graphics Compiler for OpenCL™ <https://github.com/intel/intel-graphics-compiler>`__
@ -36,45 +36,45 @@ Below are the instructions on how to install the OpenCL packages on supported Li
:sync: ubuntu-22
Download and install the `deb` packages published `here <https://github.com/intel/compute-runtime/releases/latest>`__ and install the apt package `ocl-icd-libopencl1` with the OpenCl ICD loader.
Alternatively, you can add the apt repository by following the `installation guide <https://dgpu-docs.intel.com/driver/installation.html#ubuntu-install-steps>`__. Then install the `ocl-icd-libopencl1`, `intel-opencl-icd`, `intel-level-zero-gpu` and `level-zero` apt packages:
.. code-block:: sh
apt-get install -y ocl-icd-libopencl1 intel-opencl-icd intel-level-zero-gpu level-zero
.. tab-item:: Ubuntu 20.04 LTS
:sync: ubuntu-20
Ubuntu 20.04 LTS is not updated with the latest driver versions. You can install the updated versions up to the version 22.43 from apt:
.. code-block:: sh
apt-get update && apt-get install -y --no-install-recommends curl gpg gpg-agent && \
curl https://repositories.intel.com/graphics/intel-graphics.key | gpg --dearmor --output /usr/share/keyrings/intel-graphics.gpg && \
echo 'deb [arch=amd64 signed-by=/usr/share/keyrings/intel-graphics.gpg] https://repositories.intel.com/graphics/ubuntu focal-legacy main' | tee /etc/apt/sources.list.d/intel.gpu.focal.list && \
apt-get update
apt-get update && apt-get install -y --no-install-recommends intel-opencl-icd intel-level-zero-gpu level-zero
Alternatively, download older `deb` version from `here <https://github.com/intel/compute-runtime/releases>`__. Note that older driver version might not include some of the bug fixes and might be not supported on some latest platforms. Check the supported hardware for the versions you are installing.
.. tab-item:: RedHat UBI 8
:sync: redhat-8
Follow the `guide <https://dgpu-docs.intel.com/driver/installation.html#rhel-install-steps>`__ to add Yum repository.
Install following packages:
Install following packages:
.. code-block:: sh
yum install intel-opencl level-zero intel-level-zero-gpu intel-igc-core intel-igc-cm intel-gmmlib intel-ocloc
Install the OpenCL ICD Loader via:
.. code-block:: sh
rpm -ivh http://mirror.centos.org/centos/8-stream/AppStream/x86_64/os/Packages/ocl-icd-2.2.12-1.el8.x86_64.rpm
.. _gpu guide windows:
Windows
@ -85,7 +85,7 @@ To install the Intel Graphics Driver for Windows, follow the `driver installatio
To check if the driver has been installed:
1. Type **device manager** in the **Search Windows** field and press Enter. **Device Manager** will open.
2. Click the drop-down arrow to display **Display Adapters**. You can see the adapter that is installed in your computer:
2. Click the drop-down arrow to display **Display Adapters**. You can see the adapter that is installed in your computer:
.. image:: ../../_static/images/DeviceManager.PNG
:width: 400
@ -118,11 +118,11 @@ Below are the required steps to make it work with OpenVINO:
wsl --update
wsl --shutdown
- When booting Ubuntu 20.04 or Ubuntu 22.04, install the same drivers as described above in the Linux section
.. note::
.. note::
In WSL, the GPU device is accessed via the character device `/dev/drx`, while for native Linux OS it is accessed via `/dev/dri`.
Additional Resources
@ -149,7 +149,7 @@ Whats Next?
############
* :doc:`GPU Device <../../openvino-workflow/running-inference/inference-devices-and-modes/gpu-device>`
* :doc:`Install Intel® Distribution of OpenVINO™ toolkit from a Docker Image <../install-openvino-overview/install-openvino-linux-header/install-openvino-archive-linux>`
* :doc:`Install Intel® Distribution of OpenVINO™ toolkit from a Docker Image <../install-openvino/install-openvino-linux/install-openvino-archive-linux>`
* `Docker CI framework for Intel® Distribution of OpenVINO™ toolkit <https://github.com/openvinotoolkit/docker_ci/blob/master/README.md>`__
* `Get Started with DockerHub CI for Intel® Distribution of OpenVINO™ toolkit <https://github.com/openvinotoolkit/docker_ci/blob/master/get-started.md>`__
* `Dockerfiles with Intel® Distribution of OpenVINO™ toolkit <https://github.com/openvinotoolkit/docker_ci/blob/master/dockerfiles/README.md>`__

View File

@ -1,43 +0,0 @@
.. {#openvino_docs_install_guides_installing_openvino_linux_header}
Install OpenVINO™ Runtime on Linux
====================================
.. meta::
:description: Learn how to install OpenVINO™ Runtime on Linux operating system.
You can use an archive, a PyPi package, APT, YUM, Conda Forge,
Homebrew or a Docker image.
.. toctree::
:maxdepth: 3
:hidden:
Use Archive <install-openvino-linux-header/install-openvino-archive-linux>
Use PyPI <install-openvino-shared/install-openvino-pip>
Use APT <install-openvino-linux-header/install-openvino-apt>
Use YUM <install-openvino-linux-header/install-openvino-yum>
Use Conda Forge <install-openvino-shared/install-openvino-conda>
Use vcpkg <install-openvino-shared/install-openvino-vcpkg>
Use Homebrew <install-openvino-shared/install-openvino-brew>
Use Conan <install-openvino-shared/install-openvino-conan>
Use Docker <install-openvino-shared/install-openvino-docker-linux>
If you want to install OpenVINO™ Runtime on Linux, you have the following options:
* :doc:`Install OpenVINO using an Archive File <install-openvino-linux-header/install-openvino-archive-linux>`
* :doc:`Install OpenVINO using PyPI <install-openvino-shared/install-openvino-pip>`
* :doc:`Install OpenVINO using APT <install-openvino-linux-header/install-openvino-apt>`
* :doc:`Install OpenVINO using YUM <install-openvino-linux-header/install-openvino-yum>`
* :doc:`Install OpenVINO using Conda Forge <install-openvino-shared/install-openvino-conda>`
* :doc:`Install OpenVINO using vcpkg <install-openvino-shared/install-openvino-vcpkg>`
* :doc:`Install OpenVINO using Homebrew <install-openvino-shared/install-openvino-brew>`
* :doc:`Install OpenVINO using Docker <install-openvino-shared/install-openvino-conan>`
* :doc:`Install OpenVINO using Conan Package Manager <install-openvino-shared/install-openvino-docker-linux>`

View File

@ -1,36 +0,0 @@
.. {#openvino_docs_install_guides_installing_openvino_macos_header}
Install OpenVINO™ Runtime for macOS
=====================================
.. meta::
:description: Learn how to install OpenVINO™ Runtime on macOS operating
system. You can use an archive, a PyPi package, Conda Forge
or Homebrew.
.. toctree::
:maxdepth: 3
:hidden:
Use Archive <install-openvino-macos-header/install-openvino-archive-macos>
Use Homebrew <install-openvino-shared/install-openvino-brew>
Use PyPI <install-openvino-shared/install-openvino-pip>
Use Conda Forge <install-openvino-shared/install-openvino-conda>
Use vcpkg <install-openvino-shared/install-openvino-vcpkg>
Use Conan <install-openvino-shared/install-openvino-conan>
If you want to install OpenVINO™ Runtime on macOS, you have the following options:
* :doc:`Install OpenVINO using an Archive File <install-openvino-macos-header/install-openvino-archive-macos>`
* :doc:`Install OpenVINO using PyPI <install-openvino-shared/install-openvino-pip>`
* :doc:`Install OpenVINO using Conda Forge <install-openvino-shared/install-openvino-conda>`
* :doc:`Install OpenVINO using Homebrew <install-openvino-shared/install-openvino-brew>`
* :doc:`Install OpenVINO using vcpkg <install-openvino-shared/install-openvino-vcpkg>`
* :doc:`Install OpenVINO using Conan Package Manager <install-openvino-shared/install-openvino-conan>`

View File

@ -1,35 +0,0 @@
.. {#openvino_docs_install_guides_installing_openvino_windows_header}
Install OpenVINO™ Runtime on Windows
======================================
.. meta::
:description: Learn how to install OpenVINO™ Runtime on Windows operating
system. You can use an archive, a PyPi package, Conda Forge,
or a Docker image.
.. toctree::
:maxdepth: 3
:hidden:
Use Archive <install-openvino-windows-header/install-openvino-archive-windows>
Use PyPI <install-openvino-shared/install-openvino-pip>
Use Conda Forge <install-openvino-shared/install-openvino-conda>
Use vcpkg <install-openvino-shared/install-openvino-vcpkg>
Use Docker <install-openvino-shared/install-openvino-docker-linux>
Use Conan <install-openvino-shared/install-openvino-conan>
If you want to install OpenVINO™ Runtime on Windows, you have the following options:
* :doc:`Install OpenVINO using an Archive File <install-openvino-windows-header/install-openvino-archive-windows>`
* :doc:`Install OpenVINO using PyPI <install-openvino-shared/install-openvino-pip>`
* :doc:`Install OpenVINO using Conda Forge <install-openvino-shared/install-openvino-conda>`
* :doc:`Install OpenVINO using vcpkg <install-openvino-shared/install-openvino-vcpkg>`
* :doc:`Install OpenVINO using Docker <install-openvino-shared/install-openvino-docker-linux>`
* :doc:`Install OpenVINO using Conan Package Manager <install-openvino-shared/install-openvino-conan>`

View File

@ -13,9 +13,9 @@ Install OpenVINO™ 2024.0
:maxdepth: 3
:hidden:
OpenVINO Runtime on Linux <install-openvino-overview/install-openvino-linux-header>
OpenVINO Runtime on Windows <install-openvino-overview/install-openvino-windows-header>
OpenVINO Runtime on macOS <install-openvino-overview/install-openvino-macos-header>
OpenVINO Runtime on Linux <install-openvino/install-openvino-linux>
OpenVINO Runtime on Windows <install-openvino/install-openvino-windows>
OpenVINO Runtime on macOS <install-openvino/install-openvino-macos>
.. raw:: html

View File

@ -74,7 +74,7 @@ Installing OpenVINO Runtime
Congratulations! You've just Installed OpenVINO! For some use cases you may still
need to install additional components. Check the
:doc:`list of additional configurations <../../configurations-header>`
:doc:`list of additional configurations <../configurations>`
to see if your case needs any of them.

View File

@ -68,7 +68,7 @@ Installing OpenVINO Runtime with Anaconda Package Manager
Congratulations! You've just Installed OpenVINO! For some use cases you may still
need to install additional components. Check the description below, as well as the
:doc:`list of additional configurations <../../configurations-header>`
:doc:`list of additional configurations <../configurations>`
to see if your case needs any of them.
Compiling with OpenVINO Runtime from Conda-Forge on Linux

View File

@ -39,7 +39,7 @@ To start using Dockerfiles the following conditions must be met:
.. note::
OpenVINO's `Docker <https://docs.docker.com/>`__ and :doc:`Bare Metal <../../install-openvino-overview>`
OpenVINO's `Docker <https://docs.docker.com/>`__ and :doc:`Bare Metal <../install-openvino>`
distributions are identical, so the ../../../documentation applies to both.
.. note::

View File

@ -0,0 +1,43 @@
.. {#openvino_docs_install_guides_installing_openvino_linux_header}
Install OpenVINO™ Runtime on Linux
====================================
.. meta::
:description: Learn how to install OpenVINO™ Runtime on Linux operating system.
You can use an archive, a PyPi package, APT, YUM, Conda Forge,
Homebrew or a Docker image.
.. toctree::
:maxdepth: 3
:hidden:
Use Archive <install-openvino-linux/install-openvino-archive-linux>
Use PyPI <install-openvino-pip>
Use APT <install-openvino-linux/install-openvino-apt>
Use YUM <install-openvino-linux/install-openvino-yum>
Use Conda Forge <install-openvino-conda>
Use vcpkg <install-openvino-vcpkg>
Use Homebrew <install-openvino-brew>
Use Conan <install-openvino-conan>
Use Docker <install-openvino-docker-linux>
If you want to install OpenVINO™ Runtime on Linux, you have the following options:
* :doc:`Install OpenVINO using an Archive File <install-openvino-linux/install-openvino-archive-linux>`
* :doc:`Install OpenVINO using PyPI <install-openvino-pip>`
* :doc:`Install OpenVINO using APT <install-openvino-linux/install-openvino-apt>`
* :doc:`Install OpenVINO using YUM <install-openvino-linux/install-openvino-yum>`
* :doc:`Install OpenVINO using Conda Forge <install-openvino-conda>`
* :doc:`Install OpenVINO using vcpkg <install-openvino-vcpkg>`
* :doc:`Install OpenVINO using Homebrew <install-openvino-brew>`
* :doc:`Install OpenVINO using Docker <install-openvino-conan>`
* :doc:`Install OpenVINO using Conan Package Manager <install-openvino-docker-linux>`

View File

@ -167,7 +167,7 @@ Run the following command:
Congratulations! You've just Installed OpenVINO! For some use cases you may still
need to install additional components. Check the
:doc:`list of additional configurations <../../configurations-header>`
:doc:`list of additional configurations <../../configurations>`
to see if your case needs any of them.
With the APT distribution, you can build OpenVINO sample files, as explained in the

View File

@ -236,7 +236,7 @@ Step 1: Download and Install the OpenVINO Core Components
Congratulations, you have finished the installation! For some use cases you may still
need to install additional components. Check the description below, as well as the
:doc:`list of additional configurations <../../configurations-header>`
:doc:`list of additional configurations <../../configurations>`
to see if your case needs any of them.
The ``/opt/intel/openvino_2023`` folder now contains the core components for OpenVINO.

View File

@ -144,11 +144,11 @@ Run the following command:
.. note::
You can additionally install Python API using one of the alternative methods (:doc:`conda <../install-openvino-shared/install-openvino-conda>` or :doc:`pip <../install-openvino-shared/install-openvino-pip>`).
You can additionally install Python API using one of the alternative methods (:doc:`conda <../install-openvino-conda>` or :doc:`pip <../install-openvino-pip>`).
Congratulations! You've just Installed OpenVINO! For some use cases you may still
need to install additional components. Check the
:doc:`list of additional configurations <../../configurations-header>`
:doc:`list of additional configurations <../../configurations>`
to see if your case needs any of them.
With the YUM distribution, you can build OpenVINO sample files, as explained in the

View File

@ -0,0 +1,36 @@
.. {#openvino_docs_install_guides_installing_openvino_macos_header}
Install OpenVINO™ Runtime for macOS
=====================================
.. meta::
:description: Learn how to install OpenVINO™ Runtime on macOS operating
system. You can use an archive, a PyPi package, Conda Forge
or Homebrew.
.. toctree::
:maxdepth: 3
:hidden:
Use Archive <install-openvino-macos/install-openvino-archive-macos>
Use Homebrew <install-openvino-brew>
Use PyPI <install-openvino-pip>
Use Conda Forge <install-openvino-conda>
Use vcpkg <install-openvino-vcpkg>
Use Conan <install-openvino-conan>
If you want to install OpenVINO™ Runtime on macOS, you have the following options:
* :doc:`Install OpenVINO using an Archive File <install-openvino-macos/install-openvino-archive-macos>`
* :doc:`Install OpenVINO using PyPI <install-openvino-pip>`
* :doc:`Install OpenVINO using Conda Forge <install-openvino-conda>`
* :doc:`Install OpenVINO using Homebrew <install-openvino-brew>`
* :doc:`Install OpenVINO using vcpkg <install-openvino-vcpkg>`
* :doc:`Install OpenVINO using Conan Package Manager <install-openvino-conan>`

View File

@ -116,7 +116,7 @@ Step 1: Install OpenVINO Core Components
Congratulations, you have finished the installation! For some use cases you may still
need to install additional components. Check the description below, as well as the
:doc:`list of additional configurations <../../configurations-header>`
:doc:`list of additional configurations <../../configurations>`
to see if your case needs any of them.
The ``/opt/intel/openvino_2023`` folder now contains the core components for OpenVINO.
@ -202,7 +202,7 @@ To delete the files:
Additional Resources
####################
* :doc:`Troubleshooting Guide for OpenVINO Installation & Configuration <../../install-openvino-overview>`
* :doc:`Troubleshooting Guide for OpenVINO Installation & Configuration <../../install-openvino>`
* Converting models for use with OpenVINO™: :ref:`Model Optimizer User 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>`

View File

@ -121,7 +121,7 @@ If installation was successful, you will see the list of available devices.
Congratulations! You've just Installed OpenVINO! For some use cases you may still
need to install additional components. Check the
:doc:`list of additional configurations <../../configurations-header>`
:doc:`list of additional configurations <../configurations>`
to see if your case needs any of them.

View File

@ -81,7 +81,7 @@ And running from terminal:
Congratulations! You've just Installed and used OpenVINO in your project! For some use cases you may still
need to install additional components. Check the
:doc:`list of additional configurations <../../configurations-header>`
:doc:`list of additional configurations <../configurations>`
to see if your case needs any of them.
Uninstalling OpenVINO

View File

@ -0,0 +1,35 @@
.. {#openvino_docs_install_guides_installing_openvino_windows_header}
Install OpenVINO™ Runtime on Windows
======================================
.. meta::
:description: Learn how to install OpenVINO™ Runtime on Windows operating
system. You can use an archive, a PyPi package, Conda Forge,
or a Docker image.
.. toctree::
:maxdepth: 3
:hidden:
Use Archive <install-openvino-windows/install-openvino-archive-windows>
Use PyPI <install-openvino-pip>
Use Conda Forge <install-openvino-conda>
Use vcpkg <install-openvino-vcpkg>
Use Docker <install-openvino-docker-linux>
Use Conan <install-openvino-conan>
If you want to install OpenVINO™ Runtime on Windows, you have the following options:
* :doc:`Install OpenVINO using an Archive File <install-openvino-windows/install-openvino-archive-windows>`
* :doc:`Install OpenVINO using PyPI <install-openvino-pip>`
* :doc:`Install OpenVINO using Conda Forge <install-openvino-conda>`
* :doc:`Install OpenVINO using vcpkg <install-openvino-vcpkg>`
* :doc:`Install OpenVINO using Docker <install-openvino-docker-linux>`
* :doc:`Install OpenVINO using Conan Package Manager <install-openvino-conan>`

View File

@ -133,7 +133,7 @@ Step 1: Download and Install OpenVINO Core Components
Congratulations, you have finished the installation! For some use cases you may still
need to install additional components. Check the description below, as well as the
:doc:`list of additional configurations <../../configurations-header>`
:doc:`list of additional configurations <../../configurations>`
to see if your case needs any of them.
The ``C:\Program Files (x86)\Intel\openvino_2023`` folder now contains the core components for OpenVINO.
@ -247,7 +247,7 @@ Use either of the following methods to delete the files:
Additional Resources
####################
* :doc:`Troubleshooting Guide for OpenVINO Installation & Configuration <../../install-openvino-overview>`
* :doc:`Troubleshooting Guide for OpenVINO Installation & Configuration <../../install-openvino>`
* 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>`

View File

@ -122,10 +122,10 @@ Troubleshooting Guide for OpenVINO™ Installation & Configuration
.. dropdown:: Check if proper drivers are installed
:doc:`Additional configurations <configurations-header>` may be
:doc:`Additional configurations <configurations>` may be
required in order to use OpenVINO with different hardware, such as Intel® GPU and NPU.
Make sure that the device you want to use for inference has the required driver installed,
as described in :doc:`additional configurations for GPU <configurations-header/configurations-intel-gpu>`.
as described in :doc:`additional configurations for GPU <configurations/configurations-intel-gpu>`.
.. dropdown:: Check firewall and network settings

View File

@ -29,7 +29,7 @@ Basic Usage
:sync: python
The Python ``benchmark_app`` is automatically installed when you install OpenVINO
using :doc:`PyPI <../../get-started/install-openvino-overview/install-openvino-shared/install-openvino-pip>`.
using :doc:`PyPI <../../get-started/install-openvino/install-openvino-pip>`.
Before running ``benchmark_app``, make sure the ``openvino_env`` virtual
environment is activated, and navigate to the directory where your model is located.

View File

@ -11,9 +11,9 @@ Get Started with Samples
To use OpenVINO samples, install OpenVINO using one of the following distributions:
* Archive files (recommended) - :doc:`Linux <../../get-started/install-openvino-overview/install-openvino-linux-header/install-openvino-archive-linux>` | :doc:`Windows <../../get-started/install-openvino-overview/install-openvino-windows-header/install-openvino-archive-windows>` | :doc:`macOS <../../get-started/install-openvino-overview/install-openvino-macos-header/install-openvino-archive-macos>`
* :doc:`APT <../../get-started/install-openvino-overview/install-openvino-linux-header/install-openvino-apt>` or :doc:`YUM <../../get-started/install-openvino-overview/install-openvino-linux-header/install-openvino-yum>` for Linux
* :doc:`Docker image <../../get-started/install-openvino-overview/install-openvino-shared/install-openvino-docker-linux>`
* Archive files (recommended) - :doc:`Linux <../../get-started/install-openvino/install-openvino-linux/install-openvino-archive-linux>` | :doc:`Windows <../../get-started/install-openvino/install-openvino-windows/install-openvino-archive-windows>` | :doc:`macOS <../../get-started/install-openvino/install-openvino-macos/install-openvino-archive-macos>`
* :doc:`APT <../../get-started/install-openvino/install-openvino-linux/install-openvino-apt>` or :doc:`YUM <../../get-started/install-openvino/install-openvino-linux/install-openvino-yum>` for Linux
* :doc:`Docker image <../../get-started/install-openvino/install-openvino-docker-linux>`
* `Build from source <https://github.com/openvinotoolkit/openvino/blob/master/docs/dev/build.md>`__
If you install OpenVINO Runtime via archive files, sample applications are created in the following directories:
@ -412,7 +412,7 @@ The following command shows how to run the Image Classification Code Sample usin
.. note::
* Running inference on Intel® Processor Graphics (GPU) requires :doc:`additional hardware configuration steps <../../get-started/configurations-header/configurations-intel-gpu>`, as described earlier on this page.
* Running inference on Intel® Processor Graphics (GPU) requires :doc:`additional hardware configuration steps <../../get-started/configurations/configurations-intel-gpu>`, as described earlier on this page.
* Running on GPU is not compatible with macOS.
.. tab-set::

View File

@ -27,7 +27,7 @@ Local Deployment Options
- using Debian / RPM packages - a recommended way for Linux operating systems;
- using PIP package manager on PyPI - the default approach for Python-based applications;
- using Docker images - if the application should be deployed as a Docker image, use a pre-built OpenVINO™ Runtime Docker image as a base image in the Dockerfile for the application container image. For more information about OpenVINO Docker images, refer to :doc:`Installing OpenVINO from Docker <../get-started/install-openvino-overview/install-openvino-shared/install-openvino-docker-linux>`
- using Docker images - if the application should be deployed as a Docker image, use a pre-built OpenVINO™ Runtime Docker image as a base image in the Dockerfile for the application container image. For more information about OpenVINO Docker images, refer to :doc:`Installing OpenVINO from Docker <../get-started/install-openvino/install-openvino-docker-linux>`
- Furthermore, to customize your OpenVINO Docker image, use the `Docker CI Framework <https://github.com/openvinotoolkit/docker_ci>`__ to generate a Dockerfile and build the image.
- Grab a necessary functionality of OpenVINO together with your application, also called "local distribution":
@ -74,5 +74,5 @@ Building a local distribution will require more detailed information, and you wi
.. note::
Depending on your target OpenVINO devices, the following configuration might be needed for deployed machines: :doc:`Configurations for GPU <../get-started/configurations-header/configurations-intel-gpu>`.
Depending on your target OpenVINO devices, the following configuration might be needed for deployed machines: :doc:`Configurations for GPU <../get-started/configurations/configurations-intel-gpu>`.

View File

@ -23,7 +23,7 @@ For an in-depth description of the GPU plugin, see:
- `OpenVINO Runtime GPU plugin source files <https://github.com/openvinotoolkit/openvino/tree/master/src/plugins/intel_gpu/>`__
- `Accelerate Deep Learning Inference with Intel® Processor Graphics <https://software.intel.com/en-us/articles/accelerating-deep-learning-inference-with-intel-processor-graphics>`__
The GPU plugin is a part of the Intel® Distribution of OpenVINO™ toolkit. For more information on how to configure a system to use it, see the :doc:`GPU configuration <../../../get-started/configurations-header/configurations-intel-gpu>`.
The GPU plugin is a part of the Intel® Distribution of OpenVINO™ toolkit. For more information on how to configure a system to use it, see the :doc:`GPU configuration <../../../get-started/configurations/configurations-intel-gpu>`.
Device Naming Convention
#######################################

View File

@ -14,7 +14,7 @@ you to offload certain neural network computation tasks from other devices,
for more streamlined resource management.
Note that the NPU plugin is currently available only with the Archive distribution of OpenVINO™
and you need to :doc:`install a proper NPU driver <../../../get-started/configurations-header/configurations-intel-npu>`
and you need to :doc:`install a proper NPU driver <../../../get-started/configurations/configurations-intel-npu>`
to use it successfully.
| **Supported Platforms:**

View File

@ -21,7 +21,7 @@ Integrate OpenVINO™ with Your Application
Following these steps, you can implement a typical OpenVINO™ Runtime inference
pipeline in your application. Before proceeding, make sure you have
:doc:`installed OpenVINO Runtime <../../get-started/install-openvino-overview>` and set environment variables (run ``<INSTALL_DIR>/setupvars.sh`` for Linux, ``setupvars.ps1`` for Windows PowerShell, or ``setupvars.bat`` for Windows CMD), otherwise, the ``OpenVINO_DIR`` variable won't be configured properly to pass ``find_package`` calls).
:doc:`installed OpenVINO Runtime <../../get-started/install-openvino>` and set environment variables (run ``<INSTALL_DIR>/setupvars.sh`` for Linux, ``setupvars.ps1`` for Windows PowerShell, or ``setupvars.bat`` for Windows CMD), otherwise, the ``OpenVINO_DIR`` variable won't be configured properly to pass ``find_package`` calls).
.. image:: ../../_static/images/IMPLEMENT_PIPELINE_with_API_C.svg

View File

@ -94,10 +94,10 @@ cards <https://www.intel.com/content/www/us/en/products/details/discrete-gpus/ar
and `Intel® Data Center GPU Flex
Series <https://www.intel.com/content/www/us/en/products/details/discrete-gpus/data-center-gpu/flex-series.html>`__.
To get started, first `install
OpenVINO <https://docs.openvino.ai/2024/get-started/install-openvino-overview.html>`__
OpenVINO <https://docs.openvino.ai/2024/get-started/install-openvino.html>`__
on a system equipped with one or more Intel GPUs. Follow the `GPU
configuration
instructions <https://docs.openvino.ai/2024/get-started/configurations-header/configurations-intel-gpu.html>`__
instructions <https://docs.openvino.ai/2024/get-started/configurations/configurations-intel-gpu.html>`__
to configure OpenVINO to work with your GPU. Then, read on to learn how
to accelerate inference with GPUs in OpenVINO!
@ -172,7 +172,7 @@ section.
If the GPUs are installed correctly on the system and still do not
appear in the list, follow the steps described
`here <https://docs.openvino.ai/2024/get-started/configurations-header/configurations-intel-gpu.html>`__
`here <https://docs.openvino.ai/2024/get-started/configurations/configurations-intel-gpu.html>`__
to configure your GPU drivers to work with OpenVINO. Once we have the
GPUs working with OpenVINO, we can proceed with the next sections.
@ -1400,7 +1400,7 @@ corresponding documentation:
- `Query Device
Properties <https://docs.openvino.ai/2024/openvino-workflow/running-inference/inference-devices-and-modes/query-device-properties.html>`__
- `Configurations for GPUs with
OpenVINO <https://docs.openvino.ai/2024/get-started/configurations-header/configurations-intel-gpu.html>`__
OpenVINO <https://docs.openvino.ai/2024/get-started/configurations/configurations-intel-gpu.html>`__
- `Benchmark Python
Tool <https://docs.openvino.ai/2024/learn-openvino/openvino-samples/benchmark-tool.html>`__
- `Asynchronous

View File

@ -28,7 +28,7 @@ Some Intel® CPUs might not have integrated GPU, so if you want to run OpenVINO
## 2. Make sure that OpenCL® Runtime is installed
OpenCL runtime is a part of the GPU driver on Windows, but on Linux it should be installed separately. For the installation tips, refer to [OpenVINO docs](https://docs.openvino.ai/2024/get-started/install-openvino-overview/install-openvino-linux-header.html) and [OpenCL Compute Runtime docs](https://github.com/intel/compute-runtime/tree/master/opencl/doc).
OpenCL runtime is a part of the GPU driver on Windows, but on Linux it should be installed separately. For the installation tips, refer to [OpenVINO docs](https://docs.openvino.ai/2024/get-started/install-openvino/install-openvino-linux.html) and [OpenCL Compute Runtime docs](https://github.com/intel/compute-runtime/tree/master/opencl/doc).
To get the support of Intel® Iris® Xe MAX Graphics with Linux, follow the [driver installation guide](https://dgpu-docs.intel.com/devices/iris-xe-max-graphics/index.html)
## 3. Make sure that user has all required permissions to work with GPU device

View File

@ -8,7 +8,7 @@ For more detailed information on how this sample works, check the dedicated [art
## Requriements
The Python benchmark_app is automatically installed when you install OpenVINO Developer Tools using [PyPI](https://docs.openvino.ai/2024/get-started/install-openvino-overview/install-openvino-shared/install-openvino-pip.html) Before running ``benchmark_app``, make sure the ``openvino_env`` virtual environment is activated, and navigate to the directory where your model is located.
The Python benchmark_app is automatically installed when you install OpenVINO Developer Tools using [PyPI](https://docs.openvino.ai/2024/get-started/install-openvino/install-openvino-pip.html) Before running ``benchmark_app``, make sure the ``openvino_env`` virtual environment is activated, and navigate to the directory where your model is located.
The benchmarking application works with models in the OpenVINO IR (``model.xml`` and ``model.bin``) and ONNX (``model.onnx``) formats.
Make sure to [convert your models](https://docs.openvino.ai/2024/documentation/legacy-features/transition-legacy-conversion-api/legacy-conversion-api.html) if necessary.