From 22679f931babe84a11a27c2c4eda6e0c789c883e Mon Sep 17 00:00:00 2001 From: Karol Blaszczak Date: Tue, 20 Feb 2024 20:43:31 +0100 Subject: [PATCH] [DOCS) install guide tweaks --- .../get-started/install-openvino-overview.rst | 1 - .../install-openvino-archive-macos.rst | 2 +- .../install-openvino-archive-windows.rst | 2 +- .../install-openvino-yocto.rst | 131 ---------------- .../troubleshooting-install-config.rst | 147 +++++++----------- .../convert-model-paddle.rst | 54 ------- 6 files changed, 59 insertions(+), 278 deletions(-) delete mode 100644 docs/articles_en/get-started/install-openvino-overview/install-openvino-yocto.rst diff --git a/docs/articles_en/get-started/install-openvino-overview.rst b/docs/articles_en/get-started/install-openvino-overview.rst index f7d82e4b4c75da..637b97e1680b38 100644 --- a/docs/articles_en/get-started/install-openvino-overview.rst +++ b/docs/articles_en/get-started/install-openvino-overview.rst @@ -16,7 +16,6 @@ Install OpenVINO™ 2024.0 OpenVINO Runtime on Linux OpenVINO Runtime on Windows OpenVINO Runtime on macOS - Create a Yocto Image .. raw:: html diff --git a/docs/articles_en/get-started/install-openvino-overview/install-openvino-macos-header/install-openvino-archive-macos.rst b/docs/articles_en/get-started/install-openvino-overview/install-openvino-macos-header/install-openvino-archive-macos.rst index d64346aaf96565..252154750cfb77 100644 --- a/docs/articles_en/get-started/install-openvino-overview/install-openvino-macos-header/install-openvino-archive-macos.rst +++ b/docs/articles_en/get-started/install-openvino-overview/install-openvino-macos-header/install-openvino-archive-macos.rst @@ -202,7 +202,7 @@ To delete the files: Additional Resources #################### -* :ref:`Troubleshooting Guide for OpenVINO Installation & Configuration ` +* :doc:`Troubleshooting Guide for OpenVINO Installation & Configuration ` * Converting models for use with OpenVINO™: :ref:`Model Optimizer User Guide ` * Writing your own OpenVINO™ applications: :ref:`OpenVINO™ Runtime User Guide ` * Sample applications: :ref:`OpenVINO™ Toolkit Samples Overview ` diff --git a/docs/articles_en/get-started/install-openvino-overview/install-openvino-windows-header/install-openvino-archive-windows.rst b/docs/articles_en/get-started/install-openvino-overview/install-openvino-windows-header/install-openvino-archive-windows.rst index 079e1cbd2c31c2..29d8c06e8f46e1 100644 --- a/docs/articles_en/get-started/install-openvino-overview/install-openvino-windows-header/install-openvino-archive-windows.rst +++ b/docs/articles_en/get-started/install-openvino-overview/install-openvino-windows-header/install-openvino-archive-windows.rst @@ -247,7 +247,7 @@ Use either of the following methods to delete the files: Additional Resources #################### -* :ref:`Troubleshooting Guide for OpenVINO Installation & Configuration ` +* :doc:`Troubleshooting Guide for OpenVINO Installation & Configuration ` * Converting models for use with OpenVINO™: :ref:`Model Optimizer Developer Guide ` * Writing your own OpenVINO™ applications: :ref:`OpenVINO™ Runtime User Guide ` * Sample applications: :ref:`OpenVINO™ Toolkit Samples Overview ` diff --git a/docs/articles_en/get-started/install-openvino-overview/install-openvino-yocto.rst b/docs/articles_en/get-started/install-openvino-overview/install-openvino-yocto.rst deleted file mode 100644 index bc29fc2d696a51..00000000000000 --- a/docs/articles_en/get-started/install-openvino-overview/install-openvino-yocto.rst +++ /dev/null @@ -1,131 +0,0 @@ -.. {#openvino_docs_install_guides_installing_openvino_yocto} - -Create a Yocto Image with Intel® Distribution of OpenVINO™ toolkit -===================================================================== - - -.. meta:: - :description: Learn how to create a Yocto image with Intel® Distribution of - OpenVINO™ toolkit on your host machine. - -This document provides instructions for creating a Yocto image with Intel® Distribution of OpenVINO™ toolkit. - -Follow the `Yocto Project official documentation `__ to set up and configure your host machine to be compatible with BitBake. - -Step 1: Set Up Environment -########################## - -1. Clone the repositories. - - .. code-block:: sh - - git clone https://git.yoctoproject.org/git/poky - git clone https://git.yoctoproject.org/meta-intel - git clone https://git.openembedded.org/meta-openembedded - git clone https://github.com/kraj/meta-clang.git - - -2. Set up the OpenEmbedded build environment. - - .. code-block:: sh - - source poky/oe-init-build-env - - -3. Add BitBake layers. - - .. code-block:: sh - - bitbake-layers add-layer ../meta-intel - bitbake-layers add-layer ../meta-openembedded/meta-oe - bitbake-layers add-layer ../meta-openembedded/meta-python - bitbake-layers add-layer ../meta-clang - - -4. Verify if layers were added (optional step). - - .. code-block:: sh - - bitbake-layers show-layers - - -5. Set up BitBake configurations. - Include extra configuration in the `conf/local.conf` file in your build directory as required. - - .. code-block:: sh - - # Build with SSE4.2, AVX2 etc. extensions - MACHINE = "intel-skylake-64" - - # Enable clDNN GPU plugin when needed. - # This requires meta-clang and meta-oe layers to be included in bblayers.conf - # and is not enabled by default. - PACKAGECONFIG:append:pn-openvino-inference-engine = " opencl" - - # Enable building OpenVINO Python API. - # This requires meta-python layer to be included in bblayers.conf. - PACKAGECONFIG:append:pn-openvino-inference-engine = " python3" - - # This adds OpenVINO related libraries in the target image. - CORE_IMAGE_EXTRA_INSTALL:append = " openvino-inference-engine" - - # This adds OpenVINO samples in the target image. - CORE_IMAGE_EXTRA_INSTALL:append = " openvino-inference-engine-samples" - - # Include OpenVINO Python API package in the target image. - CORE_IMAGE_EXTRA_INSTALL:append = " openvino-inference-engine-python3" - - # Include model conversion API in the target image. - CORE_IMAGE_EXTRA_INSTALL:append = " openvino-model-optimizer" - - -Step 2: Build a Yocto Image with OpenVINO Packages -################################################## - -Run BitBake to build your image with OpenVINO packages. For example, to build the minimal image, run the following command: - -.. code-block:: sh - - bitbake core-image-minimal - - -.. note:: - For validation/testing/reviewing purposes, you may consider using the ``nohup`` command and ensure that your vpn/ssh connection remains uninterrupted. - -Step 3: Verify the Yocto Image -############################## - -Verify that OpenVINO packages were built successfully. Run the following command: - -.. code-block:: sh - - oe-pkgdata-util list-pkgs | grep openvino - - -If the image build is successful, it will return the list of packages as below: - -.. code-block:: sh - - openvino-inference-engine - openvino-inference-engine-dbg - openvino-inference-engine-dev - openvino-inference-engine-python3 - openvino-inference-engine-samples - openvino-inference-engine-src - openvino-model-optimizer - openvino-model-optimizer-dbg - openvino-model-optimizer-dev - -Additional Resources -#################### - -- :ref:`Troubleshooting Guide ` -- `Yocto Project `__ - official documentation webpage -- `BitBake Tool `__ -- `Poky `__ -- `Meta-intel `__ -- `Meta-openembedded `__ -- `Meta-clang `__ - - - diff --git a/docs/articles_en/get-started/troubleshooting-install-config.rst b/docs/articles_en/get-started/troubleshooting-install-config.rst index 4ccfde3c66cdd1..fcdb6bda2c9c18 100644 --- a/docs/articles_en/get-started/troubleshooting-install-config.rst +++ b/docs/articles_en/get-started/troubleshooting-install-config.rst @@ -10,8 +10,6 @@ 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: @@ -19,13 +17,11 @@ Troubleshooting Guide for OpenVINO™ Installation & Configuration -.. _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 @@ -39,15 +35,6 @@ 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 /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: @@ -55,56 +42,13 @@ Troubleshooting Guide for OpenVINO™ Installation & Configuration 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: + If you meet proxy issues during the installation with Docker, you need set up proxy settings + for Docker. See the `Docker guide `__ + 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 @@ -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 `__ . - * 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 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 `__ . + * For Linux and macOS systems, download and install a proper Python version from the + `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: + 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 @@ -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 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 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 ` 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 `. + :doc:`Additional configurations ` 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 `. .. 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. diff --git a/docs/articles_en/openvino-workflow/model-preparation/convert-model-paddle.rst b/docs/articles_en/openvino-workflow/model-preparation/convert-model-paddle.rst index 46fae24b0233a6..12f65ea4fb1cb1 100644 --- a/docs/articles_en/openvino-workflow/model-preparation/convert-model-paddle.rst +++ b/docs/articles_en/openvino-workflow/model-preparation/convert-model-paddle.rst @@ -140,60 +140,6 @@ Supported PaddlePaddle Layers For the list of supported standard layers, refer to the :doc:`Supported Operations ` page. -Officially Supported PaddlePaddle Models -######################################## - -The following PaddlePaddle models have been officially validated and confirmed to work (as of OpenVINO 2022.1): - -.. list-table:: - :widths: 20 25 55 - :header-rows: 1 - - * - Model Name - - Model Type - - Description - * - ppocr-det - - optical character recognition - - Models are exported from `PaddleOCR `_. Refer to `READ.md `_. - * - ppocr-rec - - optical character recognition - - Models are exported from `PaddleOCR `_. Refer to `READ.md `_. - * - ResNet-50 - - classification - - Models are exported from `PaddleClas `_. Refer to `getting_started_en.md `_. - * - MobileNet v2 - - classification - - Models are exported from `PaddleClas `_. Refer to `getting_started_en.md `_. - * - MobileNet v3 - - classification - - Models are exported from `PaddleClas `_. Refer to `getting_started_en.md `_. - * - BiSeNet v2 - - semantic segmentation - - Models are exported from `PaddleSeg `_. Refer to `model_export.md `_. - * - DeepLab v3 plus - - semantic segmentation - - Models are exported from `PaddleSeg `_. Refer to `model_export.md `_. - * - Fast-SCNN - - semantic segmentation - - Models are exported from `PaddleSeg `_. Refer to `model_export.md `_. - * - OCRNET - - semantic segmentation - - Models are exported from `PaddleSeg `_. Refer to `model_export.md `_. - * - Yolo v3 - - detection - - Models are exported from `PaddleDetection `_. Refer to `EXPORT_MODEL.md `_. - * - ppyolo - - detection - - Models are exported from `PaddleDetection `_. Refer to `EXPORT_MODEL.md `_. - * - MobileNetv3-SSD - - detection - - Models are exported from `PaddleDetection `_. Refer to `EXPORT_MODEL.md `_. - * - U-Net - - semantic segmentation - - Models are exported from `PaddleSeg `_. Refer to `model_export.md `_. - * - BERT - - language representation - - Models are exported from `PaddleNLP `_. Refer to `README.md `_. Additional Resources ####################