Installation of OpenVINO™ Notebooks¶
The notebooks run almost anywhere, from browsers and desktops to even a cloud VM or a Docker container. Follow the guide below in order to run and manage the notebooks on your machine.
Contents:
Installation Guide¶
The table below lists the supported operating systems and Python versions.
Supported Operating System (64-bit) |
|
---|---|
Ubuntu 18.04 LTS |
3.7, 3.8, 3.9, 3.10 |
Ubuntu 20.04 LTS |
3.7, 3.8, 3.9, 3.10 |
Red Hat Enterprise Linux 8 |
3.8, 3.9, 3.10 |
macOS 10.15.x versions |
3.7, 3.8, 3.9, 3.10 |
Windows 10 Pro, Enterprise or Education editions |
3.7, 3.8, 3.9, 3.10 |
Windows Server 2016 or higher |
3.7, 3.8, 3.9 |
OpenVINO Notebooks also require Git. Follow the guide below for your operating system or environment.
Installing prerequisites¶
Install Python
Download 64 bit version of Python software (3.7, 3.8, 3.9, 3.10) 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.
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.
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.
Install Python and GIT
Note
Linux Systems may require installation of additional libraries.
The following installation steps should work on Ubuntu Desktop 18.04, 20.04, 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
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
Install Python
Download Python software (3.7, 3.8, 3.9, 3.10) from python.org. For example, this installer.
Run the installer by double clicking it. Follow the installation steps to set up the software.
Note
Refer to the “Important Information” displayed during installation for information about SSL/TLS certificate validation and running the “Install Certificates.command”. These certificates are required to run some of the notebooks.
Note
An Azure account and access to Azure ML Studio are required.
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.
Start the Terminal
Once the compute instance has started, open the terminal window and then follow the installation steps below.
To run the notebooks inside a Linux-based Docker container, use the 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 mesa-libGL dos2unix libsndfile && \
yum -y update-minimal --security --sec-severity=Important --sec-severity=Critical --sec-severity=Moderate
# 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
# 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¶
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
Activate the Environment
openvino_env\Scripts\activate
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
Upgrade PIP
python -m pip install --upgrade pip
Install required packages
pip install -r requirements.txt
Install the virtualenv Kernel in Jupyter
python -m ipykernel install --user --name openvino_env
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
Activate the Environment
source openvino_env/bin/activate
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
Upgrade PIP
python -m pip install --upgrade pip
Install required packages
pip install -r requirements.txt
Install the virtualenv Kernel in Jupyter
python -m ipykernel install --user --name openvino_env
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
Activate the Environment
source openvino_env/bin/activate
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
Upgrade PIP
python -m pip install --upgrade pip
Install required packages
pip install -r requirements.txt
Install the virtualenv Kernel in Jupyter
python -m ipykernel install --user --name openvino_env
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
Activate the Environment
source openvino_env/bin/activate
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
Upgrade PIP
python -m pip install --upgrade pip
Install required packages
pip install -r requirements.txt
Install the virtualenv Kernel in Jupyter
python -m ipykernel install --user --name openvino_env
Clone the Repository
git clone https://github.com/openvinotoolkit/openvino_notebooks.git cd openvino_notebooks
Build the Docker Image
docker build -t openvino_notebooks .
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
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.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 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.
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_envrm -rf openvino_envrm -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¶
To check some common installation problems, run
python check_install.py
. This script is located in the openvino_notebooks directory. Run it after activating theopenvino_env
virtual environment.If you get an
ImportError
, doublecheck that you installed the Jupyter kernel. If necessary, choose theopenvino_env
kernel from the Kernel->Change Kernel menu) in Jupyter Lab or Jupyter NotebookIf OpenVINO is installed globally, do not run installation commands in a terminal where
setupvars.bat
orsetupvars.sh
are sourced.For Windows installation, it is recommended to use Command Prompt (cmd.exe), not PowerShell.
If the following tips do not solve your problem, feel free to open a discussion topic or create an issue! on Github.