Skip to content

Commit

Permalink
DOCS-include-Ubuntu-24.04-support
Browse files Browse the repository at this point in the history
  • Loading branch information
kblaszczak-intel committed May 27, 2024
1 parent d0e6f8f commit 9d62e31
Show file tree
Hide file tree
Showing 7 changed files with 52 additions and 42 deletions.
8 changes: 4 additions & 4 deletions docs/articles_en/about-openvino/additional-resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ Additional Resources


.. meta::
:description: Learn more about OpenVINO from benchmark results, case studies
:description: Learn more about OpenVINO from benchmark results, case studies
and lists of supported models, operations and devices.

.. toctree::
:maxdepth: 1
:hidden:

additional-resources/glossary
additional-resources/legal-information
Legal and Responsible AI Information <./additional-resources/legal-information>
additional-resources/telemetry
Case Studies <https://www.intel.com/openvino-success-stories>

Expand All @@ -23,9 +23,9 @@ Additional Resources

:doc:`Glossary <additional-resources/glossary>` contains terms used in OpenVINO.

:doc:`Legal Information <additional-resources/legal-information>` has trademark information and other legal statements.
:doc:`Legal and Responsible AI Information <additional-resources/legal-information>` provides trademark information and other legal statements.

:doc:`OpenVINO™ Telemetry <additional-resources/telemetry>` has detailed information on the telemetry data collection.
:doc:`OpenVINO™ Telemetry <additional-resources/telemetry>` has detailed information on the telemetry data collection.

