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

Yuan install guide 22/1 (#10786)

Browse Source 
* Add Overview page

* Revert "Add Overview page"

* fix errors & formatting

* fix article usage according to the styles

* fix errors

* update according to PXT comments
This commit is contained in:
Yuan Xu
2022-03-05 00:32:10 +08:00
committed by GitHub
parent cb9049076b
commit 3b24ed032a
10 changed files with 33 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/install_guides/configurations-for-ncs2.md
View File

@@ -6,6 +6,8 @@
@endsphinxdirective
This page introduces additional configurations for Intel® Neural Compute Stick 2 with Intel® Distribution of OpenVINO™ toolkit on Linux, Raspbian OS and macOS.
## Linux
Once you have your Intel® Distribution of OpenVINO™ toolkit installed, follow the steps to be able to work on NCS2:
@@ -83,9 +85,9 @@ Proceed to the [Get Started Guide](@ref get_started) section to learn the basic
These steps are required only if you want to perform inference on Intel® Neural Compute Stick 2 powered by the Intel® Movidius™ Myriad™ X VPU.
To perform inference on Intel® Neural Compute Stick 2, the `libusb` library is required. You can build it from the [source code](https://github.com/libusb/libusb) or install using the macOS package manager you prefer: [Homebrew*](https://brew.sh/), [MacPorts*](https://www.macports.org/) or other.
To perform inference on Intel® Neural Compute Stick 2, the `libusb` library is required. You can build it from the [source code](https://github.com/libusb/libusb) or install using the macOS package manager you prefer: [Homebrew](https://brew.sh/), [MacPorts](https://www.macports.org/) or other.
For example, to install the `libusb` library using Homebrew\*, use the following command:
For example, to install the `libusb` library using Homebrew, use the following command:
```sh
brew install libusb
```

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

@@ -8,8 +8,7 @@ If you want to download, convert, optimize and tune pre-trained deep learning mo
* Post-Training Optimization Tool
* Model Downloader and other Open Model Zoo tools
From the 2022.1 release, OpenVINO Development Tools can only be installed via PyPI.
> **NOTE**: From the 2022.1 release, the OpenVINO™ Development Tools can only be installed via PyPI.
## For C++ Developers

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

@@ -2,7 +2,7 @@
This guide provides installation steps for Intel® Distribution of OpenVINO™ toolkit for Linux distributed through the APT repository.
From 2022.1 release, the OpenVINO™ Development Tools can only be installed via PyPI. If you want to develop or optimize your models with OpenVINO, see [Install OpenVINO Development Tools](installing-model-dev-tools.md) for detailed steps.
> **NOTE**: From the 2022.1 release, the OpenVINO™ Development Tools can only be installed via PyPI. If you want to develop or optimize your models with OpenVINO, see [Install OpenVINO Development Tools](installing-model-dev-tools.md) for detailed steps.
> **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). Please review the content inside the `<INSTALL_DIR>/licensing` folder for more details.

2
docs/install_guides/installing-openvino-conda.md
View File

@@ -2,7 +2,7 @@
This guide provides installation steps for Intel® Distribution of OpenVINO™ toolkit for Linux distributed through the Anaconda Cloud.
From 2022.1 release, the OpenVINO™ Development Tools can only be installed via PyPI. If you want to develop or optimize your models with OpenVINO, see [Install OpenVINO Development Tools](installing-model-dev-tools.md) for detailed steps.
> **NOTE**: From the 2022.1 release, the OpenVINO™ Development Tools can only be installed via PyPI. If you want to develop or optimize your models with OpenVINO, see [Install OpenVINO Development Tools](installing-model-dev-tools.md) for detailed steps.
## System Requirements

6
docs/install_guides/installing-openvino-config-ivad-vpu.md
View File

@@ -11,7 +11,7 @@
@endsphinxdirective
The steps in this guide are only required if you want to perform inference on Intel® Vision Accelerator Design with Intel® Movidius™ VPUs.
The steps in this guide are only required if you want to perform inference on Intel® Vision Accelerator Design with Intel® Movidius™ VPUs with OpenVINO™ on Linux or Windows.
For troubleshooting issues, please see the [Troubleshooting Guide](troubleshooting.md) for more information.
@@ -19,7 +19,7 @@ For troubleshooting issues, please see the [Troubleshooting Guide](troubleshooti
For Intel® Vision Accelerator Design with Intel® Movidius™ VPUs, the following additional installation steps are required.
> **NOTE**: If you installed the Intel® Distribution of OpenVINO™ to the non-default install directory, replace `/opt/intel` with the directory in which you installed the software.
> **NOTE**: If you installed the Intel® Distribution of OpenVINO™ toolkit to the non-default install directory, replace `/opt/intel` with the directory in which you installed the software.
1. Set the environment variables:
```sh
@@ -50,7 +50,7 @@ To enable inference on Intel® Vision Accelerator Design with Intel® Movidius
1. Download and install <a href="https://www.microsoft.com/en-us/download/details.aspx?id=48145">Visual C++ Redistributable for Visual Studio 2017</a>
2. Check with a support engineer if your Intel® Vision Accelerator Design with Intel® Movidius™ VPUs card requires SMBUS connection to PCIe slot (most unlikely). Install the SMBUS driver only if confirmed (by default, it's not required):
1. Go to the `<INSTALL_DIR>\runtime\3rdparty\hddl\drivers\SMBusDriver` directory, where `<INSTALL_DIR>` is the directory in which the Intel Distribution of OpenVINO toolkit is installed.
1. Go to the `<INSTALL_DIR>\runtime\3rdparty\hddl\drivers\SMBusDriver` directory, where `<INSTALL_DIR>` is the directory in which the Intel® Distribution of OpenVINO™ toolkit is installed.
2. Right click on the `hddlsmbus.inf` file and choose **Install** from the pop up menu.
You are done installing your device driver and are ready to use your Intel® Vision Accelerator Design with Intel® Movidius™ VPUs.

4
docs/install_guides/installing-openvino-overview.md
View File

@@ -8,6 +8,8 @@ Intel® Distribution of OpenVINO™ toolkit is a comprehensive toolkit for quick
## Installation Options
From the 2022.1 release, the OpenVINO installation package has been separated into two parts: OpenVINO Runtime and OpenVINO Development Tools. See the following instructions to decide your installation process.
### Decide What to Install
**If you have already finished your model development and want to deploy your applications on various devices, install OpenVINO Runtime**, which contains a set of libraries for an easy inference integration into your applications and supports heterogeneous execution across Intel® CPU and Intel® GPU hardware.
@@ -32,6 +34,6 @@ For C++ developers, you may choose one of the following installation options to
* macOS: You can install OpenVINO Runtime using an [Installer](installing-openvino-macos.md) or [Anaconda Cloud](installing-openvino-conda.md).
* [Raspbian OS](installing-openvino-raspbian.md).
> **NOTE**: From the 2022.1 release, the OpenVINO Development Tools can **only** be installed via PyPI. See [Install OpenVINO Development Tools](installing-model-dev-tools.md) for detailed steps.
> **NOTE**: From the 2022.1 release, OpenVINO Development Tools can **only** be installed via PyPI. See [Install OpenVINO Development Tools](installing-model-dev-tools.md) for detailed steps.
Besides, the open source version is also available in the [OpenVINO™ toolkit GitHub repository](https://github.com/openvinotoolkit/openvino/). You can build it for supported platforms using the [OpenVINO Build Instructions](https://github.com/openvinotoolkit/openvino/wiki/BuildingCode).

3
docs/install_guides/installing-openvino-pip.md
View File

@@ -1,7 +1,6 @@
# Install Intel® Distribution of OpenVINO™ Toolkit from PyPI Repository {#openvino_docs_install_guides_installing_openvino_pip}
You can install Intel® Distribution of OpenVINO™ toolkit through the PyPI repository, including both OpenVINO™ Runtime and OpenVINO™ Development Tools. Besides, from the 2022.1 release, OpenVINO Development Tools can only be installed via PyPI.
You can install Intel® Distribution of OpenVINO™ toolkit through the PyPI repository, including both OpenVINO™ Runtime and OpenVINO™ Development Tools.
## Installing OpenVINO Runtime

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

@@ -2,7 +2,7 @@
This guide provides installation steps for Intel® Distribution of OpenVINO™ toolkit for Linux distributed through the YUM repository.
From 2022.1 release, the OpenVINO™ Development Tools can only be installed via PyPI. If you want to develop or optimize your models with OpenVINO, see [Install OpenVINO Development Tools](installing-model-dev-tools.md) for detailed steps.
> **NOTE**: From the 2022.1 release, the OpenVINO™ Development Tools can only be installed via PyPI. If you want to develop or optimize your models with OpenVINO, see [Install OpenVINO Development Tools](installing-model-dev-tools.md) for detailed steps.
> **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). Please review the content inside the `<INSTALL_DIR>/licensing` folder for more details.

18
docs/install_guides/movidius-setup-guide.md
View File

@@ -4,15 +4,15 @@
The IEI Mustang-V100-MX8 is an OEM version of the Intel® Vision Accelerator Design with Intel® Movidius™ VPUs.
This guide assumes you have installed the [Mustang-V100-MX8](https://download.ieiworld.com/) and the [Intel® Distribution of OpenVINO™ Toolkit](https://software.intel.com/content/www/us/en/develop/tools/openvino-toolkit.html).
This guide assumes you have installed the [Mustang-V100-MX8](https://download.ieiworld.com/) and the [Intel® Distribution of OpenVINO™ toolkit](https://software.intel.com/content/www/us/en/develop/tools/openvino-toolkit.html).
Instructions in this guide for configuring your accelerator include:
1. Installing the required IEI\* BSL reset software
1. Installing the required IEI BSL reset software
2. Configuration settings for the `hddldaemon` service
> **NOTE**: This guide does not apply to Uzel\* cards.
> **NOTE**: This guide does not apply to Uzel cards.
## IEI Reset Software Installation
## Installing IEI Reset Software
Using the IEI Mustang-V100-MX8 requires downloading and installing the most current software for your system.
@@ -21,14 +21,14 @@ Search for **Mustang-V100-MX8**.
Download the appropriate software for your system, decompress the downloaded archive, enter the newly created directory, and run the install script:
On **Linux**\*:
On **Linux**:
- Run the `install.sh script` with `sudo`, or as `root`.
On **Windows**\*, do one of the following:<br>
On **Windows**, do one of the following:<br>
- **GUI**: Double-click `install.bat`
- **CLI**: Open a console with administrator privileges, cd into the directory, and run `install.bat`.
## Mustang-V100-MX8 Service Configuration
## Configuring Mustang-V100-MX8 Service
The `hddldaemon` is a system service, a binary executable that is run to manage the computational workload on the board. It is a required abstraction layer that handles inference, graphics processing, and any type of computation that should be run on the video processing units (VPUs). Depending on the board configuration, there can be 8 or 16 VPUs.
@@ -58,7 +58,7 @@ Below are some possible configuration options.
> **NOTE**: After changing a configuration file, the `hddldaemon` must be restarted.
### Recommended Settings
#### Recommended Settings
`device_snapshot_mode`
Changes the output of the `hddldaemon` to display a table with individual VPU statistics.
@@ -124,7 +124,7 @@ This setting reports the total FPS for the dispatching hddl_service (which will
(default: `"true"`)
## Additional resources
## Additional Resources
- [Intel Distribution of OpenVINO Toolkit home page](https://software.intel.com/en-us/openvino-toolkit)
- [Intel Distribution of OpenVINO Toolkit documentation](https://docs.openvino.ai)

18
docs/install_guides/troubleshooting.md
View File

@@ -8,7 +8,7 @@
If you met proxy issues during the installation with Docker, please set up proxy settings for Docker. See the Proxy section in the [Install the DL Workbench from DockerHub*](https://docs.openvino.ai/latest/workbench_docs_Workbench_DG_Prerequisites.html#set-proxy) topic.
### Permission Errors for `/dev/shm`
### Permission Errors for /dev/shm
If you encounter a permission error for files in `/dev/shm` (see `hddldaemon.log`). A possible cause is that the uid and gid of the container user are different from the uid and gid of the user who created `hddldaemon` service on the host.
@@ -43,7 +43,7 @@ ${HDDL_INSTALL_DIR}/bin/bsl_reset
```
---
### Get the "No space left on device" error while loading a network
### "No space left on device" error while loading a network
When the application runs inference of a network with a big size(>4MB) of input/output or if the system is running out of the DMA buffer,
the HDDL Plugin will fall back to use shared memory.
In this case, if the application exits abnormally, the shared memory is not released automatically.
@@ -53,7 +53,7 @@ sudo rm -f /dev/shm/hddl_*
```
---
### How to solve the permission issue?
### Solutions to the permission issue
Make sure that the following udev rules exist:
- `/etc/udev/rules.d/97-myriad-usbboot.rules`
@@ -67,7 +67,7 @@ sudo usermod -a -G users "$(whoami)"
```
---
### `setup.sh` doesn't install the driver binaries to `/lib/modules` on CentOS systems
### setup.sh doesn't install the driver binaries to /lib/modules on CentOS systems
As a temporary workaround, run the commands below to install the drivers. This issue will be fixed in future releases.
@@ -128,7 +128,7 @@ sudo modprobe myd_ion
Please contact your motherboard vendor to verify SMBUS pins are connected to the PCIe slot.
---
### Get "Error: ipc_connection_linux_UDS : bind() failed" in hddldaemon log.
### "Error: ipc_connection_linux_UDS : bind() failed" in hddldaemon log
You may have run hddldaemon under another user. Run the command below and try again:
```sh
@@ -136,7 +136,7 @@ sudo rm -rf /var/tmp/hddl_*
```
---
### Get "I2C bus: SMBus I801 adapter at not found!" in hddldaemon log
### "I2C bus: SMBus I801 adapter at not found!" in hddldaemon log
Run the following command to check if a SMBUS I801 adapter can be found:
```sh
@@ -147,7 +147,7 @@ Then run:
sudo modprobe i2c-i801
```
---
### Get "open /dev/ion failed!" in hddldaemon log
### "open /dev/ion failed!" in hddldaemon log
Check if `myd_ion` kernel module is installed by running the following command:
```sh
@@ -156,7 +156,7 @@ lsmod | grep myd_ion
If you do not see any output from the command, reinstall the `myd_ion` module.
---
### Constantly get "\_name\_mapping open failed err=2,No such file or directory" in hddldaemon log
### Constantly getting "\_name\_mapping open failed err=2,No such file or directory" in hddldaemon log
Check if myd_vsc kernel module is installed by running the following command:
```sh
@@ -165,7 +165,7 @@ lsmod | grep myd_vsc
If you do not see any output from the command reinstall the `myd_vsc` module.
---
### Get "Required key not available" when trying to install the `myd_ion` or `myd_vsc` modules
### "Required key not available" appears when trying to install the myd_ion or myd_vsc modules
Run the following commands:
```sh