Skip to content

Support transformers (main) #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
thespad wants to merge 2 commits into from
Closed

Support transformers (main) #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23537aa
Support transformers
thespad Sep 7, 2025
be3683c
Add changelog entry
thespad Sep 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ services:
- TZ=Etc/UTC
- WHISPER_MODEL=tiny-int8
- LOCAL_ONLY= #optional
- USE_TRANSFORMERS= #optional
- WHISPER_BEAM=1 #optional
- WHISPER_LANG=en #optional
volumes:
Expand All @@ -116,6 +117,7 @@ docker run -d \
-e TZ=Etc/UTC \
-e WHISPER_MODEL=tiny-int8 \
-e LOCAL_ONLY= `#optional` \
-e USE_TRANSFORMERS= `#optional` \
-e WHISPER_BEAM=1 `#optional` \
-e WHISPER_LANG=en `#optional` \
-p 10300:10300 \
Expand All @@ -134,8 +136,9 @@ Containers are configured using parameters passed at runtime (such as those abov
| `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation |
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
| `-e WHISPER_MODEL=tiny-int8` | Whisper model that will be used for transcription. From [here](https://github.com/SYSTRAN/faster-whisper/blob/master/faster_whisper/utils.py#L12-L31), all with `-int8` compressed variants |
| `-e WHISPER_MODEL=tiny-int8` | Whisper model that will be used for transcription. From [here](https://github.com/home-assistant/addons/blob/master/whisper/config.yaml#L25), smaller models also have `-int8` compressed variants |
| `-e LOCAL_ONLY=` | If set to `true`, or any other value, the container will not attempt to download models from HuggingFace and will only use locally-provided models. |
| `-e USE_TRANSFORMERS=` | If set to `true`, or any other value, the container will interpret `WHISPER_MODEL` as a HuggingFace transformers model id. |
| `-e WHISPER_BEAM=1` | Number of candidates to consider simultaneously during transcription. |
| `-e WHISPER_LANG=en` | Language that you will speak to the add-on. |
| `-v /config` | Local path for Whisper config files. |
Expand Down
4 changes: 3 additions & 1 deletion readme-vars.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ common_param_env_vars_enabled: true
param_container_name: "{{ project_name }}"
param_usage_include_env: true
param_env_vars:
- {env_var: "WHISPER_MODEL", env_value: "tiny-int8", desc: "Whisper model that will be used for transcription. From [here](https://github.com/SYSTRAN/faster-whisper/blob/master/faster_whisper/utils.py#L12-L31), all with `-int8` compressed variants"}
- {env_var: "WHISPER_MODEL", env_value: "tiny-int8", desc: "Whisper model that will be used for transcription. From [here](https://github.com/home-assistant/addons/blob/master/whisper/config.yaml#L25), smaller models also have `-int8` compressed variants"}
param_usage_include_vols: true
param_volumes:
- {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/data", desc: "Local path for Whisper config files."}
Expand All @@ -33,6 +33,7 @@ param_ports:
opt_param_usage_include_env: true
opt_param_env_vars:
- {env_var: "LOCAL_ONLY", env_value: "", desc: "If set to `true`, or any other value, the container will not attempt to download models from HuggingFace and will only use locally-provided models."}
- {env_var: "USE_TRANSFORMERS", env_value: "", desc: "If set to `true`, or any other value, the container will interpret `WHISPER_MODEL` as a HuggingFace transformers model id."}
- {env_var: "WHISPER_BEAM", env_value: "1", desc: "Number of candidates to consider simultaneously during transcription."}
- {env_var: "WHISPER_LANG", env_value: "en", desc: "Language that you will speak to the add-on."}
readonly_supported: true
Expand Down Expand Up @@ -87,6 +88,7 @@ init_diagram: |
"faster-whisper:latest" <- Base Images
# changelog
changelogs:
- {date: "07.09.25:", desc: "Add support for transformers models."}
- {date: "20.08.25:", desc: "Add gpu-legacy branch for pre-Turing cards."}
- {date: "10.08.25:", desc: "Add support for local-only mode."}
- {date: "30.12.24:", desc: "Add arm64 support for non-GPU builds."}
Expand Down
3 changes: 2 additions & 1 deletion root/etc/s6-overlay/s6-rc.d/svc-whisper/run
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ exec \
--language "${WHISPER_LANG:-en}" \
--data-dir /config \
--download-dir /config \
${LOCAL_ONLY:+--local-files-only}
${LOCAL_ONLY:+--local-files-only} \
${USE_TRANSFORMERS:+--use-transformers}