Skip to content

Commit

Permalink
[DOCS) install guide tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
@kblaszczak-intel
kblaszczak-intel committed Feb 21, 2024
1 parent 6dbabb9 commit 22679f9
Show file tree
Hide file tree
Showing 6 changed files with 59 additions and 278 deletions.
1 change: 0 additions & 1 deletion docs/articles_en/get-started/install-openvino-overview.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ Install OpenVINO™ 2024.0
OpenVINO Runtime on Linux <openvino_docs_install_guides_installing_openvino_linux_header>
OpenVINO Runtime on Windows <openvino_docs_install_guides_installing_openvino_windows_header>
OpenVINO Runtime on macOS <openvino_docs_install_guides_installing_openvino_macos_header>
Create a Yocto Image <openvino_docs_install_guides_installing_openvino_yocto>


.. raw:: html
Expand Down
2 changes: 1 addition & 1 deletion ...nvino-overview/install-openvino-macos-header/install-openvino-archive-macos.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ To delete the files:
Additional Resources
####################

* :ref:`Troubleshooting Guide for OpenVINO Installation & Configuration <troubleshooting guide for install>`
* :doc:`Troubleshooting Guide for OpenVINO Installation & Configuration <openvino_docs_install_guides_overview>`
* 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>`
Expand Down
2 changes: 1 addition & 1 deletion ...o-overview/install-openvino-windows-header/install-openvino-archive-windows.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ Use either of the following methods to delete the files:
Additional Resources
####################

* :ref:`Troubleshooting Guide for OpenVINO Installation & Configuration <troubleshooting guide for install>`
* :doc:`Troubleshooting Guide for OpenVINO Installation & Configuration <openvino_docs_install_guides_overview>`
* 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>`
Expand Down
131 changes: 0 additions & 131 deletions docs/articles_en/get-started/install-openvino-overview/install-openvino-yocto.rst
View file

This file was deleted.

147 changes: 57 additions & 90 deletions docs/articles_en/get-started/troubleshooting-install-config.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,18 @@ Troubleshooting Guide for OpenVINO™ Installation & Configuration
of OpenVINO™ on your system.


.. _troubleshooting guide for install:

| 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:
| `Support for OpenVINO™ toolkit <https://www.intel.com/content/www/us/en/support/products/96066/software/development-software/openvino-toolkit.html>`__


.. _install_for_prc:

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

Users in China might encounter errors while downloading sources via PIP during OpenVINO™ installation. To resolve the issues, try one of the following options:

* Add the download source using the ``-i`` parameter with the Python ``pip`` command. For example:
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``
parameter with the Python ``pip`` command. For example:

.. code-block:: sh
Expand All @@ -39,72 +35,20 @@ Troubleshooting Guide for OpenVINO™ Installation & Configuration
pip install openvino-dev[tensorflow2] -i https://mirrors.aliyun.com/pypi/simple/
* For C++ developers, if you have installed OpenVINO Runtime via APT, YUM, or the archive file, and then installed OpenVINO Development Tools via PyPI, you may run into issues. To resolve that, install the components in ``requirements.txt`` by using the following command:

.. code-block:: sh
pip install -r <INSTALL_DIR>/tools/requirements.txt
For APT and YUM users, replace the ``INSTALL_DIR`` with ``/usr/share/openvino``.


.. dropdown:: Issues with Installing OpenVINO on Linux from Docker

.. _proxy-issues:

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

If you met 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>`__ for more details.

.. _yocto_install_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>`__
for more details.

.. dropdown:: Issues with Creating a Yocto Image for OpenVINO
.. dropdown:: Check the version of OpenVINO Runtime

Error while adding "meta-intel" layer
+++++++++++++++++++++++++++++++++++++

When using the ``bitbake-layers add-layer meta-intel`` command, the following error might occur:

.. code-block:: sh
NOTE: Starting bitbake server...
ERROR: The following required tools (as specified by HOSTTOOLS) appear to be unavailable in PATH, please install them in order to proceed: chrpath diffstat pzstd zstd
To resolve the issue, install the ``chrpath diffstat zstd`` tools:

.. code-block:: sh
sudo apt-get install chrpath diffstat zstd
3. If you run into issues while installing or configuring OpenVINO™, you can try the following methods to do some quick checks first.
.. dropdown:: Check the versions of OpenVINO Runtime and Development Tools
* To check the version of OpenVINO Development Tools, use the following command:
.. tab-set::
.. tab-item:: Python
:sync: py
.. code-block:: py
:force:
from openvino.tools.mo import convert_model
ov_model = convert_model(version=True)
.. tab-item:: CLI
:sync: cli
.. code-block:: sh
mo --version
* To check the version of OpenVINO Runtime, use the following code:
To check the version of OpenVINO Runtime, use the following command:

