From 2875c30072e840a3573504fd32ce8d3a9bb7698d Mon Sep 17 00:00:00 2001
From: Francesco Mattioli <Francesco.mttl@gmail.com>
Date: Sun, 3 Nov 2024 01:38:00 +0100
Subject: [PATCH] New JupyterLab Dockerfile (#17071)

Co-authored-by: Ultralytics Assistant <135830346+UltralyticsAssistant@users.noreply.github.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
---
 .github/workflows/docker.yaml |  9 +++++++++
 docker/Dockerfile-jupyter     | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+)
 create mode 100644 docker/Dockerfile-jupyter

diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml
index ef7dd86e96..38f30bb1b6 100644
--- a/.github/workflows/docker.yaml
+++ b/.github/workflows/docker.yaml
@@ -170,6 +170,15 @@ jobs:
             docker build -f docker/Dockerfile-runner -t $t .
             docker push $t
           fi
+          if [[ "${{ matrix.tags }}" == "latest-python" ]]; then
+            t=ultralytics/ultralytics:latest-jupyter
+            v=ultralytics/ultralytics:${{ steps.get_version.outputs.version_tag }}-jupyter
+            docker build -f docker/Dockerfile-jupyter -t $t -t $v .
+            docker push $t
+            if [[ "${{ steps.check_tag.outputs.new_release }}" == "true" ]]; then
+              docker push $v
+            fi
+          fi
 
   trigger-actions:
     runs-on: ubuntu-latest
diff --git a/docker/Dockerfile-jupyter b/docker/Dockerfile-jupyter
new file mode 100644
index 0000000000..e42639b9b7
--- /dev/null
+++ b/docker/Dockerfile-jupyter
@@ -0,0 +1,34 @@
+# Ultralytics YOLO 🚀, AGPL-3.0 license
+# Builds ultralytics/ultralytics:latest-jupyter image on DockerHub https://hub.docker.com/r/ultralytics/ultralytics
+# Image provides JupyterLab interface for interactive YOLO development and includes tutorial notebooks
+
+# Start from Python-based Ultralytics image for full Python environment
+FROM ultralytics/ultralytics:latest-python
+
+# Install JupyterLab for interactive development
+RUN /usr/local/bin/pip install jupyterlab
+
+# Create persistent data directory structure
+RUN mkdir /data
+
+# Configure YOLO directory paths
+RUN mkdir /data/datasets && /usr/local/bin/yolo settings datasets_dir="/data/datasets"
+RUN mkdir /data/weights && /usr/local/bin/yolo settings weights_dir="/data/weights"
+RUN mkdir /data/runs && /usr/local/bin/yolo settings runs_dir="/data/runs"
+
+# Start JupyterLab with tutorial notebook
+ENTRYPOINT ["/usr/local/bin/jupyter", "lab", "--allow-root", "/ultralytics/examples/tutorial.ipynb"]
+
+# Usage Examples -------------------------------------------------------------------------------------------------------
+
+# Build and Push
+# t=ultralytics/ultralytics:latest-jupyter && sudo docker build -f docker/Dockerfile-jupyter -t $t . && sudo docker push $t
+
+# Run
+# t=ultralytics/ultralytics:latest-jupyter && sudo docker run -it --ipc=host -p 8888:8888 $t
+
+# Pull and Run
+# t=ultralytics/ultralytics:latest-jupyter && sudo docker pull $t && sudo docker run -it --ipc=host -p 8888:8888 $t
+
+# Pull and Run with local volume mounted
+# t=ultralytics/ultralytics:latest-jupyter && sudo docker pull $t && sudo docker run -it --ipc=host -p 8888:8888 -v "$(pwd)"/datasets:/data/datasets $t