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:
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.6, 3.7, 3.8, 3.9 |
| Ubuntu 20.04 LTS | 3.6, 3.7, 3.8, 3.9 |
| Red Hat Enterprise Linux 8 | 3.6, 3.8, 3.9 |
| CentOS 7 | 3.6, 3.7, 3.8, 3.9 |
| macOS 10.15.x versions | 3.6, 3.7, 3.8, 3.9 |
| Windows 10 Pro, Enterprise or Education editions | 3.6, 3.7, 3.8, 3.9 |
| Windows Server 2016 or higher | 3.6, 3.7, 3.8, 3.9 |
OpenVINO Notebooks also require Git. Follow the guide below for your operating system or environment.
.. tab:: WINDOWS
1. **Install Python**
Download 64 bit version of Python software (3.6, 3.7, 3.8, 3.9) from `python.org`_.
.. _python.org: https://www.python.org/downloads/windows/
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`_
.. _git-scm.org: https://github.com/git-for-windows/git/releases/download/v2.36.0.windows.1/Git-2.36.0-64-bit.exe
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`_
.. _here: https://download.visualstudio.microsoft.com/download/pr/4100b84d-1b4d-487d-9f89-1354a7138c8f/5B0CBB977F2F5253B1EBE5C9D30EDBDA35DBD68FB70DE7AF5FAAC6423DB575B5/VC_redist.x64.exe
Run the installer by double clicking it. Follow the installation steps to set up the software.
.. tab:: Linux Systems
1. **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.
.. code-block::
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 <#-troubleshooting>`__ section.
.. code-block::
sudo yum update
sudo yum upgrade
sudo yum install python36-devel mesa-libGL
.. tab:: macOS
1. **Install Python**
Download Python software (3.7, 3.8, 3.9) from `python.org`. For example, this `installer`_.
.. _installer: https://www.python.org/ftp/python/3.7.9/python-3.7.9-macosx10.9.pkg
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.
.. tab:: Azure ML
.. note::
An Azure account and access to `Azure ML Studio <https://ml.azure.com/>`__ are required.
1. **Adding a Compute Instance**
In Azure ML Studio, `add a compute instance <https://docs.microsoft.com/en-us/azure/machine-learning/how-to-create-manage-compute-instance?tabs=python>`__ 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|
.. tab:: Docker
To run the notebooks inside a Linux-based Docker container, use the Dockerfile:
.. code-block:: bash
: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="[email protected]" \
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
.. tab:: WINDOWS
1. **Create a Virtual Environment**
If you already have installed *openvino-dev*, you may skip this step and proceed with the next one.
.. code-block::
python -m venv openvino_env
2. **Activate the Environment**
.. code-block::
openvino_env\Scripts\activate
3. **Clone the Repository**
Using the --depth=1 option for git clone reduces download size.
.. code-block::
git clone --depth=1 https://github.com/openvinotoolkit/openvino_notebooks.git
cd openvino_notebooks
4. **Upgrade PIP**
.. code-block::
python -m pip install --upgrade pip
5. **Install required packages**
.. code-block::
pip install -r requirements.txt
6. **Install the virtualenv Kernel in Jupyter**
.. code-block::
python -m ipykernel install --user --name openvino_env
.. tab:: Linux Systems
1. **Create a Virtual Environment**
If you already have installed *openvino-dev*, you may skip this step and proceed with the next one.
.. code-block::
python3 -m venv openvino_env
2. **Activate the Environment**
.. code-block::
source openvino_env/bin/activate
3. **Clone the Repository**
Using the --depth=1 option for git clone reduces download size.
.. code-block::
git clone --depth=1 https://github.com/openvinotoolkit/openvino_notebooks.git
cd openvino_notebooks
4. **Upgrade PIP**
.. code-block::
python -m pip install --upgrade pip
5. **Install required packages**
.. code-block::
pip install -r requirements.txt
6. **Install the virtualenv Kernel in Jupyter**
.. code-block::
python -m ipykernel install --user --name openvino_env
.. tab:: macOS
1. **Create a Virtual Environment**
If you already have installed *openvino-dev*, you may skip this step and proceed with the next one.
.. code-block::
python3 -m venv openvino_env
2. **Activate the Environment**
.. code-block::
source openvino_env/bin/activate
3. **Clone the Repository**
Using the --depth=1 option for git clone reduces download size.
.. code-block::
git clone --depth=1 https://github.com/openvinotoolkit/openvino_notebooks.git
cd openvino_notebooks
4. **Upgrade PIP**
.. code-block::
python -m pip install --upgrade pip
5. **Install required packages**
.. code-block::
pip install -r requirements.txt
6. **Install the virtualenv Kernel in Jupyter**
.. code-block::
python -m ipykernel install --user --name openvino_env
.. tab:: Azure ML
1. **Create a Virtual Environment**
If you already have installed *openvino-dev*, you may skip this step and proceed with the next one.
.. code-block::
python3 -m venv openvino_env
2. **Activate the Environment**
.. code-block::
source openvino_env/bin/activate
3. **Clone the Repository**
Using the --depth=1 option for git clone reduces download size.
.. code-block::
git clone --depth=1 https://github.com/openvinotoolkit/openvino_notebooks.git
cd openvino_notebooks
4. **Upgrade PIP**
.. code-block::
python -m pip install --upgrade pip
5. **Install required packages**
.. code-block::
pip install -r requirements.txt
6. **Install the virtualenv Kernel in Jupyter**
.. code-block::
python -m ipykernel install --user --name openvino_env
.. tab:: Docker
1. **Clone the Repository**
.. code-block::
git clone https://github.com/openvinotoolkit/openvino_notebooks.git
cd openvino_notebooks
2. **Build the Docker Image**
.. code-block::
docker build -t openvino_notebooks .
3. **Run the Docker Image**
.. code-block::
docker run -it -p 8888:8888 openvino_notebooks
.. note::
For using model training notebooks, allocate additional memory:
.. code-block::
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. |br|
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 <https://catalog.redhat.com/software/containers/ubi8/5c647760bed8bd28d0e38f9f?container-tabs=overview>`__-based image provided by `Project Thoth <https://thoth-station.ninja/>`__.
.. 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.
If you want to launch only one notebook, such as the Monodepth notebook, run the command below.
jupyter 201-vision-monodepth.ipynbjupyter lab notebooksIn 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.
To end your Jupyter session, press Ctrl-c. This will prompt you to
Shutdown this Jupyter server (y/[n])? enter y and hit Enter.
First, make sure you use the terminal window where you activated openvino_env. To deactivate your virtualenv, simply run:
deactivateThis will deactivate your virtual environment.
To reactivate your environment, run:
.. tabs::
.. tab:: WINDOWS
.. code:: bash
source openvino_env\Scripts\activate
.. tab:: Linux Systems
.. code:: bash
source openvino_env/bin/activate
.. tab:: macOS
.. code:: bash
source openvino_env/bin/activate
Then type jupyter lab or jupyter notebook to launch the notebooks again.
This operation is optional. However, if you want to remove your virtual environment, simply delete the openvino_env directory:
.. tabs::
.. tab:: WINDOWS
.. code:: bash
rmdir /s openvino_env
.. tab:: Linux Systems
.. code:: bash
rm -rf openvino_env
.. tab:: macOS
.. code:: bash
rm -rf openvino_env
jupyter kernelspec remove openvino_envIf you run into issues, check the Troubleshooting, and FAQs sections or start a GitHub discussion.
- 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_envvirtual environment. - If you get an
ImportError, doublecheck that you installed the Jupyter kernel. If necessary, choose theopenvino_envkernel from the Kernel->Change Kernel menu) in Jupyter Lab or Jupyter Notebook - If OpenVINO is installed globally, do not run installation commands
in a terminal where
setupvars.batorsetupvars.share 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.
- Which devices does OpenVINO support?
- What is the first CPU generation that OpenVINO supports?
- Are there any success stories about deploying real-world solutions with OpenVINO?