`Case Studies <https://www.intel.com/openvino-success-stories>`__ are articles about real-world examples of OpenVINO™ usage.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. {#openvino_docs_Legal_Information}
Legal Information
=================
Legal and Responsible AI Information
=====================================


.. meta::
Expand Down Expand Up @@ -46,4 +46,12 @@ Intel Global Human Right Principles
Intel is committed to respecting human rights and avoiding causing or contributing to adverse
impacts on human rights. See `Intel's Global Human Rights Principles <https://www.intel.com/content/dam/www/central-libraries/us/en/documents/policy-human-rights.pdf>`__.
Intel's products and software are intended only to be used in applications that do not cause or
contribute to adverse impacts on human rights.
contribute to adverse impacts on human rights.

Model Card Statement
###########################################################

We recommend that users, wherever you are sourcing the model from, should check for a model card,
consult the model card for each model you access and use, and create one if you are developing
or updating a model. A model card is a short document that provides key information to assess
performance and validation and ensure appropriate use.
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. {#system_requirements}
System Requirements
===================

Expand Down Expand Up @@ -30,6 +28,7 @@ CPU

.. tab-item:: Supported Operating Systems

* Ubuntu 24.04 long-term support (LTS), 64-bit (Kernel 6.8+)
* Ubuntu 22.04 long-term support (LTS), 64-bit (Kernel 5.15+)
* Ubuntu 20.04 long-term support (LTS), 64-bit (Kernel 5.15+)
* Ubuntu 18.04 long-term support (LTS) with limitations, 64-bit (Kernel 5.4+)
Expand Down Expand Up @@ -59,6 +58,7 @@ GPU

.. tab-item:: Supported Operating Systems

* Ubuntu 24.04 long-term support (LTS), 64-bit
* Ubuntu 22.04 long-term support (LTS), 64-bit
* Ubuntu 20.04 long-term support (LTS), 64-bit
* Windows 10, 64-bit
Expand All @@ -75,7 +75,7 @@ GPU
for information about your processor.
* While this release of OpenVINO supports Ubuntu 20.04, the driver stack
for Intel discrete graphic cards does not fully support Ubuntu 20.04.
We recommend using Ubuntu 22.04 when executing on discrete graphics.
We recommend using Ubuntu 22.04 and later when executing on discrete graphics.
* The following minimum (i.e., used for old hardware) OpenCL™ driver's versions
were used during OpenVINO internal validation: 22.43 for Ubuntu 22.04, 21.48
for Ubuntu 20.04 and 21.49 for Red Hat Enterprise Linux 8 (some hardware may require
Expand All @@ -88,6 +88,7 @@ Intel® Neural Processing Unit

.. tab-item:: Operating Systems for NPU

* Ubuntu 24.04 long-term support (LTS), 64-bit
* Ubuntu 22.04 long-term support (LTS), 64-bit
* Windows 11, 64-bit (22H2, 23H2)

Expand All @@ -106,6 +107,7 @@ Operating systems and developer environment

.. tab-item:: Linux OS

* Ubuntu 24.04 with Linux kernel 6.8+
* Ubuntu 22.04 with Linux kernel 5.15+
* Ubuntu 20.04 with Linux kernel 5.15+
* Red Hat Enterprise Linux 8 with Linux kernel 5.4
Expand Down
2 changes: 1 addition & 1 deletion docs/articles_en/get-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ GET STARTED
Install OpenVINO <get-started/install-openvino>
Additional Hardware Setup <get-started/configurations>
Troubleshooting <get-started/troubleshooting-install-config>
System Requirements <about-openvino/system-requirements>
System Requirements <./about-openvino/release-notes-openvino/system-requirements>


.. raw:: html
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Configurations for Intel® NPU with OpenVINO™
===============================================

.. meta::
:description: Learn how to provide additional configuration for Intel®
:description: Learn how to provide additional configuration for Intel®
NPU to work with the OpenVINO™ toolkit on your system.


Expand All @@ -19,27 +19,27 @@ Make sure you use the most recent supported driver for your hardware setup.
The driver is maintained as open source and may be found in the following repository,
together with comprehensive information on installation and system requirements:
`github.com/intel/linux-npu-driver <https://github.com/intel/linux-npu-driver>`__

It is recommended to check for the latest version of the driver.

Make sure you use a supported OS version, as well as install make, gcc,
and Linux kernel headers. To check the NPU state, use the ``dmesg``
command in the console. A successful boot-up of the NPU should give you
a message like this one:

``[ 797.193201] [drm] Initialized intel_vpu 0.<version number> for 0000:00:0b.0 on minor 0``

The current requirement for inference on NPU is Ubuntu 22.04 with the kernel
version of 6.6 or higher.
The current requirement for inference on NPU is the minimum of Ubuntu 22.04, kernel
version of 6.6.

.. tab-item:: Windows

The Intel® NPU driver for Windows is available through Windows Update but
it may also be installed manually by downloading the
`NPU driver package <https://www.intel.com/content/www/us/en/download/794734/intel-npu-driver-windows.html>`__ and following the
it may also be installed manually by downloading the
`NPU driver package <https://www.intel.com/content/www/us/en/download/794734/intel-npu-driver-windows.html>`__ and following the
`Windows driver installation guide <https://support.microsoft.com/en-us/windows/update-drivers-manually-in-windows-ec62f46c-ff14-c91d-eead-d7126dc1f7b6>`__.

If a driver has already been installed you should be able to find
'Intel(R) NPU Accelerator' in Windows Device Manager. If you
If a driver has already been installed you should be able to find
'Intel(R) NPU Accelerator' in Windows Device Manager. If you
cannot find such a device, the NPU is most likely listed in "Other devices"
as "Multimedia Video Controller."
12 changes: 5 additions & 7 deletions docs/articles_en/get-started/install-openvino.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
.. {#openvino_docs_install_guides_overview}
Install OpenVINO™ 2024.0
Install OpenVINO™ 2024.2
==========================


Expand Down Expand Up @@ -36,17 +34,17 @@ Install OpenVINO™ 2024.0

.. tip::

OpenVINO 2024.0, described here, is not a Long-Term-Support version!
OpenVINO 2024.2, described here, is not a Long-Term-Support version!
All currently supported versions are:

* 2024.0 (development)
* 2024.2 (development)
* 2023.3 (LTS)
* 2022.3 (LTS)

Moreover, different OpenVINO distributions may support slightly different sets of features.
Read installation guides for particular distributions for more details.

.. dropdown:: Distribution Comparison for OpenVINO 2024.0
.. dropdown:: Distribution Comparison for OpenVINO 2024.2

=============== ========== ====== =============== ======== ============ ========== ========== ==========
Device Archives PyPI APT/YUM/ZYPPER Conda Homebrew vcpkg Conan npm
Expand All @@ -56,7 +54,7 @@ Install OpenVINO™ 2024.0
NPU V\* V\* V\ * n/a n/a n/a n/a V\*
=============== ========== ====== =============== ======== ============ ========== ========== ==========

| \* **Of the Linux systems, only Ubuntu 22.04 includes drivers for NPU device.**
| \* **Of the Linux systems, versions 22.04 and 24.04 include drivers for NPU.**
| **For Windows, CPU inference on ARM64 is not supported.**
| **Build OpenVINO from source**
Expand Down
32 changes: 17 additions & 15 deletions docs/articles_en/get-started/troubleshooting-install-config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ Troubleshooting Guide for OpenVINO™ Installation & Configuration
of OpenVINO™ on your system.


| This guide provides general troubleshooting steps and solutions to possible issues that
may be encountered while installing and configuring OpenVINO™. For a comprehensive
database of support topics on OpenVINO, go to:
| This article provides general troubleshooting steps and solutions to possible issues that you
may face while installing and configuring OpenVINO™. For a comprehensive database of support
topics on OpenVINO, go to:
| `Support for OpenVINO™ toolkit <https://www.intel.com/content/www/us/en/support/products/96066/software/development-software/openvino-toolkit.html>`__


.. dropdown:: Errors with Installing via PIP for Users in China
.. dropdown:: PIP for Users in China gives errors

Users in China might encounter errors while downloading sources via PIP during OpenVINO™
installation. To resolve the issues, try adding the download source using the ``-i``
Expand All @@ -34,16 +34,18 @@ Troubleshooting Guide for OpenVINO™ Installation & Configuration
pip install openvino-dev[tensorflow2] -i https://mirrors.aliyun.com/pypi/simple/
.. dropdown:: ImportError: cannot import name 'Core' from 'openvino'

.. dropdown:: Issues with Installing OpenVINO on Linux from Docker
This error may appear on systems lacking C++ components. Since it is almost exclusively a
Windows case, installing `Microsoft Visual C++ Redistributable [vc_redist.x64] <https://aka.ms/vs/17/release/vc_redist.x64.exe>`__
package may fix it. For more information on dependencies, check
:doc:`System Requirements <../about-openvino/release-notes-openvino/system-requirements>` and
:doc:`Additional Hardware Configurations <./configurations>`

.. _proxy-issues:
.. dropdown:: Proxy issues installing OpenVINO on Linux from Docker

Proxy Issues
++++++++++++

If you meet proxy issues during the installation with Docker, you need set up proxy settings
for Docker. See the `Docker guide <https://docs.docker.com/network/proxy/#set-proxy-using-the-cli>`__
If you face proxy issues during installation with Docker, you may need to set up proxy
settings for it. See the `Docker guide <https://docs.docker.com/network/proxy/#set-proxy-using-the-cli>`__
for more details.

.. dropdown:: Check the version of OpenVINO Runtime
Expand Down Expand Up @@ -81,22 +83,22 @@ Troubleshooting Guide for OpenVINO™ Installation & Configuration
.. dropdown:: Check if environment variables are set correctly

- For Python developers, if you previously installed OpenVINO using the archive file,
* For Python developers, if you previously installed OpenVINO using the archive file,
and are now installing OpenVINO using PIP, remove all the PATH settings and the lines with
``setupvars`` from ``.bashrc``. Note that if you installed OpenVINO with PIP in a virtual
environment, you don't need to set any environment variables.
- If you have installed OpenVINO before, you probably have added ``setupvars`` to your
* If you have installed OpenVINO before, you probably have added ``setupvars`` to your
``PATH /.bashrc`` or Windows environment variables. After restarting your environment,
you should see an information similar to the following:

.. code-block:: sh
[setupvars.sh] OpenVINO™ environment initialized
- If you don't see the information above, your PATH variables may be configured incorrectly.
* If you don't see the information above, your PATH variables may be configured incorrectly.
Check if you have typed the correct <INSTALL_DIR> or you are trying to activate in the
correct directory.
- If you added it to a ``.bashrc`` file, make sure that the command is correctly written and
* If you added it to a ``.bashrc`` file, make sure that the command is correctly written and
the file is found in the ``~/.bashrc`` folder.

.. dropdown:: Verify that OpenVINO is correctly installed
Expand Down

0 comments on commit 9d62e31

Please sign in to comment.