Skip to content

Commit 1144a66

Browse files
[DOCS] Updating interactive tutorials (openvinotoolkit#24886)
1 parent aaa6348 commit 1144a66

File tree

182 files changed

+8221
-3023
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

182 files changed

+8221
-3023
lines changed

docs/articles_en/learn-openvino/interactive-tutorials-python/notebooks-installation.rst

+178-7
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,17 @@ The table below lists the supported operating systems and Python versions.
3232
| | (64-bit |
3333
| | ) <https://www.python.org/>`__ |
3434
+=====================================+================================+
35-
| Ubuntu 18.04 LTS | 3.8, 3.9, 3.10. 3.11 |
35+
| Ubuntu 20.04 LTS, 64-bit | 3.8, 3.9, 3.10. 3.11 |
3636
+-------------------------------------+--------------------------------+
37-
| Ubuntu 20.04 LTS | 3.8, 3.9, 3.10, 3.11 |
37+
| Ubuntu 22.04 LTS, 64-bit | 3.8, 3.9, 3.10, 3.11 |
3838
+-------------------------------------+--------------------------------+
3939
| Red Hat Enterprise Linux 8 | 3.8, 3.9, 3.10, 3.11 |
4040
+-------------------------------------+--------------------------------+
41-
| macOS 12.6.x versions | 3.8, 3.9, 3.10, 3.11 |
41+
| CentOS 7, 64 bit | 3.8, 3.9, 3.10, 3.11 |
4242
+-------------------------------------+--------------------------------+
43-
| Windows 10 Pro, Enterprise | 3.8, 3.9, 3.10, 3.11 |
43+
| macOS 10.15.x versions or higher | 3.8, 3.9, 3.10, 3.11 |
44+
+-------------------------------------+--------------------------------+
45+
| Windows 10, 64-bit Pro, Enterprise | 3.8, 3.9, 3.10, 3.11 |
4446
| or Education editions | |
4547
+-------------------------------------+--------------------------------+
4648
| Windows Server 2016 or higher | 3.8, 3.9, 3.10, 3.11 |
@@ -64,6 +66,7 @@ Installing prerequisites
6466
Run the installer by double clicking it. Follow the installation steps to set up the software.
6567

6668
While installing, make sure you check the box to *add Python to system PATH*.
69+
Also, it is recommended to use the installer option to disable the PATH length limit.
6770

6871
.. note::
6972

@@ -81,6 +84,12 @@ Installing prerequisites
8184

8285
Run the installer by double clicking it. Follow the installation steps to set up the software.
8386

87+
4. (Optional) Install FFMPEG
88+
89+
Download FFMPEG binary from `here <https://ffmpeg.org/download.html>`__
90+
91+
Set FFMPEG's path (e.g., ``C:\ffmpeg\bin``) to the PATH environmental variable on Windows.
92+
8493
.. tab-item:: Linux
8594
:sync: linux
8695

@@ -96,7 +105,7 @@ Installing prerequisites
96105
97106
sudo apt-get update
98107
sudo apt-get upgrade
99-
sudo apt-get install python3-venv build-essential python3-dev git-all
108+
sudo apt-get install python3-venv build-essential python3-dev git-all libgl1-mesa-dev ffmpeg
100109
101110
For an Intel Integrated Graphics Card, you can install the `Intel Graphics Compute Runtime <https://github.com/intel/compute-runtime>`__ to enable inference on this device. The command for Ubuntu 20.04 is:
102111

@@ -133,7 +142,8 @@ Installing prerequisites
133142
.. code-block:: sh
134143
135144
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
136-
After you install it, follow the instructions from the Homebrew installation to set it up.
145+
146+
After you install it, follow the instructions from the Homebrew installation to set it up.
137147

138148
3. **Install Python and dependencies**
139149

@@ -142,6 +152,8 @@ Installing prerequisites
142152
brew install python@3.9
143153
brew install protobuf
144154
155+
# optional but recommended
156+
brew install ffmpeg
145157
146158
Run each step below in a terminal.
147159

@@ -250,6 +262,56 @@ Installing prerequisites
250262
CMD /tmp/scripts/run
251263
252264
265+
.. tab-item:: Amazon SageMaker
266+
:sync: amazon-sagemaker
267+
268+
.. note::
269+
270+
An `AWS <https://console.aws.amazon.com/console/home?nc2=h_ct&src=header-signin>`__
271+
account and access to
272+
`Amazon SageMaker Studio <https://aws.amazon.com/sagemaker/studio/>`__
273+
are required.
274+
275+
1. **Log into your Amazon SageMaker Studio Environment and** ``Add user``.
276+
277+
|amazon-studio-1|
278+
279+
2. **Choose desired user profile name**
280+
281+
|amazon-studio-2|
282+
283+
3. **Choose Jupyter Lab version 3.0**
284+
285+
|amazon-studio-3|
286+
287+
4. **Choose the remaining default setting and click "Submit" to add a user.**
288+
5. **Launch the Amazon SageMaker Studio environment.**
289+
290+
Click "Open Studio" to start the environment:
291+
292+
|amazon-studio-4|
293+
294+
.. note::
295+
296+
You are using an ``ml.t3.medium`` instance, which is for free for
297+
250 hours per month for the first 2 months on Studio notebook.
298+
299+
6. **Wait for a couple of minutes for your environment to load.**
300+
301+
You should be able to see the following screen:
302+
303+
|amazon-studio-5|
304+
305+
7. **Select a SageMaker image.**
306+
307+
Choose ``Data Science 3.0`` in "Select a SageMaker image" drop-down under
308+
"Notebooks and compute resources".
309+
310+
Then, click **+** on "Image Terminal" to start a terminal session:
311+
312+
|amazon-studio-6|
313+
314+
253315
Installing notebooks
254316
++++++++++++++++++++
255317

@@ -294,6 +356,19 @@ Installing notebooks
294356
295357
pip install -r requirements.txt
296358
359+
360+
.. important::
361+
362+
In case of problems with accessing HuggingFace in PRC, set-up the networking
363+
environment before you launch the notebooks:
364+
365+
.. code-block::
366+
367+
pip install -U huggingface_hub
368+
set HF_ENDPOINT = https://hf-mirror.com
369+
370+
For more information, visit `HF-Mirror HuggingFace <https://hf-mirror.com>`__.
371+
297372
.. tab-item:: Linux
298373
:sync: linux
299374
@@ -333,6 +408,18 @@ Installing notebooks
333408
334409
pip install -r requirements.txt
335410
411+
.. important::
412+
413+
In case of problems with accessing HuggingFace in PRC, set-up the networking
414+
environment before you launch the notebooks:
415+
416+
.. code-block::
417+
418+
pip install -U huggingface_hub
419+
set HF_ENDPOINT = https://hf-mirror.com
420+
421+
For more information, visit `HF-Mirror HuggingFace <https://hf-mirror.com>`__.
422+
336423
.. tab-item:: macOS
337424
:sync: macos
338425
@@ -475,6 +562,69 @@ Installing notebooks
475562
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.
476563
477564
565+
.. tab-item:: Amazon SageMaker
566+
:sync: amazon-sagemaker
567+
568+
569+
**Use the terminal and follow the steps below.**
570+
571+
|amazon-studio-7|
572+
573+
574+
1. **Install few system dependencies.**
575+
576+
.. code-block::
577+
578+
apt update
579+
apt install build-essential -y
580+
apt install libpython3.9-dev -y
581+
apt install libgl1-mesa-glx -y
582+
583+
2. **Setup OpenVINO conda environment.**
584+
585+
.. code-block::
586+
587+
conda create --name openvino_env python=3.9
588+
conda activate openvino_env
589+
conda install ipykernel
590+
set PATH="/anaconda/envs/openvino_env/bin;%PATH%"
591+
592+
3. **Setup OpenVINO Notebooks.**
593+
594+
.. code-block::
595+
596+
git clone https://github.com/openvinotoolkit/openvino_notebooks.git
597+
cd openvino_notebooks
598+
# Install OpenVINO and OpenVINO notebook Requirements
599+
python -m pip install --upgrade pip
600+
pip install -r requirements.txt
601+
602+
4. **Run the Notebooks**
603+
604+
* To run the notebooks, click the top level "openvino_notebooks" folder
605+
and navigate to your example:
606+
607+
|amazon-studio-8|
608+
609+
* Choose "Image" - ``Data Science 3.0``,
610+
"Kernel" - ``Python [conda env:openvino_env],``
611+
"Instance type"- your desired compute instance.
612+
613+
|amazon-studio-9|
614+
615+
|amazon-studio-10|
616+
617+
|amazon-studio-11|
618+
619+
.. note::
620+
621+
Make sure you use the ``Python [conda env:openvino_env]``
622+
environment (not ``Python 3``).
623+
624+
* Next, run the cells of the notebook. You may try other notebooks to
625+
explore OpenVINO features and examples.
626+
627+
478628
Run the Notebooks
479629
#################
480630
@@ -614,6 +764,27 @@ Additional Resources
614764
615765
.. |ml-studio-2| image:: https://user-images.githubusercontent.com/15709723/117582205-b6f4d580-b0b5-11eb-9b83-eb2004ad9b19.png
616766
617-
.. |docker-terminal-1| image:: https://user-images.githubusercontent.com/15709723/127793994-355e4d29-d131-432d-a12a-b08ca6131223.png
767+
.. |amazon-studio-1| image:: https://user-images.githubusercontent.com/4837253/199801883-7bb64ad2-bb7f-4477-ace1-25111d4fd43c.png
768+
769+
.. |amazon-studio-2| image:: https://user-images.githubusercontent.com/4837253/199802173-8d65c851-604b-4b92-bafa-cae86b17d1ec.png
618770
771+
.. |amazon-studio-3| image:: https://user-images.githubusercontent.com/4837253/199802353-14c17233-3dae-4649-bbfe-59b8a598450c.png
772+
773+
.. |amazon-studio-4| image:: https://user-images.githubusercontent.com/4837253/199802726-97c85732-ff25-4cdd-ad6e-d491b4ed122b.png
774+
775+
.. |amazon-studio-5| image:: https://user-images.githubusercontent.com/15709723/199784252-c8581c73-342a-4c70-9207-5543d7b87346.png
776+
777+
.. |amazon-studio-6| image:: https://user-images.githubusercontent.com/4837253/199805717-5d102d27-e92e-4426-8d14-0484fd5ba24c.png
778+
779+
.. |amazon-studio-7| image:: https://user-images.githubusercontent.com/4837253/199807022-3cc5dd9e-f9f0-445d-be5e-d429dc1b752c.png
780+
781+
.. |amazon-studio-8| image:: https://user-images.githubusercontent.com/4837253/199810405-0f6748e1-d5f5-469e-8305-a96724dfffba.png
782+
783+
.. |amazon-studio-9| image:: https://user-images.githubusercontent.com/4837253/199812540-c52ea429-9d53-4bdb-aec1-a0b8616c6fcc.png
784+
785+
.. |amazon-studio-10| image:: https://user-images.githubusercontent.com/4837253/199812587-20c3e360-3a31-4032-b17a-8b242d6ccc26.png
786+
787+
.. |amazon-studio-11| image:: https://user-images.githubusercontent.com/4837253/199812713-32074aa7-8190-43c8-815c-231542c7b286.png
788+
789+
.. |docker-terminal-1| image:: https://user-images.githubusercontent.com/15709723/127793994-355e4d29-d131-432d-a12a-b08ca6131223.png
619790

docs/nbdoc/consts.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
repo_owner = "openvinotoolkit"
77
repo_name = "openvino_notebooks"
88
repo_branch = "tree/main"
9-
artifacts_link = "http://repository.toolbox.iotg.sclab.intel.com/projects/ov-notebook/0.1.0-latest/20240515220822/dist/rst_files/"
9+
artifacts_link = "http://repository.toolbox.iotg.sclab.intel.com/projects/ov-notebook/0.1.0-latest/20240605220807/dist/rst_files/"
1010
blacklisted_extensions = ['.xml', '.bin']
1111
notebooks_repo = "https://github.com/openvinotoolkit/openvino_notebooks/blob/latest/"
1212
notebooks_binder = "https://mybinder.org/v2/gh/openvinotoolkit/openvino_notebooks/HEAD?filepath="

0 commit comments

Comments
 (0)