From 3dfe6c6ea019c37aaad8db46435edc28aba35b35 Mon Sep 17 00:00:00 2001 From: "CHEN, CHUN" Date: Thu, 5 Jun 2025 19:28:13 +0800 Subject: [PATCH] docs: document Docker image usage for WhisperX in README - Add a new section to the README describing how to use pre-built Docker images for WhisperX with example commands. - Provide a link to the Docker image repository for available tags. Signed-off-by: CHEN, CHUN # Conflicts: # README.md --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 2b1adda..be2562d 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,18 @@ uv sync --all-extras --dev You may also need to install ffmpeg, rust etc. Follow openAI instructions here https://github.com/openai/whisper#setup. +### 3. Docker Images + +Execute pre-built WhisperX container images: + +```bash +docker run --gpus all -it -v ".:/app" ghcr.io/jim60105/whisperx:base-en -- --output_format srt audio.mp3 +docker run --gpus all -it -v ".:/app" ghcr.io/jim60105/whisperx:large-v3-ja -- --output_format srt audio.mp3 +docker run --gpus all -it -v ".:/app" ghcr.io/jim60105/whisperx:no_model -- --model tiny --language en --output_format srt audio.mp3 +``` + +Review the tag lists in this repository: [jim60105/docker-whisperX](https://github.com/jim60105/docker-whisperX) + ### Common Issues & Troubleshooting 🔧 #### libcudnn Dependencies (GPU Users)