.. code-block:: sh
Expand All @@ -114,14 +58,21 @@ Troubleshooting Guide for OpenVINO™ Installation & Configuration
.. dropdown:: Check the versions of Python and PIP

To check your Python version, run ``python -VV`` or ``python --version``. The supported Python versions should be 64-bit and between 3.8 and 3.11. If you are using Python 3.7, you are recommended to upgrade the version to 3.8 or higher.
If your Python version does not meet the requirements, update Python:
To check your Python version, run ``python -VV`` or ``python --version``. The supported
Python versions are 64-bit, between 3.8 and 3.11. If your Python version does not meet the
requirements, you need to upgrade:

* For Windows, **do not install Python from a Windows Store** as it can cause issues. You are highly recommended to install Python from `official website <https://www.python.org/>`__ .
* For Linux and macOS systems, download and install a proper Python version from `official website <https://www.python.org/>`__ . See the `Python Beginners' Guide <https://wiki.python.org/moin/BeginnersGuide/Download>`__ for more information on selecting a version. Note that macOS 10.x comes with python 2.7 installed, which is not supported, so you must install Python from the official website.
* For Windows, **do not install Python from the Windows Store** as it can cause issues.
It is highly recommended that you install Python from the
`official website <https://www.python.org/>`__ .
* For Linux and macOS systems, download and install a proper Python version from the
`official website <https://www.python.org/>`__. See the
`Python Beginners' Guide <https://wiki.python.org/moin/BeginnersGuide/Download>`__
for more information on selecting a version. Note that macOS 10.x comes with python 2.7
installed, which is not supported, so you must install Python from the official website.

For PIP, make sure that you have installed the latest version. To check and upgrade your PIP version, run the following command:
For PIP, make sure that you have installed the latest version. To check and upgrade your PIP
version, run the following command:

.. code-block:: sh
Expand All @@ -130,47 +81,63 @@ 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, 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 ``PATH /.bashrc`` or Windows environment variables. After restarting your environment, you should see similar information as below:
- 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
``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
.. code-block:: sh
[setupvars.sh] OpenVINO™ environment initialized
- 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 the file is found in the ``~/.bashrc`` folder.
- 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
the file is found in the ``~/.bashrc`` folder.

.. dropdown:: Verify that OpenVINO is correctly installed

* For Python developers, to verify if OpenVINO is correctly installed, use the following command:
.. code-block:: sh
* For Python developers, to verify if OpenVINO is correctly installed, use the following
command:

python -c "from openvino import Core; print(Core().available_devices)"
.. code-block:: sh
If OpenVINO was successfully installed, you will see a list of available devices.
python -c "from openvino import Core; print(Core().available_devices)"
* If you installed OpenVINO Runtime using the archive file, you can search "openvino" in Apps & Features on a Windows system, or check your installation directory on Linux to see if OpenVINO is there.
If OpenVINO has been successfully installed, you will see a list of available devices.

* If you installed OpenVINO Runtime from APT, use the ``apt list --installed | grep openvino`` command to list the installed OpenVINO packages.
* If you install OpenVINO Runtime using the archive file, you can search "openvino" in
Apps & Features on a Windows system, or check your installation directory on Linux to see
if OpenVINO is there.

* If you installed OpenVINO Runtime from YUM, use the ``yum list installed 'openvino*'`` command to list the installed OpenVINO packages.
* If you install OpenVINO Runtime from APT, use the ``apt list --installed | grep openvino``
command to list the installed OpenVINO packages.

.. dropdown:: Check if GPU driver is installed
* If you install OpenVINO Runtime from YUM, use the ``yum list installed 'openvino*'``
command to list the installed OpenVINO packages.

:doc:`Additional configurations <openvino_docs_install_guides_configurations_header>` may be required in order to use OpenVINO with different hardware such as Intel® GPUs.
.. dropdown:: Check if proper drivers are installed

To run inference on an Intel® GPU, make sure that you have installed the correct GPU driver. To check that, see :doc:`additional configurations for GPU <openvino_docs_install_guides_configurations_for_intel_gpu>`.
:doc:`Additional configurations <openvino_docs_install_guides_configurations_header>` 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 <openvino_docs_install_guides_configurations_for_intel_gpu>`.

.. dropdown:: Check firewall and network settings

Make sure that your firewall and network settings are configured correctly. For example, consider configuring system-wide proxy settings and specifying options for using PIP behind the proxy:
Make sure that your firewall and network settings are configured correctly. For example,
consider configuring system-wide proxy settings and specifying options for using PIP behind
the proxy:

.. code-block:: sh
pip install --proxy http://address:port --trusted-host pypi.org openvino
For specific issues, see Errors with Installing via PIP for Users in China and Proxy issues with installing OpenVINO on Linux from Docker questions above.
For specific issues, see Errors with Installing via PIP for Users in China and Proxy issues
with installing OpenVINO on Linux from Docker questions above.


Loading

0 comments on commit 22679f9

Please sign in to comment.