Docker Containerization Guidelines#

Important

When the Docker Env is ready to use, the details of which are available below, click to continue to the quickstart section Checking the build scikit-plots.

See also

scikit-plots/scikit-plots

🚀 Docker Containerization#

💡 Work on Docker Desktop or Github Codespaces

Here’s how containerization works:

  • Isolation: Containers run independently of each other and the host system, ensuring that they don’t interfere with other applications or containers.

  • Portability: Since containers include everything the application needs to run, they can be moved between different environments (like from development to production) without any compatibility issues.

  • Efficiency: Containers are more lightweight than virtual machines (VMs) because they share the host OS’s kernel rather than running their own separate operating system. This makes them faster and more resource-efficient.

  • Consistency: The application inside the container runs the same way regardless of where it’s deployed, ensuring consistency across environments.

Github Codespaces Guide#

(Connect IDE Interface Vscode or Jupyter Notebook)

👉 (recommended) Choose (recommended) not (default) Option for best practise:

Open in GitHub Codespaces

Step by step:



Docker Desktop Guide#

## Forked repo: https://github.com/scikit-plots/scikit-plots.git
git clone https://github.com/YOUR-USER-NAME/scikit-plots.git
cd scikit-plots/docker

## Use terminal or open to vscode to run ``docker compose``
code .

Docker Environment Setup for IDE (Vscode/Jupyter) and/or NVIDIA GPU driver

This repository contains Docker & Docker Compose configurations for running Jupyter Notebooks with optional NVIDIA GPU support.

You can run containers with either host-installed CUDA or pre-installed CUDA inside the container.

🏷️ Docker Compose Quickstart Guide#

💡 The easiest way to launch the environment is using Docker Compose.#

▶️ Run Docker Env Jupyter Notebook (CPU only)

docker compose up --build notebook_cpu

▶️ Run Docker Env Jupyter Notebook (With NVIDIA Host GPU)

docker compose up --build app_nvidia_host_gpu_driver

▶️ Run Docker Env Jupyter Notebook (With NVIDIA Internal CUDA GPU)

docker compose up --build app_nvidia_internal_gpu_driver

▶️ Run Docker Env Jupyter Notebook by VS Code#

▶️ Connect Docker Container Especially When Docker-GUI dont available#

# docker-compose up --build notebook_cpu

docker ps  # check running containers
docker logs CONTAINER_ID_OR_NAME  # find jupyter (token) http address 127.0....
docker exec -it CONTAINER_ID_OR_NAME bash  # Connect interactive terminal

▶️ Run setup_vscode_ext.sh#

## (Optionally) Install common vscode extensions
##✅ C/C++/Python and Jupyter Notebook
##✅ Linter and Formatter
bash docker/script/setup_vscode_ext.sh  # (not needed every time)

▶️ Run post_create_commands.sh#

“See Also: first-run-notice.txt”

first-run-notice.txt#
👋 Welcome to `scikit-plots` in GitHub Codespaces!

🔍 To explore VS Code to its fullest, search using the Command Palette (Cmd/Ctrl + Shift + P or F1).

ℹ️  Look at https://scikit-plots.github.io/dev/introduction/quick_start.html
  for more contribution details https://scikit-plots.github.io/dev/devel/index.html.

⭐⭐ =====================================  IMPORTANT!!  ===================================== ⭐⭐
  To complete setup of your development environment to run the following script in the terminal:

    ##💽 (Optionally) Memory size: df -h && du -h --max-depth=1

    ##🛠️ (recommended) Apply in bash `setup_conda_env_create.sh` `post_create_commands.sh`
    ## 👉 Some steps can be skipped when container creation due to storage size limitations
    ## ⚠️ `ERROR: ... : No space left on device`
    ##✅ directories to mark as safe like ( git config --global --add safe.directory '*' )
    ##✅ fetching submodules ( git submodule update --init )
    ##✅ add remote upstream ( git remote add upstream https://github.com/scikit-plots/scikit-plots.git )
    ##✅ fetch tags from upstream ( git fetch upstream --tags )
    ##✅ create a new environment with python 3.11 ( mamba create -n "py311" python=3.11 ipykernel -y )
    ##✅ install required packages ( pip install -r ./requirements/all.txt )
    ##✅ install pre-commit hooks ( pre-commit install )
    ##✅ install the development version of scikit-plots ( pip install --no-build-isolation --no-cache-dir -e . )
    bash ".devcontainer/script/post_create_commands.sh"  # (not needed every time)

    ##👉 Open to new terminal mamba (or conda)
    conda init
    conda info -e
    # (DevContainer) mamba activate /workspaces/scikit-plots/venv
    mamba activate py311
    mamba activate base

    ##✅ Checking the build without root
    bash -c "cd ~ && python -c 'import scikitplot; scikitplot.show_config()'"

    ##✅ Install tensorflow-cpu, if needed
    pip install -r ./requirements/all.txt
    pip install -r ./requirements/cpu.txt

    ##✍ Continue to creating a branch
    ##🌐 Read more at: https://scikit-plots.github.io/dev/devel/quickstart_contributing.html#creating-a-branch

⭐⭐ ========================================================================================= ⭐⭐

🚯 Stop Containers#

docker compose down

🐳 Docker Compose Configuration#

This project is based on Docker Compose and includes multiple services:

🔹 notebook_cpu (CPU-Only)

Runs Jupyter Notebook using jupyter/tensorflow-notebook:latest

No CUDA support, best for lightweight tasks

Mounts the local folder scikit-plots to /home/jovyan/work

Runs on port 8888

🔹 app_nvidia_host_gpu_driver (Uses Host CUDA)

Runs Jupyter Notebook using jupyter/tensorflow-notebook:latest

Uses host-installed CUDA for GPU acceleration

Requires NVIDIA runtime enabled (–runtime=nvidia)

Runs on port 8889

🔹 app_nvidia_internal_gpu_driver (CUDA Inside Container)

Runs nvidia/cuda:12.6.3-cudnn-runtime-ubuntu24.04 with pre-installed CUDA

Includes NVIDIA GPU support without needing host CUDA

Requires NVIDIA runtime (–runtime=nvidia)

Runs on port 8890

🛠️ Custom Docker Commands#

If you need more control, you can use Docker CLI commands.

▶️ Build & Run the Container Manually

docker build -t my-custom-container -f docker/Dockerfile .
docker run -it --rm -p 8888:8888 my-custom-container

▶️ Check GPU Availability Inside Container

docker exec -it <container_id> nvidia-smi

📂 Folder Structure#

docker/
├── docker-compose.yml              # Primary Docker Compose file
├── docker-compose.override.yml     # Optional override file (auto-included if present)
├── Dockerfile                      # Custom Dockerfile
├── script/
│   ├── install_gpu_nvidia_cuda.sh  # GPU setup script

🖥️ Useful References#

📚 Jupyter Docker Stacks: Read the Docs

📚 Docker Compose: Official Docs

📚 Dockerfile Best Practices

📚 LocalStack Installation with Docker Compose

📚 NVIDIA CUDA in Containers: NVIDIA Docs

https://developer-blogs.nvidia.com/wp-content/uploads/2016/06/nvidia-docker.png

🚀 Now you’re ready to run Jupyter notebooks in Docker! 😊