Skip to content

Commit 0ffd49c

Browse files
Ryan Loneyhelena-intel
Ryan Loney
and
helena-intel
authored
Add notebooks and updated README from develop branch (openvinotoolkit#3)
* added tools and utils.py * updated readme with python3.8 note and os matrix * added BETA note and intro/background * added more content to readme * readme cleanup, added discord * readme cleanup * added clone step and cleaned up readme * fixed Step 6 format * fixed troubleshooting section * more cleanup in readme * updated install guide steps * moved virtualenv suggestions to troubleshooting section * readme cleanup * readme formatting changes * adjusted wording in README * shortened Windows 10 edition names * separated step 1 into 2 * changed to requirements.txt * remove 3.8 * upgrade pip pinning removed * added note about dependencies * added 3.6 and 3.7 to getting started * notebooks directory * added property of others disclaimer and LICENSE * added powershell note * Add requirements.txt and ci-requirements.txt * Update README.md * Add CI workflow * Add check_install script * Add Hello World notebook * Add Tensorflow to OpenVINO notebook * added emojis to readme * Add Monodepth notebook * changed discord URL * Update ci-requirements.txt * Add Pytorch-ONNX-OpenVINO Notebook * Pin pip to 20.2.* in nbval.yml To avoid issues with dependency resolving in pip 21.* * added warning about setupvars * added warning about setupvars * updated command prompt warning * added cleaning up section * cleaned up README formatting * cleaned up README formatting * updated cleaning up venv * added anchor links to README * fixed anchor urls * fixed anchor url * removed tools/utils.py * added pip pinning to install guide * changed ONNX to TF in markdown cells 101-tf notebook * removed WIP message in 201-mono notebook Co-authored-by: Kloosterman <helena.kloosterman@intel.com>
1 parent 5badcc3 commit 0ffd49c

25 files changed

+18508
-18
lines changed

‎.ci/ci-requirements.txt

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
-r ../requirements.txt
2+
3+
# Packages for testing/validating notebooks
4+
nbval
5+
nbqa[toolchain]
6+
pre-commit
7+

‎.github/workflows/nbval.yml

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: nbval
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build:
7+
strategy:
8+
fail-fast: false
9+
matrix:
10+
os: [ubuntu-18.04, ubuntu-20.04, macos-latest, windows-latest]
11+
python: [3.6, 3.7]
12+
13+
runs-on: ${{ matrix.os }}
14+
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: Set up Python
18+
uses: actions/setup-python@v1
19+
with:
20+
python-version: ${{ matrix.python }}
21+
- name: Install dependencies
22+
run: |
23+
python -m pip install --upgrade pip==20.2.*
24+
python -m pip install wheel
25+
python -m pip install -r .ci/ci-requirements.txt
26+
python -m ipykernel install --user --name openvino_env
27+
python -m pip freeze > pip-freeze-${{ github.sha }}-${{matrix.os}}-${{ matrix.python }}.txt
28+
- name: Archive pip freeze
29+
uses: actions/upload-artifact@v2
30+
with:
31+
name: pip-freeze
32+
path: pip-freeze-${{ github.sha }}-${{matrix.os}}-${{ matrix.python }}.txt
33+
- name: Analysing with nbval
34+
run: |
35+
python -m pytest --nbval .
36+

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

+58-18
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
# 📚 OpenVINO Notebooks
22

3-
> **NOTE**: The notebooks are currently in **beta**. We plan to publish a stable release this summer. You can submit [issues](https://github.com/openvinotoolkit/openvino_notebooks/issues) on GitHub and join our [developer Discord\*](https://discord.com/invite/pWGcWpyx7x) to get updates. We look forward to hearing from you!
3+
> 🚧 Notebooks are currently in **beta**. We plan to publish a stable release this summer. Please submit [issues](https://github.com/openvinotoolkit/openvino_notebooks/issues) on GitHub and join our [developer Discord\*](https://discord.gg/Bn9E33xe) to stay in touch.
44
55
A collection of ready-to-run Python\* notebooks for learning and experimenting with OpenVINO developer tools. The notebooks are meant to provide an introduction to OpenVINO basics and teach developers how to leverage our APIs for optimized deep learning inference in their applications.
66

7-
## Getting Started
7+
## 💻 Getting Started
88

9-
The notebooks are designed to run almost anywhere &mdash; on your laptop, a cloud VM, or a Docker container. Here's what you need to get started:
9+
The notebooks are designed to run almost anywhere &mdash; your laptop, a cloud VM, or even a Docker container. Here's what you need to get started:
1010

1111
- CPU (64-bit)
1212
- Windows\*, Linux\* or macOS\*
13-
- Python\*
13+
- Python\* 3.6-3.7
1414

15-
Before you proceed to the Installation Guide, please check the detailed System Requirements below.
15+
Before you proceed to the [Installation Guide](#-installation-guide), please review the detailed [System Requirements](#%EF%B8%8F-system-requirements) below.
1616

17-
## System Requirements
17+
## ⚙️ System Requirements
1818

19-
> **NOTE: Python 3.8 with Linux is not supported yet.** If you wish to run the notebooks on Ubuntu 20.04, please see our [guide](wiki_url) for installing Python 3.7 on Ubuntu 20.04.
19+
> **NOTE: Python 3.8 is not supported yet.** If you wish to run the notebooks on Ubuntu 20.04, please install Python 3.7 on Ubuntu 20.04 until Python 3.8 is supported.
2020
2121
The table below lists the supported operating systems and Python versions required to run the OpenVINO notebooks.
2222

@@ -26,23 +26,26 @@ The table below lists the supported operating systems and Python versions requir
2626
| Ubuntu\* 20.04 LTS, 64-bit | 3.6, 3.7 |
2727
| Red Hat* Enterprise Linux* 8.2, 64-bit | 3.6, 3.7 |
2828
| CentOS\* 7.4, 64-bit | 3.6, 3.7 |
29-
| macOS\* 10.15.x versions | 3.6, 3.7, 3.8 |
30-
| Windows 10\*, 64-bit Pro, Enterprise or Education editions | 3.6, 3.7, 3.8 |
31-
| Windows Server\* 2016 or higher | 3.6, 3.7, 3.8 |
29+
| macOS\* 10.15.x versions | 3.6, 3.7 |
30+
| Windows 10\*, 64-bit Pro, Enterprise or Education editions | 3.6, 3.7 |
31+
| Windows Server\* 2016 or higher | 3.6, 3.7 |
32+
33+
## 📝 Installation Guide
34+
35+
> **NOTE:** If OpenVINO is installed globally, please do not run any of these commands in a terminal where setupvars.bat or setupvars.sh are sourced. For Windows, we recommended using _Command Prompt (cmd.exe)_, not _PowerShell_.
3236
33-
## Installation Guide
3437

3538
### Step 1: Clone the Repository
3639

3740
```bash
3841
git clone https://github.com/openvinotoolkit/openvino_notebooks.git
39-
cd openvino_notebooks
4042
```
4143

4244
### Step 2: Create a Virtual Environment
4345

4446
```bash
45-
# For Linux and macOS you may need to use python3 instead of python
47+
# Linux and macOS may require typing python3 instead of python
48+
cd openvino_notebooks
4649
python -m venv openvino_env
4750
```
4851

@@ -62,10 +65,12 @@ openvino_env\Scripts\activate
6265

6366
### Step 4: Install the Packages
6467

68+
#### Installs OpenVINO tools and dependencies like Jupyter Lab:
69+
6570
```bash
66-
# Install pip version 20.1.1 to ensure compatibility with all dependencies
67-
python -m pip install --upgrade pip==20.1.1
68-
pip install jupyterlab openvino-dev
71+
# Upgrade pip to the 20.2.* version to avoid dependency issues
72+
python -m pip install --upgrade pip==20.2.4
73+
pip install -r requirements.txt
6974
```
7075

7176
### Step 5: Install the virtualenv Kernel in Jupyter
@@ -86,14 +91,49 @@ jupyter lab
8691

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

89-
## Troubleshooting
94+
95+
## 🧹 Cleaning Up
96+
97+
### Shut Down Jupyter Kernel
98+
99+
To end your Jupyter session, press `Ctrl-c`. This will prompt you to `Shutdown this Jupyter server (y/[n])?` enter `y` and hit `Enter`.
100+
101+
### Deativate Virtual Environment
102+
103+
To deactivate your virtualenv, simply run `deactivate` from the terminal window where you activated `openvino_env`. This will deactivate your environment.
104+
105+
To reactivate your environment, simply repeat [Step 3](#step-3-activate-the-environment) from the Install Guide.
106+
107+
### Delete Virtual Environment _(Optional)_
108+
109+
To remove your virtual environment, simply delete the `openvino_env` directory:
110+
111+
#### On Linux and macOS:
112+
113+
```bash
114+
rm -rf openvino_env
115+
```
116+
117+
#### On Windows:
118+
119+
```bash
120+
rmdir /s openvino_env
121+
```
122+
123+
## ⚠️ Troubleshooting
90124

91125
- On Ubuntu, if you see the error **"libpython3.7m.so.1.0: cannot open shared object file: No such object or directory"** please install the required package with `sudo apt install libpython3.7-dev`
92126

93-
- If you get an `ImportError`, doublecheck that you installed the kernel in Step 4. If necessary, choose the openvino*env kernel from the \_Kernel->Change Kernel* menu)
127+
- If you get an `ImportError`, doublecheck that you installed the kernel in [Step 5](#step-5-install-the-virtualenv-kernel-in-jupyter). If necessary, choose the openvino*env kernel from the \_Kernel->Change Kernel* menu)
94128

95129
- On Linux and macOS you may need to type `python3` instead of `python` when creating your virtual environment
96130

97131
- You may also need to install [pip](https://pip.pypa.io/en/stable/installing/) and/or python-venv (depending on your Linux distribution)
98132

99133
- On Windows, if you have installed multiple versions of Python, use `py -3.7` when creating your virtual environment to specify a supported version (in this case 3.7)
134+
135+
136+
---
137+
138+
\* Other names and brands may be claimed as the property of others.
139+

0 commit comments

Comments
 (0)