Installation of OpenVINO™ Notebooks

The notebooks can be run in various environments. This guide will show you how to run and manage them on your local system.

Contents:

Installation Guide

The table below lists the supported operating systems and Python versions.

Supported Operating System (64-bit)

Python Version (64-bit )

Ubuntu 18.04 LTS

3.8, 3.9, 3.10. 3.11

Ubuntu 20.04 LTS

3.8, 3.9, 3.10, 3.11

Red Hat Enterprise Linux 8

3.8, 3.9, 3.10, 3.11

macOS 12.6.x versions

3.8, 3.9, 3.10, 3.11

Windows 10 Pro, Enterprise or Education editions

3.8, 3.9, 3.10, 3.11

Windows Server 2016 or higher

3.8, 3.9, 3.10, 3.11

OpenVINO Notebooks also require Git. Follow the guide below for your operating system or environment.

Installing prerequisites

  1. Install Python

    Download 64 bit version of Python software (3.8, 3.9, 3.10, 3.11) from python.org

    Run the installer by double clicking it. Follow the installation steps to set up the software.

    While installing, make sure you check the box to add Python to system PATH.

    Note

    Python software available in the Microsoft Store is not recommended. It may require additional packages.

  2. Install GIT

    Download 64 bit version of GIT from git-scm.org

    Run the installer by double clicking it. Follow the installation steps to set up the software.

  3. Install C++ Redistributable (For Python 3.8 only)

    Download 64 bit version of C++ Redistributable from here

    Run the installer by double clicking it. Follow the installation steps to set up the software.

  1. Install Python and GIT

    Note

    Linux Systems may require installation of additional libraries.

    The following installation steps should work on a clean install of Ubuntu Desktop 20.04, and should also work on Ubuntu 22.04 and 20.10, and on Ubuntu Server.

    sudo apt-get update
    sudo apt-get upgrade
    sudo apt-get install python3-venv build-essential python3-dev git-all
    

    For an Intel Integrated Graphics Card, you can install the Intel Graphics Compute Runtime to enable inference on this device. The command for Ubuntu 20.04 is:

    Note

    Only execute this command if you do not yet have OpenCL drivers installed.

    sudo apt-get install intel-opencl-icd
    

    The following installation steps should work on a clean install of Red Hat, CentOS, Amazon Linux 2 or Fedora. If any issues occur, see the Troubleshooting section.

    sudo yum update
    sudo yum upgrade
    sudo yum install python36-devel mesa-libGL
    

Alternatively, you may skip steps 1-3 if you prefer to manually install Python 3 and Git.

  1. Install Xcode Command Line Tools

    xcode-select --install
    
  2. Install Homebrew

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
    After you install it, follow the instructions from the Homebrew installation to set it up.
    
  3. Install Python and dependencies

    brew install python@3.9
    brew install protobuf
    

    Run each step below in a terminal.

    Note

    If OpenVINO is installed globally, do not run any of these commands in a terminal where setupvars.sh is sourced.

Note

An Azure account and access to Azure ML Studio are required.

  1. Adding a Compute Instance

    In Azure ML Studio, add a compute instance and pick any CPU-based instance. At least 4 CPU cores and 8GB of RAM are recommended.

    ml-studio-1

  2. Start the Terminal

    Once the compute instance has started, open the terminal window and then follow the installation steps below.

    ml-studio-2

To run the notebooks inside a Linux-based Docker container, use the Dockerfile:

:caption: Source: https://github.com/openvinotoolkit/openvino_notebooks/blob/main/Dockerfile

FROM quay.io/thoth-station/s2i-thoth-ubi8-py38:v0.29.0

LABEL name="OpenVINO(TM) Notebooks" \
  maintainer="helena.kloosterman@intel.com" \
  vendor="Intel Corporation" \
  version="0.2.0" \
  release="2021.4" \
  summary="OpenVINO(TM) Developer Tools and Jupyter Notebooks" \
  description="OpenVINO(TM) Notebooks Container"

ENV JUPYTER_ENABLE_LAB="true" \
  ENABLE_MICROPIPENV="1" \
  UPGRADE_PIP_TO_LATEST="1" \
  WEB_CONCURRENCY="1" \
  THOTH_ADVISE="0" \
  THOTH_ERROR_FALLBACK="1" \
  THOTH_DRY_RUN="1" \
  THAMOS_DEBUG="0" \
  THAMOS_VERBOSE="1" \
  THOTH_PROVENANCE_CHECK="0"

