Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS shift to rst - Troubleshooting #16483

Merged
merged 5 commits into from
Mar 23, 2023
Merged

DOCS shift to rst - Troubleshooting #16483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a86c8a2
troubleshooting
msmykx-intel Mar 22, 2023
000677b
fix-1
msmykx-intel Mar 22, 2023
49dbde1
code-block fix
msmykx-intel Mar 22, 2023
b9ece4a
Update troubleshooting-issues.md
msmykx-intel Mar 22, 2023
dcad806
Merge branch 'master' into troubleshooting-rst-swtich-master
msmykx-intel Mar 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/install_guides/installing-openvino-yocto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ If the image build is successful, it will return the list of packages as below:
Additional Resources
####################

- :ref:`Troubleshooting Guide <yocto-install-issues>`
- :ref:`Troubleshooting Guide <yocto_install_issues>`
- `Yocto Project <https://docs.yoctoproject.org/>`__ - official documentation webpage
- `BitBake Tool <https://docs.yoctoproject.org/bitbake/>`__
- `Poky <https://git.yoctoproject.org/poky>`__
Expand Down
75 changes: 47 additions & 28 deletions docs/install_guides/troubleshooting-issues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,52 +1,71 @@
# Issues & Solutions for OpenVINO™ Installation & Configuration {#openvino_docs_get_started_guide_troubleshooting_issues}

@sphinxdirective

This page lists issues that you may encounter during the installation and configuration of OpenVINO™, as well as their possible solutions.

## <a name="install-for-prc"></a>Errors with Installing via PIP for Users in China
.. _install_for_prc:

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:

``` sh
pip install openvino-dev -i https://mirrors.aliyun.com/pypi/simple/
```
Use the ``--trusted-host`` parameter if the URL above is ``http`` instead of ``https``.
You can also run the following command to install specific framework. For example:
.. code-block:: sh

pip install openvino-dev -i https://mirrors.aliyun.com/pypi/simple/

Use the ``--trusted-host`` parameter if the URL above is ``http`` instead of ``https``.
You can also run the following command to install specific framework. For example:

.. code-block:: sh

pip install openvino-dev[tensorflow2] -i https://mirrors.aliyun.com/pypi/simple/

```
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:
``` sh
pip install -r <INSTALL_DIR>/tools/requirements.txt
```
For APT and YUM users, replace the `INSTALL_DIR` with `/usr/share/openvino`.

.. code-block:: sh

pip install -r <INSTALL_DIR>/tools/requirements.txt

For APT and YUM users, replace the ``INSTALL_DIR`` with ``/usr/share/openvino``.

<!-- this part was from Docker installation -->

## Issues with Installing OpenVINO on Linux from Docker
Issues with Installing OpenVINO on Linux from Docker
####################################################

.. _proxy-issues:

### <a name="proxy-issues"></a>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/) for more details.
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/>`__ for more details.

.. _yocto_install_issues:

@anchor yocto-install-issues
## Issues with Creating a Yocto Image for OpenVINO
Issues with Creating a Yocto Image for OpenVINO
###############################################

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

When using the `bitbake-layers add-layer meta-intel` command, the following error might occur:
```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
```
When using the ``bitbake-layers add-layer meta-intel`` command, the following error might occur:

To resolve the issue, install the `chrpath diffstat zstd` tools:
.. 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

```sh
sudo apt-get install chrpath diffstat zstd
```
@endsphinxdirective

89 changes: 51 additions & 38 deletions docs/install_guides/troubleshooting-steps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,56 +1,69 @@
# Troubleshooting Steps for OpenVINO™ Installation and Configurations {#openvino_docs_get_started_guide_troubleshooting_steps}

@sphinxdirective

If you run into issues while installing or configuring OpenVINO™, you can try the following methods to do some quick checks first.

## Check the versions of OpenVINO Runtime and Developement Tools
Check the versions of OpenVINO Runtime and Developement Tools
#############################################################

* To check the version of OpenVINO Development Tools, use the following command:
```sh
mo --version
```

.. code-block:: sh

mo --version

* To check the version of OpenVINO Runtime, use the following code:
```sh
from openvino.runtime import get_version get_version()
```

.. code-block:: sh

from openvino.runtime import get_version get_version()


## Check the versions of Python and PIP
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.7 and 3.10. If you are using Python 3.6, you are recommended to upgrade the version to 3.7 or higher.
To check your Python version, run ``python -VV`` or ``python --version``. The supported Python versions should be 64-bit and between 3.7 and 3.10. If you are using Python 3.6, you are recommended to upgrade the version to 3.7 or higher.

If your Python version does not meet the requirements, update Python:

* For Windows, **do not install Python from a Windows Store** as it can cause issues. You are highly recommended to install Python from <https://www.python.org/>.
* For Linux and macOS systems, download and install a proper Python version from <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 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 PIP, make sure that you have installed the latest version. To check and upgrade your PIP version, run the following command:
```sh
python -m pip install --upgrade pip
```

.. code-block:: sh

python -m pip install --upgrade pip

<!--## Check the special tips for Anaconda installation-->

<!--add this part in future-->


