IntenseWebs/openvino
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add install dependencies info for APT & YUM (#15023)

Browse Source 
* add install dependencies info

* update according to comments

* fix formatting

* fix formatting

* small corrections

* fix formatting & issues

* minor correction
This commit is contained in:
Yuan Xu
2023-01-14 21:12:43 +08:00
committed by GitHub
parent 196d01b952
commit 9da0800b31
3 changed files with 57 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/install_guides/installing-model-dev-tools.md
View File

@@ -16,7 +16,7 @@ In both cases, Python 3.7 - 3.10 needs to be installed on your machine before st
## <a name="python-developers"></a>For Python Developers ## <a name="python-developers"></a>For Python Developers
If you are a Python developer, follow the steps in the <a href="openvino_docs_install_guides_install_dev_tools.html#install-dev-tools">Installing OpenVINO Development Tools</a> section on this page to install it. Installing OpenVINO Development Tools will also install OpenVINO Runtime as a dependency, so you don’t need to install OpenVINO Runtime separately. This option is recommended for new users. If you are a Python developer, follow the steps in the <a href="#install-dev-tools">Installing OpenVINO Development Tools</a> section on this page to install it. Installing OpenVINO Development Tools will also install OpenVINO Runtime as a dependency, so you don’t need to install OpenVINO Runtime separately. This option is recommended for new users.
## <a name="cpp-developers"></a>For C++ Developers ## <a name="cpp-developers"></a>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 [Install OpenVINO Runtime](./installing-openvino-runtime.md) 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 [Install OpenVINO Runtime](./installing-openvino-runtime.md) page to install OpenVINO Runtime from an archive file for your operating system.
@@ -162,7 +162,7 @@ Note that the commands are different for a Python installation and a C++ install
For more details on the openvino-dev PyPI package, see https://pypi.org/project/openvino-dev/. For more details on the openvino-dev PyPI package, see https://pypi.org/project/openvino-dev/.
### Step 4. Test the Installation ### Step 5. Test the Installation
To verify the package is properly installed, run the command below (this may take a few seconds): To verify the package is properly installed, run the command below (this may take a few seconds):

86
docs/install_guides/installing-openvino-apt.md
View File

@@ -8,6 +8,11 @@ This guide provides detailed steps for installing OpenVINO™ Runtime through th
.. warning:: By downloading and using this container and the included software, you agree to the terms and conditions of the `software license agreements <https://software.intel.com/content/dam/develop/external/us/en/documents/intel-openvino-license-agreements.pdf>`_. .. warning:: By downloading and using this container and the included software, you agree to the terms and conditions of the `software license agreements <https://software.intel.com/content/dam/develop/external/us/en/documents/intel-openvino-license-agreements.pdf>`_.
@endsphinxdirective
## Prerequisites
@sphinxdirective
.. tab:: System Requirements .. tab:: System Requirements
@@ -27,16 +32,16 @@ This guide provides detailed steps for installing OpenVINO™ Runtime through th
* GCC 7.5.0 (for Ubuntu 18.04) or GCC 9.3.0 (for Ubuntu 20.04) * GCC 7.5.0 (for Ubuntu 18.04) or GCC 9.3.0 (for Ubuntu 20.04)
* `Python 3.7 - 3.10, 64-bit <https://www.python.org/downloads/>`_ * `Python 3.7 - 3.10, 64-bit <https://www.python.org/downloads/>`_
| 
.. _installing-openvino-runtime: .. _installing-openvino-runtime:
Installing OpenVINO Runtime @endsphinxdirective
===========================
Step 1: Set Up the OpenVINO Toolkit APT Repository ## Installing OpenVINO Runtime
--------------------------------------------------
### Step 1: Set Up the OpenVINO Toolkit APT Repository
@sphinxdirective
#. Install the GPG key for the repository #. Install the GPG key for the repository
@@ -90,11 +95,14 @@ Step 1: Set Up the OpenVINO Toolkit APT Repository
apt-cache search openvino apt-cache search openvino
Step 2: Install OpenVINO Runtime Using the APT Package Manager @endsphinxdirective
--------------------------------------------------------------
Install OpenVINO Runtime
^^^^^^^^^^^^^^^^^^^^^^^^ ### Step 2: Install OpenVINO Runtime Using the APT Package Manager
#### Install OpenVINO Runtime
@sphinxdirective
.. tab:: The Latest Version .. tab:: The Latest Version
@@ -129,9 +137,11 @@ Install OpenVINO Runtime
You can use ``--no-install-recommends`` option to install only required packages. Keep in mind that the build tools must be installed **separately** if you want to compile the samples. You can use ``--no-install-recommends`` option to install only required packages. Keep in mind that the build tools must be installed **separately** if you want to compile the samples.
@endsphinxdirective
Check for Installed Packages and Versions #### Check for Installed Packages and Versions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@sphinxdirective
Run the following command: Run the following command:
@@ -140,8 +150,11 @@ Run the following command:
apt list --installed | grep openvino apt list --installed | grep openvino
Uninstall OpenVINO Runtime @endsphinxdirective
^^^^^^^^^^^^^^^^^^^^^^^^^^
#### Uninstalling OpenVINO Runtime
@sphinxdirective
.. tab:: The Latest Version .. tab:: The Latest Version
@@ -166,21 +179,29 @@ Uninstall OpenVINO Runtime
sudo apt autoremove openvino-2022.3.0 sudo apt autoremove openvino-2022.3.0
@endsphinxdirective
Step 3 (Optional): Install Software Dependencies ### Step 3 (Optional): Install Additional Components
------------------------------------------------
After you have installed OpenVINO Runtime, if you decided to :doc:`install OpenVINO Model Development Tools <openvino_docs_install_guides_install_dev_tools>`, make sure that you install external software dependencies first. @sphinxdirective
Refer to :ref:`Install External Software Dependencies <install-external-dependencies>` for detailed steps. OpenVINO Development Tools is a set of utilities for working with OpenVINO and OpenVINO models. It provides tools like Model Optimizer, Benchmark Tool, Post-Training Optimization Tool, and Open Model Zoo Downloader. If you install OpenVINO Runtime using APT, OpenVINO Development Tools must be installed separately.
Step 4 (Optional): Configure Inference on Non-CPU Devices See the **For C++ Developers** section on the :doc:`Install OpenVINO Development Tools <openvino_docs_install_guides_install_dev_tools>` page for instructions.
---------------------------------------------------------
@endsphinxdirective
### Step 4 (Optional): Configure Inference on Non-CPU Devices
@sphinxdirective
To enable the toolkit components to use processor graphics (GPU) on your system, follow the steps in :doc:`GPU Setup Guide <openvino_docs_install_guides_configurations_for_intel_gpu>`. To enable the toolkit components to use processor graphics (GPU) on your system, follow the steps in :doc:`GPU Setup Guide <openvino_docs_install_guides_configurations_for_intel_gpu>`.
Step 5: Build Samples @endsphinxdirective
---------------------
### Step 5: Build Samples
@sphinxdirective
To build the C++ or C sample applications for Linux, run the ``build_samples.sh`` script: To build the C++ or C sample applications for Linux, run the ``build_samples.sh`` script:
@@ -199,21 +220,11 @@ To build the C++ or C sample applications for Linux, run the ``build_samples.sh`
For more information, refer to :ref:`Build the Sample Applications on Linux <build-samples-linux>`. For more information, refer to :ref:`Build the Sample Applications on Linux <build-samples-linux>`.
.. _installing-openvino-development-tools: @endsphinxdirective
Installing OpenVINO Development Tools ## What's Next?
=====================================
.. note: From the 2022.1 release, the OpenVINO™ Development Tools can be installed via PyPI only. @sphinxdirective
To install OpenVINO Development Tools, do the following steps:
#. :ref:`Install OpenVINO Runtime <installing-openvino-runtime>` if you haven't done it yet.
#. :ref:`Install External Software Dependencies <install-external-dependencies>`.
#. See the **For C++ Developers** section in :doc:`Install OpenVINO Development Tools <openvino_docs_install_guides_install_dev_tools>` for detailed steps.
What's Next?
============
Now you may continue with the following tasks: Now you may continue with the following tasks:
@@ -223,8 +234,11 @@ Now you may continue with the following tasks:
* To write your own OpenVINO™ applications, see :doc:`OpenVINO Runtime User Guide <openvino_docs_OV_UG_OV_Runtime_User_Guide>`. * To write your own OpenVINO™ applications, see :doc:`OpenVINO Runtime User Guide <openvino_docs_OV_UG_OV_Runtime_User_Guide>`.
* See sample applications in :doc:`OpenVINO™ Toolkit Samples Overview <openvino_docs_OV_UG_Samples_Overview>`. * See sample applications in :doc:`OpenVINO™ Toolkit Samples Overview <openvino_docs_OV_UG_Samples_Overview>`.
Additional Resources @endsphinxdirective
====================
## Additional Resources
@sphinxdirective
- Intel® Distribution of OpenVINO™ toolkit home page: https://software.intel.com/en-us/openvino-toolkit. - Intel® Distribution of OpenVINO™ toolkit home page: https://software.intel.com/en-us/openvino-toolkit.
- For IoT Libraries & Code Samples see the `Intel® IoT Developer Kit <https://github.com/intel-iot-devkit>`_. - For IoT Libraries & Code Samples see the `Intel® IoT Developer Kit <https://github.com/intel-iot-devkit>`_.

11
docs/install_guides/installing-openvino-yum.md
View File

@@ -6,7 +6,7 @@ This guide provides installation steps for OpenVINO™ Runtime for Linux distrib
> **IMPORTANT**: By downloading and using this container and the included software, you agree to the terms and conditions of the [software license agreements](https://software.intel.com/content/dam/develop/external/us/en/documents/intel-openvino-license-agreements.pdf). > **IMPORTANT**: By downloading and using this container and the included software, you agree to the terms and conditions of the [software license agreements](https://software.intel.com/content/dam/develop/external/us/en/documents/intel-openvino-license-agreements.pdf).
## System Requirements ## Prerequisites
@sphinxdirective @sphinxdirective
.. tab:: System Requirements .. tab:: System Requirements
@@ -110,7 +110,7 @@ Run the following command:
@endsphinxdirective @endsphinxdirective
#### Uninstall OpenVINO Runtime #### Uninstalling OpenVINO Runtime
@sphinxdirective @sphinxdirective
@@ -140,11 +140,10 @@ Run the following command:
@endsphinxdirective @endsphinxdirective
### Step 3 (Optional): Install Software Dependencies ### Step 3 (Optional): Install Additional Components
OpenVINO Development Tools is a set of utilities for working with OpenVINO and OpenVINO models. It provides tools like Model Optimizer, Benchmark Tool, Post-Training Optimization Tool, and Open Model Zoo Downloader. If you install OpenVINO Runtime using YUM, OpenVINO Development Tools must be installed separately.
After you have installed OpenVINO Runtime, if you decided to [install OpenVINO Model Development Tools](installing-model-dev-tools.md), make sure that you install external software dependencies first. See the **For C++ Developers** section on the [Install OpenVINO Development Tools](installing-model-dev-tools.md) page for instructions.
Refer to <a href="openvino_docs_install_guides_installing_openvino_linux.html#install-external-dependencies">Install External Software Dependencies</a> for detailed steps.
### Step 4 (Optional): Configure Inference on Non-CPU Devices ### Step 4 (Optional): Configure Inference on Non-CPU Devices