Fix docker configurations (#44)

* fix: simplify docker build workflow to be multiplatform

* fix: set the slang version to 0.5.10

* docker: fix gpu base image to be compatible with CUDA 12

* docker: remove entrypoints

* docker: add bash entrypoint to overwrite base images entrypoint

* docs: update README.md

* workflow: change naming of docker images

* workflow: remove CI triggered by PRs to main

* feat: migrate CI docker images push to GHCR

* style: fix indentations in README.md and missing command

* docs: add section on prebuilt docker images on GHCR in README.md

Author: JCHAVEROT

.github/workflows/docker.yml

@@ -4,52 +4,32 @@ on:
   push:
     branches:
       - main
-
-  pull_request:
-    branches:
-      - main
   workflow_dispatch:
 
 env:
-  IMAGE_NAMESPACE: fabnemepfl
-  REGISTRY: docker.io
+  IMAGE_NAME: mmirage
+  REGISTRY: ghcr.io
 
 jobs:
   build-docker:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
     strategy:
       fail-fast: true
       matrix:
         include:
-          - platform: ubuntu-latest
-            path: docker/Dockerfile
-            tag_base: amd64
-            name: mmirage-git
-          - platform: ubuntu-latest
-            path: docker/Dockerfile.cpu
-            tag_base: amd64
-            name: mmirage-git-cpu
-          - platform: ubuntu-24.04-arm
-            path: docker/Dockerfile.cpu
-            tag_base: arm64
-            name: mmirage-git-cpu
+          - path: docker/Dockerfile
+            suffix: gpu
+            platforms: linux/amd64
+          - path: docker/Dockerfile.cpu
+            suffix: cpu
+            platforms: linux/amd64,linux/arm64
 
-    runs-on: ${{ matrix.platform }}
     environment: ${{ github.event_name != 'pull_request' && 'docker' || 'docker-ci' }}
 
     steps:
-      - name: Free space (ARM)
-        if: matrix.platform == 'ubuntu-24.04-arm'
-        run: |
-          df -h
-          du -h -d1 /home/runner || true
-
-          rm -rf /opt/hostedtoolcache
-          rm -rf /home/runner/.cache
-          rm -rf /home/runner/.docker
-          rm -rf /home/runner/actions-runner/_work/_tool
-
-          df -h
-
       - name: Free disk space
         uses: jlumbroso/free-disk-space@main
         with:
@@ -62,27 +42,40 @@ jobs:
             swap-storage: true
 
       - name: Check free space
-        run: df -h 
+        run: df -h
 
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Log in to DockerHub
+      - name: Log in to GitHub Container Registry (GHCR)
         if: github.event_name != 'pull_request'
         uses: docker/login-action@v3
         with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
 
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
+      - name: Docker metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ github.repository_owner }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=raw,value=latest,suffix=-${{ matrix.suffix }}
+            type=sha,format=long,suffix=-${{ matrix.suffix }}
+
       - name: Build and push
         uses: docker/build-push-action@v6
         with:
           context: .
           file: ${{ matrix.path }}
+          platforms: ${{ matrix.platforms }}
           push: ${{ github.event_name != 'pull_request' }}
