From e1d7c9238813f20286dc05b12a68a9a0edf8701c Mon Sep 17 00:00:00 2001 From: Karol Blaszczak Date: Tue, 28 Jan 2025 17:07:23 +0100 Subject: [PATCH] [DOCS] adding conf and troubleshoot to installation docs --- docs/articles_en/get-started.rst | 2 -- docs/articles_en/get-started/install-openvino.rst | 1 + .../get-started/{ => install-openvino}/configurations.rst | 0 .../configurations/configurations-intel-gpu.rst | 0 .../configurations/configurations-intel-npu.rst | 0 .../configurations/genai-dependencies.rst | 0 .../configurations}/troubleshooting-install-config.rst | 6 +++--- .../get-started/install-openvino/install-openvino-apt.rst | 2 +- .../install-openvino/install-openvino-archive-linux.rst | 4 ++-- .../install-openvino/install-openvino-archive-macos.rst | 2 +- .../install-openvino/install-openvino-archive-windows.rst | 2 +- .../get-started/install-openvino/install-openvino-brew.rst | 2 +- .../get-started/install-openvino/install-openvino-pip.rst | 2 +- .../get-started/install-openvino/install-openvino-vcpkg.rst | 2 +- .../get-started/install-openvino/install-openvino-yocto.rst | 2 +- .../get-started/install-openvino/install-openvino-yum.rst | 2 +- .../install-openvino/install-openvino-zypper.rst | 2 +- .../learn-openvino/openvino-samples/get-started-demos.rst | 2 +- docs/articles_en/openvino-workflow/deployment-locally.rst | 2 +- .../inference-devices-and-modes/gpu-device.rst | 2 +- docs/dev/pypi_publish/pypi-openvino-rt.md | 2 +- 21 files changed, 19 insertions(+), 20 deletions(-) rename docs/articles_en/get-started/{ => install-openvino}/configurations.rst (100%) rename docs/articles_en/get-started/{ => install-openvino}/configurations/configurations-intel-gpu.rst (100%) rename docs/articles_en/get-started/{ => install-openvino}/configurations/configurations-intel-npu.rst (100%) rename docs/articles_en/get-started/{ => install-openvino}/configurations/genai-dependencies.rst (100%) rename docs/articles_en/get-started/{ => install-openvino/configurations}/troubleshooting-install-config.rst (96%) diff --git a/docs/articles_en/get-started.rst b/docs/articles_en/get-started.rst index a394d8f23973bd..94299293113f91 100644 --- a/docs/articles_en/get-started.rst +++ b/docs/articles_en/get-started.rst @@ -12,8 +12,6 @@ GET STARTED :hidden: Install OpenVINO - Additional Hardware Setup - Troubleshooting System Requirements <./about-openvino/release-notes-openvino/system-requirements> diff --git a/docs/articles_en/get-started/install-openvino.rst b/docs/articles_en/get-started/install-openvino.rst index 7616a87d6f3384..8864a0bc8c6a06 100644 --- a/docs/articles_en/get-started/install-openvino.rst +++ b/docs/articles_en/get-started/install-openvino.rst @@ -16,6 +16,7 @@ Install OpenVINO™ 2025.0 OpenVINO Runtime on Windows OpenVINO Runtime on macOS Create an OpenVINO Yocto Image + Additional Hardware Setup and Troubleshooting .. raw:: html diff --git a/docs/articles_en/get-started/configurations.rst b/docs/articles_en/get-started/install-openvino/configurations.rst similarity index 100% rename from docs/articles_en/get-started/configurations.rst rename to docs/articles_en/get-started/install-openvino/configurations.rst diff --git a/docs/articles_en/get-started/configurations/configurations-intel-gpu.rst b/docs/articles_en/get-started/install-openvino/configurations/configurations-intel-gpu.rst similarity index 100% rename from docs/articles_en/get-started/configurations/configurations-intel-gpu.rst rename to docs/articles_en/get-started/install-openvino/configurations/configurations-intel-gpu.rst diff --git a/docs/articles_en/get-started/configurations/configurations-intel-npu.rst b/docs/articles_en/get-started/install-openvino/configurations/configurations-intel-npu.rst similarity index 100% rename from docs/articles_en/get-started/configurations/configurations-intel-npu.rst rename to docs/articles_en/get-started/install-openvino/configurations/configurations-intel-npu.rst diff --git a/docs/articles_en/get-started/configurations/genai-dependencies.rst b/docs/articles_en/get-started/install-openvino/configurations/genai-dependencies.rst similarity index 100% rename from docs/articles_en/get-started/configurations/genai-dependencies.rst rename to docs/articles_en/get-started/install-openvino/configurations/genai-dependencies.rst diff --git a/docs/articles_en/get-started/troubleshooting-install-config.rst b/docs/articles_en/get-started/install-openvino/configurations/troubleshooting-install-config.rst similarity index 96% rename from docs/articles_en/get-started/troubleshooting-install-config.rst rename to docs/articles_en/get-started/install-openvino/configurations/troubleshooting-install-config.rst index 8f5c338af160a3..73936f8b078d11 100644 --- a/docs/articles_en/get-started/troubleshooting-install-config.rst +++ b/docs/articles_en/get-started/install-openvino/configurations/troubleshooting-install-config.rst @@ -38,7 +38,7 @@ Troubleshooting Guide for OpenVINO™ Installation & Configuration Windows case, installing `Microsoft Visual C++ Redistributable [vc_redist.x64] `__ package may fix it. For more information on dependencies, check :doc:`System Requirements <../about-openvino/release-notes-openvino/system-requirements>` and - :doc:`Additional Hardware Configurations <./configurations>` + :doc:`Additional Hardware Configurations and Troubleshooting <../configurations>` .. dropdown:: Proxy issues installing OpenVINO on Linux from Docker @@ -122,10 +122,10 @@ Troubleshooting Guide for OpenVINO™ Installation & Configuration .. dropdown:: Check if proper drivers are installed - :doc:`Additional configurations ` may be + :doc:`Additional configurations <../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 `. + as described in :doc:`additional configurations for GPU <./configurations-intel-gpu>`. .. dropdown:: Check firewall and network settings diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-apt.rst b/docs/articles_en/get-started/install-openvino/install-openvino-apt.rst index d03fa8fe8b0dc5..35498fa64ee4b1 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-apt.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-apt.rst @@ -152,7 +152,7 @@ Run the following command: Congratulations! You've just Installed OpenVINO! For some use cases you may still need to install additional components. Check the -:doc:`list of additional configurations <../configurations>` +:doc:`list of additional configurations <./configurations>` to see if your case needs any of them. With the APT distribution, you can build OpenVINO sample files, as explained in the diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-archive-linux.rst b/docs/articles_en/get-started/install-openvino/install-openvino-archive-linux.rst index 7224d63d0380b9..5f89d4e95221d3 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-archive-linux.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-archive-linux.rst @@ -171,7 +171,7 @@ Step 1: Download and Install the OpenVINO Core Components Congratulations, you have finished the installation! For some use cases you may still need to install additional components. Check the description below, as well as the -:doc:`list of additional configurations <../configurations>` +:doc:`list of additional configurations <./configurations>` to see if your case needs any of them. The ``/opt/intel/openvino_2024`` folder now contains the core components for OpenVINO. @@ -273,7 +273,7 @@ To delete the files: Additional Resources ########################################################### -* :doc:`Troubleshooting Guide for OpenVINO Installation & Configuration <../troubleshooting-install-config>` +* :doc:`Troubleshooting Guide for OpenVINO Installation & Configuration <./configurations/troubleshooting-install-config>` * Converting models for use with OpenVINO™: :doc:`Convert a Model <../../../openvino-workflow/model-preparation>` * Writing your own OpenVINO™ applications: :doc:`OpenVINO™ Runtime User Guide <../../../openvino-workflow/running-inference>` * Sample applications: :doc:`OpenVINO™ Toolkit Samples Overview <../../../learn-openvino/openvino-samples>` diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-archive-macos.rst b/docs/articles_en/get-started/install-openvino/install-openvino-archive-macos.rst index 0cf2f5f31548dc..a3bbfcf8d6330b 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-archive-macos.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-archive-macos.rst @@ -100,7 +100,7 @@ Step 1: Install OpenVINO Core Components Congratulations, you have finished the installation! For some use cases you may still need to install additional components. Check the description below, as well as the -:doc:`list of additional configurations <../configurations>` +:doc:`list of additional configurations <./configurations>` to see if your case needs any of them. The ``/opt/intel/openvino_2024`` folder now contains the core components for OpenVINO. diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-archive-windows.rst b/docs/articles_en/get-started/install-openvino/install-openvino-archive-windows.rst index 52d1d6d4be0814..52899de206ff42 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-archive-windows.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-archive-windows.rst @@ -95,7 +95,7 @@ Step 1: Download and Install OpenVINO Core Components Congratulations, you have finished the installation! For some use cases you may still need to install additional components. Check the description below, as well as the -:doc:`list of additional configurations <../configurations>` +:doc:`list of additional configurations <./configurations>` to see if your case needs any of them. The ``C:\Program Files (x86)\Intel\openvino_2024`` folder now contains the core components for OpenVINO. diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-brew.rst b/docs/articles_en/get-started/install-openvino/install-openvino-brew.rst index 612a873e4ff5ed..033d3a80e5d57a 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-brew.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-brew.rst @@ -37,7 +37,7 @@ Installing OpenVINO Runtime Congratulations! You've just Installed OpenVINO! For some use cases you may still need to install additional components. Check the -:doc:`list of additional configurations <../configurations>` +:doc:`list of additional configurations <./configurations>` to see if your case needs any of them. diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-pip.rst b/docs/articles_en/get-started/install-openvino/install-openvino-pip.rst index c6031ab798cde4..df276a5aae4a1d 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-pip.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-pip.rst @@ -104,7 +104,7 @@ If installation was successful, you will see the list of available devices. Congratulations! You've just Installed OpenVINO! For some use cases you may still need to install additional components. Check the -:doc:`list of additional configurations <../configurations>` +:doc:`list of additional configurations <./configurations>` to see if your case needs any of them. diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-vcpkg.rst b/docs/articles_en/get-started/install-openvino/install-openvino-vcpkg.rst index 6d739b350f5b38..7e07c0871bf7d7 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-vcpkg.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-vcpkg.rst @@ -61,7 +61,7 @@ And running from terminal: Congratulations! You've just Installed and used OpenVINO in your project! For some use cases you may still need to install additional components. Check the -:doc:`list of additional configurations <../configurations>` +:doc:`list of additional configurations <./configurations>` to see if your case needs any of them. Uninstalling OpenVINO diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-yocto.rst b/docs/articles_en/get-started/install-openvino/install-openvino-yocto.rst index f8cf4badf932fc..eea1fc6cfe52dc 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-yocto.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-yocto.rst @@ -104,7 +104,7 @@ If the image build is successful, it will return the list of packages as below: Additional Resources #################### -- :doc:`Troubleshooting Guide <../troubleshooting-install-config>` +- :doc:`Troubleshooting Guide <./configurations/troubleshooting-install-config>` - `Official Yocto Project documentation `__ - `BitBake Tool `__ - `Poky `__ diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-yum.rst b/docs/articles_en/get-started/install-openvino/install-openvino-yum.rst index fc413f194a1e63..6a3d441a888cbd 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-yum.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-yum.rst @@ -113,7 +113,7 @@ Run the following command: Congratulations! You've just Installed OpenVINO! For some use cases you may still need to install additional components. Check the -:doc:`list of additional configurations <../configurations>` +:doc:`list of additional configurations <./configurations>` to see if your case needs any of them. With the YUM distribution, you can build OpenVINO sample files, as explained in the diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-zypper.rst b/docs/articles_en/get-started/install-openvino/install-openvino-zypper.rst index bc589dfdb48a8b..e27eda31429dc6 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-zypper.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-zypper.rst @@ -65,7 +65,7 @@ Run the following command: Congratulations! You've just Installed OpenVINO! For some use cases you may still need to install additional components. Check the -:doc:`list of additional configurations <../configurations>` +:doc:`list of additional configurations <./configurations>` to see if your case needs any of them. With the ZYPPER distribution, you can build OpenVINO sample files, as explained in the diff --git a/docs/articles_en/learn-openvino/openvino-samples/get-started-demos.rst b/docs/articles_en/learn-openvino/openvino-samples/get-started-demos.rst index e3d73833b8f093..f9ae7fcabbc129 100644 --- a/docs/articles_en/learn-openvino/openvino-samples/get-started-demos.rst +++ b/docs/articles_en/learn-openvino/openvino-samples/get-started-demos.rst @@ -409,7 +409,7 @@ The following command shows how to run the Image Classification Code Sample usin .. note:: - * Running inference on Intel® Processor Graphics (GPU) requires :doc:`additional hardware configuration steps <../../get-started/configurations/configurations-intel-gpu>`, as described earlier on this page. + * Running inference on Intel® Processor Graphics (GPU) requires :doc:`additional hardware configuration steps <../../get-started/install-openvino/configurations/configurations-intel-gpu>`, as described earlier on this page. * Running on GPU is not compatible with macOS. .. tab-set:: diff --git a/docs/articles_en/openvino-workflow/deployment-locally.rst b/docs/articles_en/openvino-workflow/deployment-locally.rst index a8cdd8949fb318..4c1d3676b770be 100644 --- a/docs/articles_en/openvino-workflow/deployment-locally.rst +++ b/docs/articles_en/openvino-workflow/deployment-locally.rst @@ -74,5 +74,5 @@ Building a local distribution will require more detailed information, and you wi .. note:: - Depending on your target OpenVINO devices, the following configuration might be needed for deployed machines: :doc:`Configurations for GPU <../get-started/configurations/configurations-intel-gpu>`. + Depending on your target OpenVINO devices, the following configuration might be needed for deployed machines: :doc:`Configurations for GPU <../get-started/install-openvino/configurations/configurations-intel-gpu>`. diff --git a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/gpu-device.rst b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/gpu-device.rst index 2adf3e7f9d1e4d..cb39fe7cb7dcac 100644 --- a/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/gpu-device.rst +++ b/docs/articles_en/openvino-workflow/running-inference/inference-devices-and-modes/gpu-device.rst @@ -21,7 +21,7 @@ For an in-depth description of the GPU plugin, see: - `OpenVINO Runtime GPU plugin source files `__ - `Start AI Development with Intel `__ -The GPU plugin is a part of the Intel® Distribution of OpenVINO™ toolkit. For more information on how to configure a system to use it, see the :doc:`GPU configuration <../../../get-started/configurations/configurations-intel-gpu>`. +The GPU plugin is a part of the Intel® Distribution of OpenVINO™ toolkit. For more information on how to configure a system to use it, see the :doc:`GPU configuration <../../../get-started/install-openvino/configurations/configurations-intel-gpu>`. Device Naming Convention ####################################### diff --git a/docs/dev/pypi_publish/pypi-openvino-rt.md b/docs/dev/pypi_publish/pypi-openvino-rt.md index 642eb12d65e8f9..9fcdbe284168d9 100644 --- a/docs/dev/pypi_publish/pypi-openvino-rt.md +++ b/docs/dev/pypi_publish/pypi-openvino-rt.md @@ -122,7 +122,7 @@ If installation was successful, you will see the list of available devices. ## Troubleshooting For general troubleshooting, see the -[Troubleshooting Guide for OpenVINO Installation](https://docs.openvino.ai/2025/get-started/troubleshooting-install-config.html). +[Troubleshooting Guide for OpenVINO Installation](https://docs.openvino.ai/2025/get-started/install-openvino/configurations/troubleshooting-install-config.html). The following sections also provide explanations to several error messages. ### Errors with Installing via PIP for Users in China