dGPU installation for openvino container (#176)

gooishin · gooishin · commit aa379d56044e · 2024-08-26T10:14:53.000+08:00
diff --git a/gpu/arc/dg2/README.md b/gpu/arc/dg2/README.md
@@ -36,6 +36,6 @@ During installation, it may ask you to reboot your system. Reboot the system and
 
 ## Next Steps
 Refer the to available use cases and examples below
-1. [Intel® Distribution of OpenVINO™ Toolkit](../../../usecases/openvino/README.md)
+1. [Intel® Distribution of OpenVINO™ Toolkit](usecases/openvino/README.md)
 2. [Intel® Edge Software Hub](https://www.intel.com/content/www/us/en/developer/topic-technology/edge-5g/edge-solutions/overview.html)
 3. [Ollama with Open WebUI on Intel® Discrete GPU](../../../usecases/ollama/README.md)
diff --git a/gpu/arc/dg2/usecases/openvino/README.md b/gpu/arc/dg2/usecases/openvino/README.md
@@ -0,0 +1,65 @@
+# Intel® Distribution of OpenVINO™ toolkit
+
+## Requirement
+### Validated Hardware
+- Asrock IEPF-9030S-EY4 + Intel® Arc™ A770 Graphics
+
+## Pre-requisites
+- Platform or GPU reference setup script installed. Refer to [README.md](../../README.md) 
+- Docker version 24 or later installed
+
+## Quick Start
+### 1. Go to OpenVINO™ usecase directory
+```bash
+cd edge-developer-kit-reference-scripts/arc/dg2/usecases/openvino
+```
+
+### 2. Run the setup script
+This script will create 2 docker images: OpenVINO™ docker image and OpenVINO™ Notebooks docker image.
+```bash
+./setup.sh
+```
+During installation, it may ask you to reboot your system. Reboot the system and run `./setup.sh` again. Installation is completed when you see this message:
+> ✓ OpenVINO™ use case Installed
+
+When you run command `docker images`, you can see the following example:
+```
+REPOSITORY                       TAG       IMAGE ID       CREATED          SIZE
+openvino_notebook/ubuntu22_dev   latest    b6b94b1682b3   22 minutes ago   5.09GB
+openvino_dgpu/ubuntu22_dev       latest    afa9ce506097   44 minutes ago   4.7GB
+```
+
+## Run Docker Image
+### OpenVINO™ Toolkit
+1. Run this command to launch docker container with OpenVINO™ image and link to your working directory. For this instance, the working directory is in /home/user/workspace and it mount to container /data/workspace directory.
+```bash
+docker run -it -d -u openvino --name openvino_app -v /etc/group:/etc/group --device=/dev/dri --group-add=$(stat -c "%g" /dev/dri/render* | head -n 1) -v /usr/bin:/usr/bin -v /home/user/workspace:/data/workspace -w /data/workspace openvino_dgpu/ubuntu22_dev:latest
+```
+
+- --name: container name
+- -v: mount from local source directory to container destination directory
+- --device: Add device to container
+- --group-add: Add additional groups
+- -w: The default working directory inside the container
+
+2. Run following command to login into container:
+```bash
+docker exec -it openvino_app /bin/bash
+```
+
+3. Now you can run your application with OpenVINO™
+
+### OpenVINO™ Notebooks
+1. Run this command to launch OpenVINO™ Notebooks
+```bash
+./launch_notebooks.sh
+```
+2. Copy the URL printed in the terminal and open in a browser. Example output you will see in terminal:
+```
+    To access the server, open this file in a browser:
+        file:///opt/app-root/src/.local/share/jupyter/runtime/jpserver-20-open.html
+    Or copy and paste one of these URLs:
+        http://8adf267b0a6a:8888/lab?token=7d150b3a8d4157f1068c85d582eff346cce28e24cd2e9a85
+        http://127.0.0.1:8888/lab?token=7d150b3a8d4157f1068c85d582eff346cce28e24cd2e9a85
+```
+3. Open your browser and paste the URL. You will see openvino_notebooks directory and it has a lot of sample to try out.
diff --git a/gpu/arc/dg2/usecases/openvino/install_gpu.sh b/gpu/arc/dg2/usecases/openvino/install_gpu.sh
@@ -0,0 +1,15 @@
+#!/bin/bash
+
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0 
+
+echo "deb [arch=amd64,i386 signed-by=/usr/share/keyrings/intel-graphics.gpg] https://repositories.intel.com/gpu/ubuntu jammy client" | \
+  sudo tee /etc/apt/sources.list.d/intel-gpu-jammy.list
+sudo apt update
+
+sudo apt install -y \
+  intel-opencl-icd intel-level-zero-gpu level-zero intel-level-zero-gpu-raytracing \
+  intel-media-va-driver-non-free libmfx1 libmfxgen1 libvpl2 \
+  libegl-mesa0 libegl1-mesa libegl1-mesa-dev libgbm1 libgl1-mesa-dev libgl1-mesa-dri \
+  libglapi-mesa libgles2-mesa-dev libglx-mesa0 libigdgmm12 libxatracker2 mesa-va-drivers \
+  mesa-vdpau-drivers mesa-vulkan-drivers va-driver-all vainfo hwinfo clinfo
diff --git a/gpu/arc/dg2/usecases/openvino/launch_notebooks.sh b/gpu/arc/dg2/usecases/openvino/launch_notebooks.sh
@@ -0,0 +1,26 @@
+#!/bin/bash
+
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+CURRENT_DIRECTORY=$(pwd)
+echo "${CURRENT_DIRECTORY}"
+
+if docker ps | grep notebooks; then
+    echo -e "# Remove existing notebook container"
+    docker stop notebooks
+    sleep 5 # For removal in progress
+    if docker ps -a | grep notebooks; then
+        docker rm notebooks
+    fi
+fi
+
+docker run -t -d --rm --name notebooks \
+-v /etc/group:/etc/group --device=/dev/dri:/dev/dri \
+--group-add="$(stat -c "%g" /dev/dri/render* | head -n 1)" \
+-v "${CURRENT_DIRECTORY}":/mnt \
+-v /tmp/.X11-unix:/tmp/.X11-unix -e DISPLAY="$DISPLAY" \
+-p 127.0.0.1:8888:8888 \
+openvino_notebook/ubuntu22_dev:latest
+
+docker exec notebooks bash -c "cd /mnt/openvino_notebooks/notebooks ; jupyter-lab --allow-root --ip=0.0.0.0 --no-browser --NotebookApp.iopub_data_rate_limit=10000000"
diff --git a/gpu/arc/dg2/usecases/openvino/setup.sh b/gpu/arc/dg2/usecases/openvino/setup.sh
@@ -0,0 +1,131 @@
+#!/bin/bash
+
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0 
+
+set -e
+
+# symbol
+S_VALID="✓"
+
+# verify current user
+if [ "$EUID" -eq 0 ]; then
+    echo "Must not run with sudo or root user"
+    exit 1
+fi
+
+install_packages(){
+    local PACKAGES=("$@")
+    local INSTALL_REQUIRED=0
+    for PACKAGE in "${PACKAGES[@]}"; do
+        INSTALLED_VERSION=$(dpkg-query -W -f='${Version}' "$PACKAGE" 2>/dev/null || true)
+        LATEST_VERSION=$(apt-cache policy "$PACKAGE" | grep Candidate | awk '{print $2}')
+        
+        if [ -z "$INSTALLED_VERSION" ] || [ "$INSTALLED_VERSION" != "$LATEST_VERSION" ]; then
+            echo "$PACKAGE is not installed or not the latest version."
+            INSTALL_REQUIRED=1
+        fi
+    done
+    if [ $INSTALL_REQUIRED -eq 1 ]; then
+        sudo -E apt update
+        sudo -E apt install -y "${PACKAGES[@]}"
+    fi
+}
+
+verify_dependencies(){
+    echo -e "\n# Verifying dependencies"
+    DEPENDENCIES_PACKAGES=(
+        python3-pip
+        python3-venv
+    )
+    install_packages "${DEPENDENCIES_PACKAGES[@]}"
+    echo "$S_VALID Dependencies installed"
+}
+
+setup_docker(){
+
+    if ! id -nG "$USER" | grep -q -w '\<docker\>'; then
+        echo -e "\n# Add $USER into docker group"
+        sudo groupadd docker
+        sudo usermod -aG docker "$USER"
+        echo "System reboot is required. Re-run the script after reboot"
+        exit 0
+    fi
+}
+
+install_openvino_docker(){
+
+    echo -e "\n# Install OpenVINO™ Runtime docker image"
+    if ! docker images | grep openvino/ubuntu22_dev; then
+        if ! docker images | grep openvino_dgpu/ubuntu22_dev; then
+            docker pull openvino/ubuntu22_dev:latest
+            echo "Default OpenVINO™ Runtime docker image installed"
+        fi        
+    fi
+
+    echo -e "\n# Install GPU driver in OpenVINO™ Runtime docker image"
+    if ! docker images | grep openvino_dgpu/ubuntu22_dev; then
+        if docker ps | grep openvino_install_gpu; then
+            docker stop openvino_install_gpu
+            sleep 5
+            docker rm openvino_install_gpu
+        fi
+
+        docker run -u root -t -d --rm --name openvino_install_gpu \
+        -v /usr/share/keyrings/intel-graphics.gpg:/usr/share/keyrings/intel-graphics.gpg \
+        -v /etc/environment:/etc/environment \
+        -v /etc/group:/etc/group \
+        --device=/dev/dri:/dev/dri \
+        --group-add="$(stat -c "%g" /dev/dri/render* | head -n 1)" \
+        -v /usr/bin:/usr/bin \
+        -v "${PWD}":/data/workspace \
+        -w /data/workspace openvino/ubuntu22_dev:latest
+        
+        docker exec openvino_install_gpu bash -c "./install_gpu.sh"
+
+        echo -e "\n# Create OpenVINO™ Runtime docker image with dGPU drivers" 
+        docker commit openvino_install_gpu openvino_dgpu/ubuntu22_dev:latest
+        docker stop openvino_install_gpu
+        sleep 5
+        docker rmi openvino/ubuntu22_dev
+
+        echo "$S_VALID OpenVINO™ Runtime docker image with dGPU driver installed"
+    else
+        echo "$S_VALID OpenVINO™ Runtime docker image with dGPU driver already installed"
+    fi
+}
+
+install_openvino_notebook_docker(){
+
+    echo -e "\n# Git clone OpenVINO™ notebooks"
+    if [ ! -d "./openvino_notebooks" ]; then
+        git clone https://github.com/openvinotoolkit/openvino_notebooks.git
+    else
+        echo "./openvino_notebooks already exists"
+    fi
+
+    echo -e "\n# Build OpenVINO™ notebook docker image"
+    if ! docker images | grep openvino_notebook; then
+        docker run -u root -t -d --rm --name temp_notebooks \
+        -v /usr/share/keyrings/intel-graphics.gpg:/usr/share/keyrings/intel-graphics.gpg \
+        -v "${PWD}":/mnt openvino_dgpu/ubuntu22_dev:latest
+        docker exec -u root temp_notebooks bash -c "apt update && apt install -y wget ffmpeg"
+        docker exec -u root temp_notebooks bash -c "cd /mnt/openvino_notebooks; pip install wheel setuptools; pip install -r requirements.txt"
+        docker commit temp_notebooks openvino_notebook/ubuntu22_dev:latest
+        docker stop temp_notebooks
+    else
+        echo "$S_VALID OpenVINO™ notebook docker image already installed"
+    fi
+}
+
+setup() {
+    verify_dependencies
+    setup_docker
+    install_openvino_docker
+    install_openvino_notebook_docker
+
+    echo -e "\n# Status"
+    echo "$S_VALID OpenVINO™ use case Installed"
+}
+
+setup