USER root

# Upgrade NodeJS > 12.0
# Install dos2unix for line end conversion on Windows
RUN curl -sL https://rpm.nodesource.com/setup_14.x | bash -  && \
  yum remove -y nodejs && \
  yum install -y nodejs-14.18.1 mesa-libGL dos2unix libsndfile && \
  yum -y update-minimal --security --sec-severity=Important --sec-severity=Critical --sec-severity=Moderate

# GPU drivers
RUN dnf install -y 'dnf-command(config-manager)' && \
    dnf config-manager --add-repo  https://repositories.intel.com/graphics/rhel/8.5/intel-graphics.repo

RUN rpm -ivh https://vault.centos.org/centos/8/AppStream/x86_64/os/Packages/mesa-filesystem-21.1.5-1.el8.x86_64.rpm && \
    dnf install --refresh -y \
    intel-opencl-22.28.23726.1-i419.el8.x86_64 intel-media intel-mediasdk libmfxgen1 libvpl2 \
    level-zero intel-level-zero-gpu \
    intel-metrics-library intel-igc-core intel-igc-cm \
    libva libva-utils  intel-gmmlib && \
    rpm -ivh http://mirror.centos.org/centos/8-stream/AppStream/x86_64/os/Packages/ocl-icd-2.2.12-1.el8.x86_64.rpm && \
    rpm -ivh https://download-ib01.fedoraproject.org/pub/epel/8/Everything/x86_64/Packages/c/clinfo-3.0.21.02.21-4.el8.x86_64.rpm

# Copying in override assemble/run scripts
COPY .docker/.s2i/bin /tmp/scripts
# Copying in source code
COPY .docker /tmp/src
COPY .ci/patch_notebooks.py /tmp/scripts
COPY .ci/validate_notebooks.py /tmp/scripts
COPY .ci/ignore_treon_docker.txt /tmp/scripts

