From 859c03268b6cb00c9e0eca08373294fc13e21263 Mon Sep 17 00:00:00 2001 From: Karol Blaszczak Date: Tue, 8 Aug 2023 16:05:40 +0200 Subject: [PATCH] [DOCS] installation guide restructuring (#19044) --- .../integrate_with_your_application.md | 2 +- docs/benchmarks/performance_ov_vs_tf.md | 102 ---------- docs/get_started.md | 5 +- ...acos.md => --installing-openvino-macos.md} | 0 ...lling-openvino-raspbian-removedfromtoc.md} | 1 - ...me.md => --installing-openvino-runtime.md} | 3 +- ...ws.md => --installing-openvino-windows.md} | 0 ...openvino.md => --uninstalling-openvino.md} | 2 +- .../installing-model-dev-tools.md | 3 +- .../installing-openvino-from-archive-linux.md | 19 +- .../installing-openvino-from-archive-macos.md | 16 +- ...nstalling-openvino-from-archive-windows.md | 20 +- .../installing-openvino-overview.md | 76 +++----- docs/install_guides/troubleshooting-issues.md | 75 -------- docs/install_guides/troubleshooting-steps.md | 125 ------------- docs/install_guides/troubleshooting.md | 175 ++++++++++++++++-- docs/ovsa/ovsa_get_started.md | 59 ++---- 17 files changed, 262 insertions(+), 421 deletions(-) delete mode 100644 docs/benchmarks/performance_ov_vs_tf.md rename docs/install_guides/{installing-openvino-macos.md => --installing-openvino-macos.md} (100%) rename docs/install_guides/{installing-openvino-raspbian-removedfromtoc.md => --installing-openvino-raspbian-removedfromtoc.md} (98%) rename docs/install_guides/{installing-openvino-runtime.md => --installing-openvino-runtime.md} (92%) rename docs/install_guides/{installing-openvino-windows.md => --installing-openvino-windows.md} (100%) rename docs/install_guides/{uninstalling-openvino.md => --uninstalling-openvino.md} (91%) delete mode 100644 docs/install_guides/troubleshooting-issues.md delete mode 100644 docs/install_guides/troubleshooting-steps.md diff --git a/docs/OV_Runtime_UG/integrate_with_your_application.md b/docs/OV_Runtime_UG/integrate_with_your_application.md index 9e006270b8b..08ff6c8f3f4 100644 --- a/docs/OV_Runtime_UG/integrate_with_your_application.md +++ b/docs/OV_Runtime_UG/integrate_with_your_application.md @@ -20,7 +20,7 @@ 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 ` and set environment variables (run ``/setupvars.sh`` for Linux or ``setupvars.bat`` for Windows, otherwise, the ``OpenVINO_DIR`` variable won't be configured properly to pass ``find_package`` calls). +:doc:`installed OpenVINO Runtime ` and set environment variables (run ``/setupvars.sh`` for Linux or ``setupvars.bat`` for Windows, otherwise, the ``OpenVINO_DIR`` variable won't be configured properly to pass ``find_package`` calls). .. image:: _static/images/IMPLEMENT_PIPELINE_with_API_C.svg diff --git a/docs/benchmarks/performance_ov_vs_tf.md b/docs/benchmarks/performance_ov_vs_tf.md deleted file mode 100644 index 55ba34455c5..00000000000 --- a/docs/benchmarks/performance_ov_vs_tf.md +++ /dev/null @@ -1,102 +0,0 @@ -# OpenVINO™ and TensorFlow Comparison on Select Networks and Platforms - -This page presents the results of comparing OpenVINO™ and TensorFlow executing benchmarking on the same hardware platforms, and using neural network models based on the same original source models. All models were converted using the processes and conversion tools native to each framework. The hardware platforms represent a broad performance range, covering Intel® Celeron®, Intel® Core™, and Intel® Xeon® Scalable based platforms. (Refer to [System Description](https://docs.openvino.ai/resources/benchmark_files/system_configurations_2022.1.html) for further details). - -## deeplabv3 - -@sphinxdirective -.. raw:: html - -
- -@endsphinxdirective - -## densenet-121 - -@sphinxdirective -.. raw:: html - -
- -@endsphinxdirective - -## facenet-20180408-102900 - -@sphinxdirective -.. raw:: html - -
- -@endsphinxdirective - -## faster_rcnn_resnet50_coco - -@sphinxdirective -.. raw:: html - -
- -@endsphinxdirective - -## inception-v3 - -@sphinxdirective -.. raw:: html - -
- -@endsphinxdirective - -## inception-v4 - -@sphinxdirective -.. raw:: html - -
- -@endsphinxdirective - -## resnet-50 - -@sphinxdirective -.. raw:: html - -
- -@endsphinxdirective - -## ssd_mobilenet_v1_coco - -@sphinxdirective -.. raw:: html - -
- -@endsphinxdirective - -## ssd_resnet34_1200x1200 - -@sphinxdirective -.. raw:: html - -
- -@endsphinxdirective - -## yolo-v3-tiny - -@sphinxdirective -.. raw:: html - -
- -@endsphinxdirective - -## YOLOv4 - -@sphinxdirective -.. raw:: html - -
- -@endsphinxdirective \ No newline at end of file diff --git a/docs/get_started.md b/docs/get_started.md index ed93772cc90..88d37186e1f 100644 --- a/docs/get_started.md +++ b/docs/get_started.md @@ -11,9 +11,8 @@ :maxdepth: 1 :hidden: - Installing OpenVINO - Additional Configurations - Uninstalling + Install OpenVINO + Additional Hardware setup Troubleshooting diff --git a/docs/install_guides/installing-openvino-macos.md b/docs/install_guides/--installing-openvino-macos.md similarity index 100% rename from docs/install_guides/installing-openvino-macos.md rename to docs/install_guides/--installing-openvino-macos.md diff --git a/docs/install_guides/installing-openvino-raspbian-removedfromtoc.md b/docs/install_guides/--installing-openvino-raspbian-removedfromtoc.md similarity index 98% rename from docs/install_guides/installing-openvino-raspbian-removedfromtoc.md rename to docs/install_guides/--installing-openvino-raspbian-removedfromtoc.md index 9bdffe93189..6803e3d5a9e 100644 --- a/docs/install_guides/installing-openvino-raspbian-removedfromtoc.md +++ b/docs/install_guides/--installing-openvino-raspbian-removedfromtoc.md @@ -187,7 +187,6 @@ Now that you've installed OpenVINO Runtime, you're ready to run your own machine * `Basic object detection with the Hello Reshape SSD C++ sample `_ * `Automatic speech recognition C++ sample `_ -To uninstall the toolkit, follow the steps on the :doc:`Uninstalling page `. Additional Resources #################### diff --git a/docs/install_guides/installing-openvino-runtime.md b/docs/install_guides/--installing-openvino-runtime.md similarity index 92% rename from docs/install_guides/installing-openvino-runtime.md rename to docs/install_guides/--installing-openvino-runtime.md index 027126f6248..4af90ab5626 100644 --- a/docs/install_guides/installing-openvino-runtime.md +++ b/docs/install_guides/--installing-openvino-runtime.md @@ -1,4 +1,4 @@ -# Install OpenVINO™ Runtime {#openvino_docs_install_guides_install_runtime} +# Install OpenVINO™ Runtime @sphinxdirective @@ -26,4 +26,3 @@ Enjoy your journey with OpenVINO. @endsphinxdirective - diff --git a/docs/install_guides/installing-openvino-windows.md b/docs/install_guides/--installing-openvino-windows.md similarity index 100% rename from docs/install_guides/installing-openvino-windows.md rename to docs/install_guides/--installing-openvino-windows.md diff --git a/docs/install_guides/uninstalling-openvino.md b/docs/install_guides/--uninstalling-openvino.md similarity index 91% rename from docs/install_guides/uninstalling-openvino.md rename to docs/install_guides/--uninstalling-openvino.md index f2560048ad1..ae06acd75f4 100644 --- a/docs/install_guides/uninstalling-openvino.md +++ b/docs/install_guides/--uninstalling-openvino.md @@ -1,4 +1,4 @@ -# Uninstalling the Intel® Distribution of OpenVINO™ Toolkit {#openvino_docs_install_guides_uninstalling_openvino} +# Uninstalling the Intel® Distribution of OpenVINO™ Toolkit @sphinxdirective diff --git a/docs/install_guides/installing-model-dev-tools.md b/docs/install_guides/installing-model-dev-tools.md index a0be0427286..593edbe90d0 100644 --- a/docs/install_guides/installing-model-dev-tools.md +++ b/docs/install_guides/installing-model-dev-tools.md @@ -19,6 +19,7 @@ The instructions on this page show how to install OpenVINO Development Tools. If In both cases, Python 3.7 - 3.11 needs to be installed on your machine before starting. .. note:: + From the 2022.1 release, the OpenVINO™ Development Tools can only be installed via PyPI. .. _python_developers: @@ -33,7 +34,7 @@ If you are a Python developer, follow the steps in the :ref:`Installing OpenVINO For C++ Developers ################## -If you are a C++ developer, you must first install OpenVINO Runtime separately to set up the C++ libraries, sample code, and dependencies for building applications with OpenVINO. These files are not included with the PyPI distribution. See the :doc:`Install OpenVINO Runtime ` page to install OpenVINO Runtime from an archive file for your operating system. +If you are a C++ developer, you must first install OpenVINO Runtime separately to set up the 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 ` 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 ` section on this page to install it. diff --git a/docs/install_guides/installing-openvino-from-archive-linux.md b/docs/install_guides/installing-openvino-from-archive-linux.md index 878b30a5713..41ea83e8c90 100644 --- a/docs/install_guides/installing-openvino-from-archive-linux.md +++ b/docs/install_guides/installing-openvino-from-archive-linux.md @@ -304,7 +304,24 @@ Learn more about how to integrate a model in OpenVINO applications by trying out Uninstalling the Intel® Distribution of OpenVINO™ Toolkit ########################################################### -To uninstall the toolkit, follow the steps on the :doc:`Uninstalling page `. +If you have installed OpenVINO Runtime from archive files, you can uninstall it by deleting the archive files and the extracted folders. +Uninstallation removes all Intel® Distribution of OpenVINO™ Toolkit component files but does not affect user files in the installation directory. + +If you have created the symbolic link, remove the link first: + +.. code-block:: sh + + sudo rm /opt/intel/openvino_2023 + +To delete the files: + +.. code-block:: sh + + rm -r && rm + + + + Additional Resources diff --git a/docs/install_guides/installing-openvino-from-archive-macos.md b/docs/install_guides/installing-openvino-from-archive-macos.md index 48cb406db52..3d5d037639f 100644 --- a/docs/install_guides/installing-openvino-from-archive-macos.md +++ b/docs/install_guides/installing-openvino-from-archive-macos.md @@ -163,7 +163,21 @@ Now that you've installed OpenVINO Runtime, you're ready to run your own machine Uninstalling Intel® Distribution of OpenVINO™ Toolkit ##################################################### -To uninstall the toolkit, follow the steps on the :doc:`Uninstalling page `. +If you have installed OpenVINO Runtime from archive files, you can uninstall it by deleting the archive files and the extracted folders. +Uninstallation removes all Intel® Distribution of OpenVINO™ Toolkit component files but does not affect user files in the installation directory. + +If you have created the symbolic link, remove the link first: + +.. code-block:: sh + + sudo rm /opt/intel/openvino_2023 + +To delete the files: + +.. code-block:: sh + + rm -r && rm + Additional Resources #################### diff --git a/docs/install_guides/installing-openvino-from-archive-windows.md b/docs/install_guides/installing-openvino-from-archive-windows.md index b50b8b65581..ce9bd1636dc 100644 --- a/docs/install_guides/installing-openvino-from-archive-windows.md +++ b/docs/install_guides/installing-openvino-from-archive-windows.md @@ -219,7 +219,25 @@ Now that you've installed OpenVINO Runtime, you're ready to run your own machine Uninstalling OpenVINO Runtime ############################# -To uninstall OpenVINO, follow the steps on the :doc:`Uninstalling page ` +If you have installed OpenVINO Runtime from archive files, you can uninstall it by deleting the archive files and the extracted folders. +Uninstallation removes all Intel® Distribution of OpenVINO™ Toolkit component files but does not affect user files in the installation directory. + +If you have created the symbolic link, remove the link first. + +Use either of the following methods to delete the files: + +* Use Windows Explorer to remove the files. +* Open a Command Prompt and run: + +.. code-block:: sh + + rmdir /s + del + + + + + Additional Resources #################### diff --git a/docs/install_guides/installing-openvino-overview.md b/docs/install_guides/installing-openvino-overview.md index c617371ce5a..d60558f6e18 100644 --- a/docs/install_guides/installing-openvino-overview.md +++ b/docs/install_guides/installing-openvino-overview.md @@ -12,10 +12,11 @@ :maxdepth: 3 :hidden: - OpenVINO Runtime + OpenVINO Runtime on Linux + OpenVINO Runtime on Windows + OpenVINO Runtime on macOS OpenVINO Development Tools - Build from Source - Creating a Yocto Image + Create a Yocto Image .. raw:: html @@ -25,61 +26,32 @@ -Distribution channels of OpenVINO may differ slightly, with regard to supported hardware or available APIs (read installation guides for particular distributions for more details). -Moreover, OpenVINO Runtime and OpenVINO Development Tools offer different sets of tools, as follows: +Different OpenVINO distributions may differ with regard to supported hardware or available APIs. +Read installation guides for particular distributions for more details. -* **OpenVINO Runtime** contains the core set of libraries for running machine learning model inference on processor devices. -* **OpenVINO Development Tools** is a set of utilities for working with OpenVINO and OpenVINO models. It includes the following tools: - - Model Optimizer - - Post-Training Optimization Tool - - Benchmark Tool - - Accuracy Checker and Annotation Converter - - Model Downloader and other Open Model Zoo tools +| **OpenVINO Runtime:** +| contains the core set of libraries for running inference on various processing units. It is recommended for users who already have an optimized model + and want to deploy it in an application using OpenVINO for inference on their devices. + +| **OpenVINO Development Tools:** +| includes the OpenVINO Runtime for Python, as well as a set of utilities for optimizing models and validating performance. + It is recommended for users who want to optimize and verify their models before applying them in their applications. + For Python developers it is ready out-of-the-box, while for C++ development you need to install OpenVINO Runtime libraries separately. +| See the :ref:`For C++ Developers ` section of the install guide for detailed instructions. +| Development Tools provides: + * Model conversion API + * Benchmark Tool + * Accuracy Checker and Annotation Converter + * Post-Training Optimization Tool + * Model Downloader and other Open Model Zoo tools -Install OpenVINO Development Tools (recommended) -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +| **Build OpenVINO from source** +| OpenVINO Toolkit source files are available on GitHub as open source. If you want to build your own version of OpenVINO for your platform, + follow the `OpenVINO Build Instructions `__ . -The best way to get started with OpenVINO is to install OpenVINO Development Tools, which will also install the OpenVINO Runtime Python package as a dependency. Follow the instructions on the :doc:`Install OpenVINO Development Tools ` page to install it. -**Python** -For developers working in Python, OpenVINO Development Tools can easily be installed using PyPI. See the :ref:`For Python Developers ` section of the Install OpenVINO Development Tools page for instructions. - -**C++** - -For developers working in C++, the core OpenVINO Runtime libraries must be installed separately. Then, OpenVINO Development Tools can be installed using requirements files or PyPI. See the :ref:`For C++ Developers ` section of the Install OpenVINO Development Tools page for instructions. - -Install OpenVINO Runtime only -+++++++++++++++++++++++++++++++++++++++ - -OpenVINO Runtime may also be installed on its own without OpenVINO Development Tools. This is recommended for users who already have an optimized model and want to deploy it in an application that uses OpenVINO for inference on their device. To install OpenVINO Runtime only, follow the instructions on the :doc:`Install OpenVINO Runtime ` page. - -The following methods are available to install OpenVINO Runtime: - -* Linux: You can install OpenVINO Runtime using APT, YUM, archive files or Docker. See :doc:`Install OpenVINO on Linux `. -* Windows: You can install OpenVINO Runtime using archive files or Docker. See :doc:`Install OpenVINO on Windows `. -* macOS: You can install OpenVINO Runtime using archive files or Docker. See :doc:`Install OpenVINO on macOS `. - -Build OpenVINO from source -++++++++++++++++++++++++++++++++++++ - -Source files are also available in the OpenVINO Toolkit GitHub repository. If you want to build OpenVINO from source for your platform, follow the `OpenVINO Build Instructions `__ . - -Next Steps -########## - -Still unsure if you want to install OpenVINO toolkit? Check out the :doc:`OpenVINO tutorials ` to run example applications directly in your web browser without installing it locally. Here are some exciting demos you can explore: - -- `Monodepth Estimation with OpenVINO `__ -- `Live Style Transfer with OpenVINO `__ -- `OpenVINO API Tutorial `__ - -Follow these links to install OpenVINO: - -- :doc:`Install OpenVINO Development Tools ` -- :doc:`Install OpenVINO Runtime ` -- `Build from Source `__ @endsphinxdirective diff --git a/docs/install_guides/troubleshooting-issues.md b/docs/install_guides/troubleshooting-issues.md deleted file mode 100644 index 4f5b3020a85..00000000000 --- a/docs/install_guides/troubleshooting-issues.md +++ /dev/null @@ -1,75 +0,0 @@ -# Issues & Solutions for OpenVINO™ Installation & Configuration {#openvino_docs_get_started_guide_troubleshooting_issues} - -@sphinxdirective - -.. meta:: - :description: Get to know solutions for possible problems that may occur during - the installation and configuration of OpenVINO™ on your system. - -This page lists issues that you may encounter during the installation and configuration of OpenVINO™, as well as their possible solutions. - -.. _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: - - .. 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/ - - -* 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 /tools/requirements.txt - - For APT and YUM users, replace the ``INSTALL_DIR`` with ``/usr/share/openvino``. - - - -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 `__ for more details. - -.. _yocto_install_issues: - -Issues with Creating a Yocto Image for OpenVINO -############################################### - -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 - -@endsphinxdirective - diff --git a/docs/install_guides/troubleshooting-steps.md b/docs/install_guides/troubleshooting-steps.md deleted file mode 100644 index d51af50dd32..00000000000 --- a/docs/install_guides/troubleshooting-steps.md +++ /dev/null @@ -1,125 +0,0 @@ -# Troubleshooting Steps for OpenVINO™ Installation and Configurations {#openvino_docs_get_started_guide_troubleshooting_steps} - -@sphinxdirective - -.. meta:: - :description: Learn what checks you may perform after encountering problems during - the installation and configuration of OpenVINO™ on your system. - - -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 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: - - .. code-block:: 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.11. 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 `official website `__ . -* For Linux and macOS systems, download and install a proper Python version from `official website `__ . See the `Python Beginners' Guide `__ 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: - -.. code-block:: sh - - python -m pip install --upgrade pip - - - - - -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 :doc:`install OpenVINO Development 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 `__ . - -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: - - .. 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 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: - - .. code-block:: sh - - python -c "from openvino.runtime import Core; print(Core().available_devices)" - - If OpenVINO was successfully installed, you will see a list of 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 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. - -Check if GPU driver is installed -################################ - -:doc:`Additional configurations ` 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 :doc:`additional configurations for GPU `. - -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: - -.. 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 ` and :ref:`proxy issues with installing OpenVINO on Linux from Docker `. - -@endsphinxdirective - diff --git a/docs/install_guides/troubleshooting.md b/docs/install_guides/troubleshooting.md index 986430ee13d..1343ea1b1ec 100644 --- a/docs/install_guides/troubleshooting.md +++ b/docs/install_guides/troubleshooting.md @@ -8,21 +8,174 @@ of OpenVINO™ on your system. -.. toctree:: - :maxdepth: 2 - :hidden: - - Issues & Solutions - Troubleshooting Steps - - .. _troubleshooting guide for install: This guide provides general troubleshooting steps and solutions to possible issues that can be encountered while installing and configuring OpenVINO™. -The :doc:`Issues & Solutions ` 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. +.. _install_for_prc: -The :doc:`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. +.. dropdown:: Errors with Installing via PIP for Users in China -@endsphinxdirective + 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: + .. 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/ + + + * 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 /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 `__ for more details. + + .. _yocto_install_issues: + +.. dropdown:: Issues with Creating a Yocto Image for OpenVINO + + 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: + + .. code-block:: sh + + from openvino.runtime import get_version + get_version() + + +.. 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.7 and 3.11. 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 `official website `__ . + * For Linux and macOS systems, download and install a proper Python version from `official website `__ . See the `Python Beginners' Guide `__ 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: + + .. code-block:: sh + + python -m pip install --upgrade pip + + + + + +.. 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: + + .. 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 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 + + python -c "from openvino.runtime import Core; print(Core().available_devices)" + + If OpenVINO was successfully installed, you will see a list of 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 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. + +.. dropdown:: Check if GPU driver is installed + + :doc:`Additional configurations ` 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 :doc:`additional configurations for 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: + + .. 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 ` and :ref:`proxy issues with installing OpenVINO on Linux from Docker `. + +.. dropdown:: 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 :doc:`install OpenVINO Development 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 `__ . + +@endsphinxdirective \ No newline at end of file diff --git a/docs/ovsa/ovsa_get_started.md b/docs/ovsa/ovsa_get_started.md index e7e47da386a..dd80c2c1b8a 100644 --- a/docs/ovsa/ovsa_get_started.md +++ b/docs/ovsa/ovsa_get_started.md @@ -22,55 +22,26 @@ The OpenVINO™ Security Add-on works with the :doc:`OpenVINO™ Model Server - +.. dropdown:: OpenVINO™ Security Add-on Tool: As a Model Developer or Independent Software Vendor, you use the OpenVINO™ Security Add-on Tool (``ovsatool``) to generate a access controlled model and master license. + + - The Model Developer generates a access controlled model from the OpenVINO™ toolkit output. The access controlled model uses the model's Intermediate Representation (IR) files to create a access controlled output file archive that are distributed to Model Users. The Developer can also put the archive file in long-term storage or back it up without additional security. + - The Model Developer uses the OpenVINO™ Security Add-on Tool (ovsatool) to generate and manage cryptographic keys and related collateral for the access controlled models. Cryptographic material is only available in a virtual machine (VM) environment. The OpenVINO™ Security Add-on key management system lets the Model Developer to get external Certificate Authorities to generate certificates to add to a key-store. + - The Model Developer generates user-specific licenses in a JSON format file for the access controlled model. The Model Developer can define global or user-specific licenses and attach licensing policies to the licenses. For example, the Model Developer can add a time limit for a model or limit the number of times a user can run a model. -- The Model Developer generates a access controlled model from the OpenVINO™ toolkit output. The access controlled model uses the model's Intermediate Representation (IR) files to create a access controlled output file archive that are distributed to Model Users. The Developer can also put the archive file in long-term storage or back it up without additional security. +.. dropdown:: OpenVINO™ Security Add-on License Service: Use the OpenVINO™ Security Add-on License Service to verify user parameters. -- The Model Developer uses the OpenVINO™ Security Add-on Tool (ovsatool) to generate and manage cryptographic keys and related collateral for the access controlled models. Cryptographic material is only available in a virtual machine (VM) environment. The OpenVINO™ Security Add-on key management system lets the Model Developer to get external Certificate Authorities to generate certificates to add to a key-store. + - The Independent Software Vendor hosts the OpenVINO™ Security Add-on License Service, which responds to license validation requests when a user attempts to load a access controlled model in a model server. The licenses are registered with the OpenVINO™ Security Add-on License Service. + - When a user loads the model, the OpenVINO™ Security Add-on Runtime contacts the License Service to make sure the license is valid and within the parameters that the Model Developer defined with the OpenVINO™ Security Add-on Tool (``ovsatool``). The user must be able to reach the Independent Software Vendor's License Service over the Internet. -- The Model Developer generates user-specific licenses in a JSON format file for the access controlled model. The Model Developer can define global or user-specific licenses and attach licensing policies to the licenses. For example, the Model Developer can add a time limit for a model or limit the number of times a user can run a model. +.. dropdown:: OpenVINO™ Security Add-on Runtime: Users install and use the OpenVINO™ Security Add-on Runtime on a virtual machine. + + Users host the OpenVINO™ Security Add-on Runtime component in a virtual machine. + + Externally from the OpenVINO™ Security Add-on, the User adds the access controlled model to the OpenVINO™ Model Server config file. The OpenVINO™ Model Server attempts to load the model in memory. At this time, the OpenVINO™ Security Add-on Runtime component validates the user's license for the access controlled model against information stored in the License Service provided by the Independent Software Vendor. + + After the license is successfully validated, the OpenVINO™ Model Server loads the model and services the inference requests. -.. raw:: html - - - - -.. raw:: html - -
- - -- The Independent Software Vendor hosts the OpenVINO™ Security Add-on License Service, which responds to license validation requests when a user attempts to load a access controlled model in a model server. The licenses are registered with the OpenVINO™ Security Add-on License Service. - -- When a user loads the model, the OpenVINO™ Security Add-on Runtime contacts the License Service to make sure the license is valid and within the parameters that the Model Developer defined with the OpenVINO™ Security Add-on Tool (ovsatool). The user must be able to reach the Independent Software Vendor's License Service over the Internet. - -.. raw:: html - -
- - -.. raw:: html - -
- - -Users host the OpenVINO™ Security Add-on Runtime component in a virtual machine. - -Externally from the OpenVINO™ Security Add-on, the User adds the access controlled model to the OpenVINO™ Model Server config file. The OpenVINO™ Model Server attempts to load the model in memory. At this time, the OpenVINO™ Security Add-on Runtime component validates the user's license for the access controlled model against information stored in the License Service provided by the Independent Software Vendor. - -After the license is successfully validated, the OpenVINO™ Model Server loads the model and services the inference requests. - - -.. raw:: html - -
- - -
**Where the OpenVINO™ Security Add-on Fits into Model Development and Deployment**