Skip to content

fix model download examples #641

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

Open
eecczz wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix model download examples #641

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 3 additions & 2 deletions docs/usage/speech-to-text.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,14 @@ TODO: add a note about vad
export SPEACHES_BASE_URL="http://localhost:8000"

# Listing all available STT models
uvx speaches-cli registry ls --task automatic-speech-recognition | jq '.data | [].id'
uvx speaches-cli registry ls --task automatic-speech-recognition | jq -r '.data[]?.id'

# Downloading a Systran/faster-distil-whisper-small.en model
uvx speaches-cli model download Systran/faster-distil-whisper-small.en

# Check that the model has been installed
uvx speaches-cli model ls --task text-to-speech | jq '.data | map(select(.id == "Systran/faster-distil-whisper-small.en"))'
uvx speaches-cli model ls --task automatic-speech-recognition \
| jq -r '.data[]? | select(.id == "Systran/faster-distil-whisper-small.en") | .id'
```

## Usage
Expand Down
5 changes: 3 additions & 2 deletions docs/usage/text-to-speech.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@
export SPEACHES_BASE_URL="http://localhost:8000"

# Listing all available TTS models
uvx speaches-cli registry ls --task text-to-speech | jq '.data | [].id'
uvx speaches-cli registry ls --task text-to-speech | jq -r '.data[]?.id'

# Downloading a TTS model
uvx speaches-cli model download speaches-ai/Kokoro-82M-v1.0-ONNX

# Check that the model has been installed
uvx speaches-cli model ls --task text-to-speech | jq '.data | map(select(.id == "speaches-ai/Kokoro-82M-v1.0-ONNX"))'
uvx speaches-cli model ls --task text-to-speech \
| jq -r '.data[]? | select(.id | contains("Kokoro-82M-v1.0-ONNX")) | .id'
```

## Usage
Expand Down