Awesome
English | 简体中文
<h1>📚 OpenVINO™ Notebooks</h1>Note: This branch of the notebooks repository is deprecated and will be maintained until September 30, 2024. The new branch offers a better user experience and simplifies maintenance due to significant refactoring and a more preferred folder name structure. Please use the local
README.md
file and OpenVINO™ Notebooks at GitHub Pages to navigate through the content.
A collection of ready-to-run Jupyter notebooks for learning and experimenting with the OpenVINO™ Toolkit. The notebooks provide an introduction to OpenVINO basics and teach developers how to leverage our API for optimized deep learning inference.
🚀 Checkout interactive GitHub pages application for navigation between OpenVINO™ Notebooks content: OpenVINO™ Notebooks at GitHub Pages
Table of Contents
- Table of Contents
- 📝 Installation Guide
- 🚀 Getting Started
- ⚙️ System Requirements
- 💻 Run the Notebooks
- 🧹 Cleaning Up
- ⚠️ Troubleshooting
- 🧑💻 Contributors
- ❓ FAQ
📝 Installation Guide
OpenVINO Notebooks require Python and Git. To get started, select the guide for your operating system or environment:
Windows | Ubuntu | macOS | Red Hat | CentOS | Azure ML | Docker | Amazon SageMaker |
---|
🚀 Getting Started
Explore Jupyter notebooks using this page, select one related to your needs or give them all a try. Good Luck!
NOTE: The main branch of this repository was updated to support the new OpenVINO 2024.0 release. To upgrade to the new release version, please run pip install --upgrade -r requirements.txt
in your openvino_env
virtual environment. If you need to install for the first time, see the Installation Guide section below. If you wish to use the previous release version of OpenVINO, please checkout the 2023.3 branch. If you wish to use the previous Long Term Support (LTS) version of OpenVINO check out the 2022.3 branch.
If you need help, please start a GitHub Discussion.
If you run into issues, please check the troubleshooting section, FAQs or start a GitHub discussion.
Notebooks with and
buttons can be run without installing anything. Binder and Google Colab are free online services with limited resources. For the best performance, please follow the Installation Guide and run the notebooks locally.
⚙️ System Requirements
The notebooks run almost anywhere — your laptop, a cloud VM, or even a Docker container. The table below lists the supported operating systems and Python versions.
Supported Operating System | Python Version (64-bit) |
---|---|
Ubuntu 20.04 LTS, 64-bit | 3.8 - 3.11 |
Ubuntu 22.04 LTS, 64-bit | 3.8 - 3.11 |
Red Hat Enterprise Linux 8, 64-bit | 3.8 - 3.11 |
CentOS 7, 64-bit | 3.8 - 3.11 |
macOS 10.15.x versions or higher | 3.8 - 3.11 |
Windows 10, 64-bit Pro, Enterprise or Education editions | 3.8 - 3.11 |
Windows Server 2016 or higher | 3.8 - 3.11 |
💻 Run the Notebooks
To Launch a Single Notebook
If you wish to launch only one notebook, like the Monodepth notebook, run the command below.
jupyter 201-vision-monodepth.ipynb
To 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.
🧹 Cleaning Up
<div id='-shut-down-jupyter-kernel' markdown="1">-
Shut Down Jupyter Kernel
To end your Jupyter session, press
Ctrl-c
. This will prompt you toShutdown this Jupyter server (y/[n])?
entery
and hitEnter
.
-
Deactivate Virtual Environment
To deactivate your virtualenv, simply run
deactivate
from the terminal window where you activatedopenvino_env
. This will deactivate your environment.To reactivate your environment, run
source openvino_env/bin/activate
on Linux oropenvino_env\Scripts\activate
on Windows, then typejupyter lab
orjupyter notebook
to launch the notebooks again.
-
Delete Virtual Environment (Optional)
To remove your virtual environment, simply delete the
openvino_env
directory:
-
On Linux and macOS:
rm -rf openvino_env
-
On Windows:
rmdir /s openvino_env
-
Remove
openvino_env
Kernel from Jupyterjupyter kernelspec remove openvino_env
⚠️ Troubleshooting
If these tips do not solve your problem, please open a discussion topic or create an issue!
- To check some common installation problems, run
python check_install.py
. This script is located in the openvino_notebooks directory. Please run it after activating theopenvino_env
virtual environment. - If you get an
ImportError
, double-check that you installed the Jupyter kernel. If necessary, choose theopenvino_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
orsetupvars.sh
are sourced. - For Windows installation, it is recommended to use Command Prompt (
cmd.exe
), not PowerShell.
🧑💻 Contributors
<a href="https://github.com/openvinotoolkit/openvino_notebooks/graphs/contributors"> <img src="https://contrib.rocks/image?repo=openvinotoolkit/openvino_notebooks" /> </a>Made with contrib.rocks
.
❓ FAQ
- Which devices does OpenVINO support?
- What is the first CPU generation you support with OpenVINO?
- Are there any success stories about deploying real-world solutions with OpenVINO?
* Other names and brands may be claimed as the property of others.