diff --git a/docs/images/docker-faster-whisper.md b/docs/images/docker-faster-whisper.md index 31344dcca..673d0cc53 100755 --- a/docs/images/docker-faster-whisper.md +++ b/docs/images/docker-faster-whisper.md @@ -34,10 +34,21 @@ The architectures supported by this image are: | arm64 | ❌ | | | armhf | ❌ | | +## Version Tags + +This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags. + +| Tag | Available | Description | +| :----: | :----: |--- | +| latest | ✅ | Stable releases | +| gpu | ✅ | Releases with Nvidia GPU support | + ## Application Setup For use with Home Assistant [Assist](https://www.home-assistant.io/voice_control/voice_remote_local_assistant/), add the Wyoming integration and supply the hostname/IP and port that Whisper is running add-on." +When using the `gpu` tag with Nvidia GPUs, make sure you set the container to use the `nvidia` runtime and that you have the [Nvidia Container Toolkit](https://github.com/NVIDIA/nvidia-container-toolkit) installed on the host and that you run the container with the correct GPU(s) exposed. See the [Nvidia Container Toolkit docs](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/sample-workload.html) for more details. + For more information see the [faster-whisper docs](https://github.com/SYSTRAN/faster-whisper), ## Usage @@ -100,7 +111,7 @@ Containers are configured using parameters passed at runtime (such as those abov | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | | `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | -| `WHISPER_MODEL=tiny-int8` | Whisper model that will be used for transcription. From `tiny`, `base`, `small` and `medium.en`, all with `-int8` compressed variants | +| `WHISPER_MODEL=tiny-int8` | Whisper model that will be used for transcription. From `tiny`, `base`, `small` and `medium`, all with `-int8` compressed variants | | `WHISPER_BEAM=1` | Number of candidates to consider simultaneously during transcription. | | `WHISPER_LANG=en` | Language that you will speak to the add-on. |