IntenseWebs/openvino

Fork 0

Files

Przemyslaw Wysocki 9ca85eb363 [PyOV] Update docs with Python 3.11 (#16366 )

2023-04-17 11:33:15 +02:00

19 KiB

Raw Blame History

Installation of OpenVINO™ Notebooks

@sphinxdirective

.. _notebooks installation:

.. meta:: :description: An installation guide for Jupyter notebooks on which Python tutorials run. The tutorials serve as introduction to the OpenVINO™ toolkit. :keywords: OpenVINO™ toolkit, Jupyter notebooks, Jupyter, Python, Python API, installation guide, tutorials, install notebooks, local installation, OpenVINO™ Notebooks, run 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 <#-installation-guide>__
Run the Notebooks <#-run-the-notebooks>__
Manage the notebooks <#-manage-the-notebooks>__
Troubleshooting <#-troubleshooting>__
FAQ <#-faq>__

.. raw:: html

`Installation Guide`_

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

+-------------------------------------+--------------------------------+ | Supported Operating System (64-bit) | Python Version | | | (64-bit | | | ) <https://www.python.org/>__ | +=====================================+================================+ | Ubuntu 18.04 LTS | 3.7, 3.8, 3.9, 3.10. 3.11 | +-------------------------------------+--------------------------------+ | Ubuntu 20.04 LTS | 3.7, 3.8, 3.9, 3.10, 3.11 | +-------------------------------------+--------------------------------+ | Red Hat Enterprise Linux 8 | 3.8, 3.9, 3.10, 3.11 | +-------------------------------------+--------------------------------+ | macOS 10.15.x versions | 3.7, 3.8, 3.9, 3.10, 3.11 | +-------------------------------------+--------------------------------+ | Windows 10 Pro, Enterprise | 3.7, 3.8, 3.9, 3.10, 3.11 | | or Education editions | | +-------------------------------------+--------------------------------+ | Windows Server 2016 or higher | 3.7, 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`_

.. tab:: WINDOWS

Install Python

Download 64 bit version of Python software (3.7, 3.8, 3.9, 3.10, 3.11) 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.
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.
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

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

Install Python

Download Python software (3.7, 3.8, 3.9, 3.10, 3.11) 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.

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|
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="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`_

.. tab:: WINDOWS

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
Activate the Environment

.. code-block::

openvino_env\Scripts\activate
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
Upgrade PIP

.. code-block::

python -m pip install --upgrade pip
Install required packages

.. code-block::

pip install -r requirements.txt
Install the virtualenv Kernel in Jupyter

.. code-block::

python -m ipykernel install --user --name openvino_env

.. tab:: Linux Systems

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
Activate the Environment

.. code-block::

source openvino_env/bin/activate
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
Upgrade PIP

.. code-block::

python -m pip install --upgrade pip
Install required packages

.. code-block::

pip install -r requirements.txt
Install the virtualenv Kernel in Jupyter

.. code-block::

python -m ipykernel install --user --name openvino_env

.. tab:: macOS

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
Activate the Environment

.. code-block::

source openvino_env/bin/activate
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
Upgrade PIP

.. code-block::

python -m pip install --upgrade pip
Install required packages

.. code-block::

pip install -r requirements.txt
Install the virtualenv Kernel in Jupyter

.. code-block::

python -m ipykernel install --user --name openvino_env

.. tab:: Azure ML

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
Activate the Environment

.. code-block::

source openvino_env/bin/activate
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
Upgrade PIP

.. code-block::

python -m pip install --upgrade pip
Install required packages

.. code-block::

pip install -r requirements.txt
Install the virtualenv Kernel in Jupyter

.. code-block::

python -m ipykernel install --user --name openvino_env

.. tab:: Docker

Clone the Repository

.. code-block::

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

.. code-block::

docker build -t openvino_notebooks .
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
```
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.

.. raw:: html

`Run the Notebooks`_

Launch a Single Notebook

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

.. code:: bash

jupyter 201-vision-monodepth.ipynb

Launch All Notebooks

.. code:: bash

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|

.. raw:: html

`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:

.. code:: bash

deactivate

This will deactivate your virtual environment.

Reactivate Virtual Environment

To reactivate your environment, run:

.. 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.

Delete Virtual Environment

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

.. 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

Remove openvino_env Kernel from Jupyter

.. code:: bash

jupyter kernelspec remove openvino_env

If you run into issues, check the Troubleshooting <#-troubleshooting>, and FAQs <#-faq> sections or start a GitHub discussion <https://github.com/openvinotoolkit/openvino_notebooks/discussions>__.

.. raw:: html

`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 the openvino_env virtual environment.
If you get an ImportError, doublecheck that you installed the Jupyter kernel. If necessary, choose the openvino_env kernel 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.bat or setupvars.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 <https://github.com/openvinotoolkit/openvino_notebooks/discussions>__ or create an issue <https://github.com/openvinotoolkit/openvino_notebooks/issues>__! on Github.

.. raw:: html

`FAQ`_

Which devices does OpenVINO support? <https://docs.openvino.ai/2022.1/openvino_docs_OV_UG_supported_plugins_Supported_Devices.html>__
What is the first CPU generation that OpenVINO supports? <https://www.intel.com/content/www/us/en/developer/tools/openvino-toolkit/system-requirements.html>__
Are there any success stories about deploying real-world solutions with OpenVINO? <https://www.intel.com/content/www/us/en/internet-of-things/ai-in-production/success-stories.html>__

`Additional Resources`_

OpenVINO™ Notebooks - Github Repository <https://github.com/openvinotoolkit/openvino_notebooks/blob/main/README.md>_
Install OpenVINO™ Development Tools <https://docs.openvino.ai/nightly/openvino_docs_install_guides_install_dev_tools.html>_

.. |br| raw:: html

.. |launch-jupyter| image:: https://user-images.githubusercontent.com/15709723/120527271-006fd200-c38f-11eb-9935-2d36d50bab9f.gif .. |Apache License Version 2.0| image:: https://img.shields.io/badge/license-Apache_2.0-green.svg :target: https://github.com/openvinotoolkit/openvino_notebooks/blob/main/LICENSE .. |nbval| image:: https://github.com/openvinotoolkit/openvino_notebooks/actions/workflows/nbval.yml/badge.svg :target: https://github.com/openvinotoolkit/openvino_notebooks/actions/workflows/nbval.yml?query=branch%3Amain .. |nbval-docker| image:: https://github.com/openvinotoolkit/openvino_notebooks/actions/workflows/docker.yml/badge.svg :target: https://github.com/openvinotoolkit/openvino_notebooks/actions/workflows/nbval.yml?query=branch%3Amain .. |binder logo| image:: https://mybinder.org/badge_logo.svg :alt: Binder button

.. |ml-studio-1| image:: https://user-images.githubusercontent.com/15709723/117559437-17463180-b03a-11eb-9e8d-d4539d1502f2.png

.. |ml-studio-2| image:: https://user-images.githubusercontent.com/15709723/117582205-b6f4d580-b0b5-11eb-9b83-eb2004ad9b19.png

.. |docker-terminal-1| image:: https://user-images.githubusercontent.com/15709723/127793994-355e4d29-d131-432d-a12a-b08ca6131223.png

@endsphinxdirective

19 KiB Raw Blame History

Installation of OpenVINO™ Notebooks

Installation Guide_

Installing prerequisites_

Installing notebooks_

Run the Notebooks_

Launch a Single Notebook

Launch All Notebooks

Manage the Notebooks_

Shut Down Jupyter Kernel

Deactivate Virtual Environment

Reactivate Virtual Environment

Delete Virtual Environment

Remove openvino_env Kernel from Jupyter

Troubleshooting_

FAQ_

Additional Resources_

19 KiB

Raw Blame History

`Installation Guide`_

`Installing prerequisites`_

`Installing notebooks`_

`Run the Notebooks`_

`Manage the Notebooks`_

`Troubleshooting`_

`FAQ`_

`Additional Resources`_