Skip to content

whisper: Improve support for local custom Whisper models #3988

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

Merged
agners merged 6 commits into from
May 1, 2025
Merged

whisper: Improve support for local custom Whisper models #3988

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9fcb46c
Added configuration mapping to access local models.
DT-art1 Apr 18, 2025
205a255
Fixed Nitpick comments.
DT-art1 Apr 18, 2025
c3f5844
Bumped version to 2.5.0.
DT-art1 Apr 22, 2025
8e6349a
Exclude local models backup.
DT-art1 Apr 25, 2025
b61dc08
Fixed Nitpick comments.
DT-art1 Apr 25, 2025
945cb42
Separate directory for local models.
DT-art1 Apr 29, 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: 5 additions & 0 deletions whisper/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## [Unreleased]

- Added configuration mapping to access local models.
- Updated documentation about `custom_model` usage.

## 2.4.0

- Add "auto" for model and beam size (0) to select values based on CPU
Expand Down
4 changes: 4 additions & 0 deletions whisper/DOCS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ Available models:
### Option: `custom_model`

Path to a converted model directory, or a CTranslate2-converted Whisper model ID from the HuggingFace Hub like "Systran/faster-distil-whisper-small.en".
To use a local custom Whisper model, copy your model directory into the add-on's configuration directory on your Home Assistant instance:
`/addon_configs/core_whisper/<your-model-dir>`
Then, set the `custom_model` path to:
"`/config/<your-model-dir>`". For a local model, the path must start with `/config/`, as this is how the add-on accesses your Home Assistant configuration directory through the container's mounted volume.

### Option: `beam_size`

Expand Down
3 changes: 3 additions & 0 deletions whisper/config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ discovery:
- wyoming
backup_exclude:
- "models*"
map:
- type: addon_config
read_only: false
options:
model: auto
language: en
Expand Down