# Git on Windows may convert line endings. Run dos2unix to enable
# building the image when the scripts have CRLF line endings.
RUN dos2unix /tmp/scripts/*
RUN dos2unix /tmp/src/builder/*

# Change file ownership to the assemble user. Builder image must support chown command.
RUN chown -R 1001:0 /tmp/scripts /tmp/src
USER 1001
RUN mkdir /opt/app-root/notebooks
COPY notebooks/ /opt/app-root/notebooks
RUN /tmp/scripts/assemble
RUN pip check
USER root
RUN dos2unix /opt/app-root/bin/*sh
RUN yum remove -y dos2unix
RUN chown -R 1001:0 .
RUN chown -R 1001:0 /opt/app-root/notebooks
USER 1001
# RUN jupyter lab build
CMD /tmp/scripts/run

Installing notebooks

  1. Create a Virtual Environment

    If you already have installed openvino-dev, you may skip this step and proceed with the next one.

    python -m venv openvino_env
    
  2. Activate the Environment

    openvino_env\Scripts\activate
    
  3. Clone the Repository

    Using the –depth=1 option for git clone reduces download size.

    git clone --depth=1 https://github.com/openvinotoolkit/openvino_notebooks.git
    cd openvino_notebooks
    
  4. Upgrade PIP

    python -m pip install --upgrade pip wheel setuptools
    
  5. Install required packages

    pip install -r requirements.txt
    
  1. Create a Virtual Environment

    If you already have installed openvino-dev, you may skip this step and proceed with the next one.

    python3 -m venv openvino_env
    
  2. Activate the Environment

    source openvino_env/bin/activate
    
  3. Clone the Repository

    Using the –depth=1 option for git clone reduces download size.

    git clone --depth=1 https://github.com/openvinotoolkit/openvino_notebooks.git
    cd openvino_notebooks
    
  4. Upgrade PIP

    python -m pip install --upgrade pip
    pip install wheel setuptools
    
  5. Install required packages

    pip install -r requirements.txt
    
  1. Create a Virtual Environment

    If you already have installed openvino-dev, you may skip this step and proceed with the next one.

    python3 -m venv openvino_env
    
  2. Activate the Environment

    source openvino_env/bin/activate
    
  3. Clone the Repository

    Using the –depth=1 option for git clone reduces download size.

    git clone --depth=1 https://github.com/openvinotoolkit/openvino_notebooks.git
    cd openvino_notebooks
    
  4. Upgrade PIP

    python -m pip install --upgrade pip wheel setuptools
    
  5. Install required packages

    pip install -r requirements.txt
    
  1. Create a Conda environment

    conda create --name openvino_env python=3.8 -y
    
  2. Activate the environment

    conda activate openvino_env
    
  3. Clone OpenVINO notebooks

    git clone https://github.com/openvinotoolkit/openvino_notebooks.git
    
  4. Change directory to openvino_notebooks

    cd openvino_notebooks
    
  5. Upgrade pip and install required dependencies.

    python -m pip install --upgrade pip
    pip install -r requirements.txt
    
  6. Add openvino_env to PATH

    set PATH="/anaconda/envs/openvino_env/bin;%PATH%"
    
  7. Run the notebooks.

    To run the notebooks, click on Notebooks and refresh your Files:

    https://user-images.githubusercontent.com/15709723/117580814-a725c300-b0ae-11eb-93bf-007779c26075.png https://user-images.githubusercontent.com/15709723/117559447-2af19800-b03a-11eb-8bd6-8813b7a8814f.png https://user-images.githubusercontent.com/15709723/117580973-37640800-b0af-11eb-91ae-7194b9b4e505.png

    Note

    Make sure you are using the openvino_env environment (not Python 3).

    https://user-images.githubusercontent.com/1720147/162269003-7937b47c-484f-416c-97c7-bb869376ff68.png
  1. Clone the Repository

    git clone https://github.com/openvinotoolkit/openvino_notebooks.git
    cd openvino_notebooks
    
  2. Build the Docker Image

    docker build -t openvino_notebooks .
    
  3. Run the Docker Image

    docker run -it -p 8888:8888 openvino_notebooks
    

    Note

    For using model training notebooks, allocate additional memory:

    docker run -it -p 8888:8888 --shm-size 8G openvino_notebooks
    
  4. Start the browser

    Copy the URL printed in the terminal window and open in a browser.
    If it is a remote machine, replace 127.0.0.1 with the correct IP address.

    docker-terminal-1

    The Dockerfile can be used to run a local image on Windows, Linux or macOS. It is also compatible with Open Data Hub and Red Hat OpenShift Data Science. The base layer is a UBI 8-based image provided by Project Thoth.

    Note

    While running the container on Windows and macOS, only CPU devices can be used. To access the iGPU, install the notebooks locally, following the instructions above.

Run the Notebooks

Launch a Single Notebook

If you want to launch only one notebook, such as the Monodepth notebook, run the command below.

jupyter lab notebooks/201-vision-monodepth/201-vision-monodepth.ipynb

Launch All Notebooks

jupyter lab notebooks

In your browser, select a notebook from the file browser in Jupyter Lab, using the left sidebar. Each tutorial is located in a subdirectory within the notebooks directory.

launch-jupyter

Manage the Notebooks

Shut Down Jupyter Kernel

To end your Jupyter session, press Ctrl-c. This will prompt you to Shutdown this Jupyter server (y/[n])? enter y and hit Enter.

Deactivate Virtual Environment

First, make sure you use the terminal window where you activated openvino_env. To deactivate your virtualenv, simply run:

deactivate

This will deactivate your virtual environment.

Reactivate Virtual Environment

To reactivate your environment, run:

source openvino_env\Scripts\activate
source openvino_env/bin/activate
source openvino_env/bin/activate

Then type jupyter lab or jupyter notebook to launch the notebooks again.

Delete Virtual Environment

This operation is optional. However, if you want to remove your virtual environment, simply delete the openvino_env directory:

rmdir /s openvino_env
rm -rf openvino_env
rm -rf openvino_env

Remove openvino_env Kernel from Jupyter

jupyter kernelspec remove openvino_env

If you run into issues, check the Troubleshooting, and FAQs sections or start a GitHub discussion.

Troubleshooting

For solutions to common issues during installation, refer to the Troubleshooting and FAQ sections in openvino_notebooks repository.

If the above tips do not solve your problem, feel free to open a discussion topic or create an issue on Github.