## Check if required external dependencies are installed (for pre-2022.2 releases)
Check if required external dependencies are installed (for pre-2022.2 releases)
###############################################################################

For OpenVINO releases prior to 2022.2:
- If you are using Ubuntu or RHEL 8 systems, and installed OpenVINO Runtime via the archive file, APT, or YUM repository, and then decided to [install OpenVINO Development Tools](installing-model-dev-tools.md), make sure that you **Install External Software Dependencies** first by following the steps in the corresponding installation pages.
- For C++ developers with Windows systems, make sure that Microsoft Visual Studio 2019 with MSBuild and CMake 3.14 or higher (64-bit) are installed. While installing Microsoft Visual Studio 2019, make sure that you have selected **Desktop development with C++** in the **Workloads** tab. If not, launch the installer again to select that option. For more information on modifying the installation options for Microsoft Visual Studio, see its [official support page](https://docs.microsoft.com/en-us/visualstudio/install/modify-visual-studio?view=vs-2019).

## Check if environment variables are set correctly
- If you are using Ubuntu or RHEL 8 systems, and installed OpenVINO Runtime via the archive file, APT, or YUM repository, and then decided to :doc:`install OpenVINO Development Tools <openvino_docs_install_guides_install_dev_tools>`, make sure that you **Install External Software Dependencies** first by following the steps in the corresponding installation pages.
- For C++ developers with Windows systems, make sure that Microsoft Visual Studio 2019 with MSBuild and CMake 3.14 or higher (64-bit) are installed. While installing Microsoft Visual Studio 2019, make sure that you have selected **Desktop development with C++** in the **Workloads** tab. If not, launch the installer again to select that option. For more information on modifying the installation options for Microsoft Visual Studio, see its `official support page <https://docs.microsoft.com/en-us/visualstudio/install/modify-visual-studio?view=vs-2019>`__ .

- 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:
```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.
Check if environment variables are set correctly
################################################

## Verify that OpenVINO is correctly installed
- 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:

@sphinxdirective
.. 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.

Verify that OpenVINO is correctly installed
###########################################

* For Python developers, to verify if OpenVINO is correctly installed, use the following command:

Expand All @@ -66,24 +79,24 @@ For OpenVINO releases prior to 2022.2:

* If you installed OpenVINO Runtime from YUM, use the ``yum list installed 'openvino*'`` command to list the installed OpenVINO packages.

@endsphinxdirective

## Check if GPU drvier is installed
Check if GPU drvier is installed
################################

[Additional configurations](configurations-header.md) may be required in order to use OpenVINO with different hardware such as Intel® GPUs.
:doc:`Additional configurations <openvino_docs_install_guides_configurations_header>` may be required in order to use OpenVINO with different hardware such as Intel® GPUs.

To run inference on an Intel® GPU, make sure that you have installed the correct GPU driver. To check that, see [additional configurations for GPU](configurations-for-intel-gpu.md).
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>`.

## Check firewall and network settings
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:

@sphinxdirective
.. code-block:: sh

pip install --proxy http://address:port --trusted-host pypi.org openvino

.. code-block:: sh

pip install --proxy http://address:port --trusted-host pypi.org openvino
For specific issues, see :ref:`Errors with Installing via PIP for Users in China <install_for_prc>` and :ref:`proxy issues with installing OpenVINO on Linux from Docker <proxy-issues>`.

@endsphinxdirective

For specific issues, see <a href="openvino_docs_get_started_guide_troubleshooting_issues.html#install-for-prc">Errors with Installing via PIP for Users in China</a> and <a href="openvino_docs_get_started_guide_troubleshooting_issues.html#proxy-issues">proxy issues with installing OpenVINO on Linux from Docker</a>.
12 changes: 5 additions & 7 deletions docs/install_guides/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,14 @@
Issues & Solutions <openvino_docs_get_started_guide_troubleshooting_issues>
Troubleshooting Steps <openvino_docs_get_started_guide_troubleshooting_steps>

@endsphinxdirective

@sphinxdirective

.. _troubleshooting guide for install:

@endsphinxdirective

This guide provides general troubleshooting steps and solutions to possible issues that can be encountered while installing and configuring OpenVINO™.

The [Issues & Solutions](./troubleshooting-issues.md) page lists common installation and configuration errors, and their possible solutions. If you encountered a specific error while installing or configuring OpenVINO, check this page to see if there is a solution.
The :doc:`Issues & Solutions <openvino_docs_get_started_guide_troubleshooting_issues>` page lists common installation and configuration errors, and their possible solutions. If you encountered a specific error while installing or configuring OpenVINO, check this page to see if there is a solution.

The :doc:`Troubleshooting Steps <openvino_docs_get_started_guide_troubleshooting_steps>` page provides a set of instructions for diagnosing and resolving installation and configuration issues. If you had problems during installation and configuration, walk through these steps to try and resolve your issue.

@endsphinxdirective

The [Troubleshooting Steps](./troubleshooting-steps.md) page provides a set of instructions for diagnosing and resolving installation and configuration issues. If you had problems during installation and configuration, walk through these steps to try and resolve your issue.