Troubleshooting guide update (#11896)
* Add Overview page * Revert "Add Overview page" * fix errors & formatting * fix article usage according to the styles * fix errors * update according to PXT comments * CVS-80775 * update support matrix with Python version * fix formatting * fix formatting * CVS-71745 * update formatting * fix formatting * fix formatting * fix links & errors * fix formatting * update bullet points * update * adjust the order * update * update * updates * update references * update * update * apply same updates with 22/1 * minor fix * update reference link * fix CVS-71846 * test * add troubleshooting steps * restructure get started home page * update navigation menu * update formatting * fix mistakes * update wording * update * rename configurations files * update wording * adjust the structure * update formatting * reverse the heading * test with formatting * 2nd version of Get Started homepage * add line breaks * change to ordered list * update wording * update content * updates * update DL workbench reference * update wording * update references to pip installations * remove redundant files * update headings * update * update * restructure * rename * updates * remove a comment * correct grammar * fix formatting * Update docs/install_guides/troubleshooting-steps.md Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com> * Update docs/install_guides/troubleshooting-steps.md Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com> * integrating comments * update * update * correct an error * update * typo * hiding CentOS issues * update verification steps * to show one change * to show the change * add comments * update comments * revert the changes * update formatting * test formatting * update code formatting * update formatting * Update docs/install_guides/troubleshooting-steps.md Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com> * update content, remove some comments * update Python installation info * update formatting * Update docs/install_guides/troubleshooting-steps.md Co-authored-by: Ryan Loney <ryanloney@gmail.com> * Update docs/install_guides/troubleshooting-steps.md Co-authored-by: Ryan Loney <ryanloney@gmail.com> * Update docs/install_guides/troubleshooting-steps.md Co-authored-by: Ryan Loney <ryanloney@gmail.com> * Update docs/install_guides/troubleshooting-steps.md Co-authored-by: Ryan Loney <ryanloney@gmail.com> * Update docs/install_guides/troubleshooting-steps.md Co-authored-by: Ryan Loney <ryanloney@gmail.com> * Update docs/install_guides/troubleshooting-steps.md Co-authored-by: Ryan Loney <ryanloney@gmail.com> * Update docs/install_guides/troubleshooting-steps.md Co-authored-by: Ryan Loney <ryanloney@gmail.com> * Update docs/install_guides/troubleshooting-steps.md Co-authored-by: Ryan Loney <ryanloney@gmail.com> * Update docs/install_guides/troubleshooting-steps.md Co-authored-by: Ryan Loney <ryanloney@gmail.com> * update wording * test formatting * update formatting * update formatting * fix formatting Co-authored-by: Helena Kloosterman <helena.kloosterman@intel.com> Co-authored-by: Ryan Loney <ryanloney@gmail.com>
This commit is contained in:
Yuan Xu
GitHub
parent
1341c0d6f4
commit
5008ee8090
@ -198,46 +198,17 @@ Developing in C++:
|
||||
|
||||
To uninstall the toolkit, follow the steps on the [Uninstalling page](uninstalling-openvino.md).
|
||||
|
||||
@sphinxdirective
|
||||
|
||||
.. dropdown:: Troubleshooting
|
||||
|
||||
PRC developers might encounter pip errors during Intel® Distribution of 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:
|
||||
|
||||
.. 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``.
|
||||
|
||||
* If you run into incompatibility issues between components after installing new Intel® Distribution of OpenVINO™ version, try running ``requirements.txt`` with the following command:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
pip install -r <INSTALL_DIR>/tools/requirements.txt
|
||||
|
||||
@endsphinxdirective
|
||||
## Additional Resources
|
||||
|
||||
@sphinxdirective
|
||||
|
||||
.. dropdown:: Additional Resources
|
||||
|
||||
* 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`_
|
||||
* :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>`
|
||||
* 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`_
|
||||
|
||||
<!---
|
||||
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 MXNet Modele <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
|
||||
.. _Intel® IoT Developer Kit: https://github.com/intel-iot-devkit
|
||||
|
||||
@endsphinxdirective
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
|
||||
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 PRC Users
|
||||
## <a name="install-for-prc"></a>Errors with Installing via PIP for Users in China
|
||||
|
||||
PRC users might encounter errors while downloading sources via PIP during OpenVINO™ installation. To resolve the issues, try one of the following options:
|
||||
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:
|
||||
|
||||
@ -17,9 +17,8 @@ PRC users might encounter errors while downloading sources via PIP during OpenVI
|
||||
```
|
||||
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 installer, 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:
|
||||
|
||||
* For C++ developers, if you have installed OpenVINO Runtime via APT, YUM, or the installer, 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
|
||||
```
|
||||
|
||||
@ -8,33 +8,28 @@ If you run into issues while installing or configuring OpenVINO™, you can try
|
||||
```sh
|
||||
mo --version
|
||||
```
|
||||
* To check the version of OpenVINO Runtime, use the following command:
|
||||
* To check the version of OpenVINO Runtime, use the following code:
|
||||
```sh
|
||||
from openvino.runtime import get_version get_version()
|
||||
```
|
||||
|
||||
## 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.9. Note that Python 3.6 is not supported anymore.
|
||||
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.9. 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 Ubuntu and other Linux systems, use the Python version comes with the system, or install the `libpython3.X` libraries via the following commands (taking Python 3.7 as an example):
|
||||
```sh
|
||||
sudo apt-get install libpython3.7
|
||||
sudo apt-get install libpython3-dev
|
||||
```
|
||||
* For macOS, download a proper Python version from <https://www.python.org/> and install it. Note that macOS 10.x comes with python 2.7 installed, which is not supported, so you still need install Python from its official website.
|
||||
* 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 PIP, make sure that you have installed the latest version. To check and upgrade your PIP version, run the following command:
|
||||
'''sh
|
||||
```sh
|
||||
python -m pip install --upgrade pip
|
||||
'''
|
||||
```
|
||||
|
||||
<!--## Check the special tips for Anaconda installation-->
|
||||
|
||||
<!--missing part-->
|
||||
<!--add this part in future-->
|
||||
|
||||
|
||||
## Check if required external dependencies are installed
|
||||
@ -45,31 +40,50 @@ For C++ developers with Windows systems, make sure that Microsoft Visual Studio
|
||||
|
||||
## Check if environment variables are set correctly
|
||||
|
||||
- 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 installer, 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, your PATH variable may be configured incorrectly. Check if you have written the correct <INSTALL_DIR> or tried to activate it in the right 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.
|
||||
|
||||
- For Python developers, if you installed OpenVINO using the installer previously, and now are installing OpenVINO with PIP, remove all the PATH settings and the lines with `setupvars` from `.bashrc`.
|
||||
## Verify that OpenVINO is correctly installed
|
||||
|
||||
## Verify if OpenVINO is correctly installed
|
||||
@sphinxdirective
|
||||
|
||||
For Python developers, to verify if OpenVINO is correctly installed, use the following command:
|
||||
```sh
|
||||
python -c "from openvino.runtime import Core"
|
||||
```
|
||||
If OpenVINO was successfully installed, nothing will happen. If not, an error will be displayed.
|
||||
* For Python developers, to verify if OpenVINO is correctly installed, use the following command:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
python -c "from openvino.runtime import Core"
|
||||
|
||||
If OpenVINO was successfully installed, nothing will happen. If not, an error will be displayed.
|
||||
|
||||
* If you installed OpenVINO Runtime using the installer, 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 APT, use the ``apt list --installed | grep openvino`` command to list the installed OpenVINO packages.
|
||||
|
||||
* 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
|
||||
|
||||
[Additional configurations](configurations-header.md) are required in order to use OpenVINO on different hardware.
|
||||
[Additional configurations](configurations-header.md) may be required in order to use OpenVINO with different hardware such as Intel® GPUs.
|
||||
|
||||
To run inference on 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 [additional configurations for GPU](configurations-for-intel-gpu.md).
|
||||
|
||||
## Firewall/Network Issues
|
||||
## Check firewall and network settings
|
||||
|
||||
Make sure that your firewall and network settings are set correctly. For example, consider configuring system-wide proxy settings and specifying options for using PIP behind the proxy: `pip install --proxy http://address:port --trusted-host pypi.org openvino`.
|
||||
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:
|
||||
|
||||
For specific issues, see <a href="openvino_docs_get_started_guide_troubleshooting_issues.html#install-for-prc">Errors with Installing via PIP for PRC Users</a> and <a href="openvino_docs_get_started_guide_troubleshooting_issues.html#proxy-issues">proxy issues with installing OpenVINO on Linux from Docker</a>.
|
||||
@sphinxdirective
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
pip install --proxy http://address:port --trusted-host pypi.org openvino
|
||||
|
||||
@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>.
|
||||
@ -11,6 +11,12 @@
|
||||
|
||||
@endsphinxdirective
|
||||
|
||||
@sphinxdirective
|
||||
|
||||
.. _troubleshooting guide for install:
|
||||
|
||||
@endsphinxdirective
|
||||
|
||||
This guide will provide general troubleshooting steps and possible issues related to the installation and configuration of OpenVINO™.
|
||||
|
||||
If you met any issues, you are encouraged to run some [Troubleshooting Steps](./troubleshooting-steps.md) first, or look for information on the [Issues & Solutions](./troubleshooting-issues.md) page.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user