-          tags: |
-            ${{ env.REGISTRY }}/${{ env.IMAGE_NAMESPACE }}/${{ matrix.name }}:latest-${{ matrix.tag_base }}
-            ${{ env.REGISTRY }}/${{ env.IMAGE_NAMESPACE }}/${{ matrix.name }}:${{ github.sha }}-${{ matrix.tag_base }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

README.md

@@ -10,57 +10,77 @@ MMIRAGE, which stands for **M**odular **M**ultimodal **I**ntelligent **R**eforma
 
 ## How to install
 
-To install the library, clone it from GitHub and install it with pip. The base
-install does not include the local SGLang runtime:
+To install the library, clone it from GitHub and install it with pip. The base install does not include the local SGLang runtime:
 
 ```bash
 git clone git@github.com:EPFLiGHT/MMIRAGE.git
-pip install -e ./MMIRAGE
+cd MMIRAGE
+pip install -e .
 ```
 
-Install the GPU extra when using the SGLang-backed `llm` processor for local
-GPU inference:
+Install the GPU extra when using the SGLang-backed `llm` processor for local GPU inference:
 
 ```bash
-pip install -e './MMIRAGE[gpu]'
+pip install -e ".[gpu]"
 ```
 
 For testing and scripts that make use of the library, it is advised to create a .env file:
 ```bash
 ./scripts/generate_env.sh
 ```
 
-## Docker 
+## Docker
 
-### Build
+The `docker-compose.yml` defines two services, `mmirage` (GPU) and `mmirage-cpu`.
 
-```bash
-docker compose build
-```
+### Prebuilt images
+
+Prebuilt images are published to GHCR for each push to `main`:
 
-### Run
+- `ghcr.io/epflight/mmirage:latest-gpu` (linux/amd64)
+- `ghcr.io/epflight/mmirage:latest-cpu` (linux/amd64, linux/arm64)
+
+How to use them:
 
 ```bash
-docker compose run --rm mmirage --config configs/your_config.yaml
+# GPU
+docker pull ghcr.io/epflight/mmirage:latest-gpu
+docker run --rm -it --gpus all ghcr.io/epflight/mmirage:latest-gpu
+
+# CPU
+docker pull ghcr.io/epflight/mmirage:latest-cpu
+docker run --rm -it ghcr.io/epflight/mmirage:latest-cpu
 ```
 
+### GPU
+
 The container requires an NVIDIA GPU. The `docker-compose.yml` is configured to request GPU access, but the host must have:
 - NVIDIA GPU drivers installed
 - NVIDIA Container Toolkit / `nvidia-container-runtime` configured for Docker
 - A recent Docker Engine and Docker Compose version with GPU support enabled
 
-Without these host-side prerequisites, `docker compose run` may fail to detect or use the GPU.
+Commands:
+
+```bash
+# Build
+docker compose build mmirage
+
+# Run
+docker compose run --rm -it mmirage
+```
 
 ### CPU-only
 
-The CPU image installs MMIRAGE without the GPU extra. It is suitable for
-workflows that do not instantiate the SGLang-backed `llm` processor, and is
-intended to support API-backed processors once they are available. Current
-configs that use `type: llm` require the GPU image or an install with the
-`[gpu]` extra.
+The CPU image installs MMIRAGE without the GPU extra. It is suitable for workflows that do not instantiate the SGLang-backed `llm` processor, and is intended to support API-backed processors once they are available. No CPU-ready configuration files are provided yet.
+
+Commands:
 
 ```bash
-docker compose run --rm mmirage-cpu --config configs/your_config.yaml
+# Build
+docker compose build mmirage-cpu
+
+# Run
+docker compose run --rm -it mmirage-cpu
 ```
 
 ## Key features

docker/Dockerfile

@@ -1,4 +1,4 @@
-FROM lmsysorg/sglang:latest
+FROM lmsysorg/sglang:v0.5.3rc1-cu126
 
 ENV NVIDIA_VISIBLE_DEVICES=all
 ENV NVIDIA_DRIVER_CAPABILITIES=compute,utility
@@ -8,4 +8,4 @@ WORKDIR /workspace/MMIRAGE
 
 RUN pip install --no-cache-dir .[gpu]
 
-ENTRYPOINT ["python3", "-m", "mmirage.shard_process"]
+ENTRYPOINT ["/bin/bash"]

docker/Dockerfile.cpu

@@ -5,4 +5,4 @@ WORKDIR /workspace/MMIRAGE
 
 RUN pip install --no-cache-dir .
 
-ENTRYPOINT ["python3", "-m", "mmirage.shard_process"]
+ENTRYPOINT ["/bin/bash"]

pyproject.toml

@@ -40,7 +40,7 @@ dependencies = [
 
 [project.optional-dependencies]
 gpu = [
-  "sglang>=0.5.2",
+  "sglang==0.5.10",
   "sgl_kernel",
   "xgrammar",
   "compressed_tensors",