Files

T

Palash Debnath a7cfe288cb fix(catalogue): harvest review findings on #2013

- SetupSummary: an installed engine whose routing is "unavailable" reads
  Needs setup, not Ready (select is refused for it too); a failed /engines
  or /dictation/models fetch renders as an error with Retry instead of
  posing as "Off" / "Needs setup".
- Bulk installs (summary, model store, recommendation card) wait for every
  request to settle before re-enabling, and report which repos failed —
  one early rejection can no longer re-arm the button mid-flight.
- The weights list stays mounted across family switches (hidden under LLM)
  so download progress and Retry/Dismiss state survive navigation.
- Settings search: Hugging Face mirror terms route to Network; the legacy
  "models" tab id resolves to Storage. "Manage models" opens the TTS tab.
- Locales: uk "Рушії", zh-TW "引擎", vi "Engine" for the Engines heading.
- Docs name the family tab wherever the instruction depends on it.

2026-09-10 07:08:43 -07:00

2.6 KiB

Raw Blame History

VoiceStudio — Sherpa-ONNX Engine

Sherpa-ONNX (k2-fsa/sherpa-onnx) is a unified C++ ONNX runtime that wraps 20+ TTS model families (VITS, MeloTTS, Piper, Kokoro, Matcha, and more) behind one API, with pre-built wheels for Linux, Windows, and macOS (x86 and ARM). You bring the model: point VoiceStudio at any downloaded sherpa-onnx TTS model directory.

When to pick it

You want a specific community model (e.g. a Piper or VITS voice for your language) that no other engine hosts.
You need a dependable CPU engine with optional CUDA acceleration.

Setup

Install the runtime:
```
pip install sherpa-onnx
```
Download a TTS model from the sherpa-onnx releases and unpack it somewhere permanent.
Point VoiceStudio at the model directory and restart:
```
export OMNIVOICE_SHERPA_MODEL=/path/to/model-dir
```
Select the engine via Model Catalogue (TTS tab → Use) or OMNIVOICE_TTS_BACKEND=sherpa-onnx.

The directory must contain model.onnx and tokens.txt. Sherpa-ONNX ships no bundled default model, so the engine reports unavailable — with the reason — until OMNIVOICE_SHERPA_MODEL points at a valid directory. (Before this gate, selecting the engine unconfigured produced a failure mislabeled as out-of-memory — #919.)

Configuration

Variable	Default	Meaning
`OMNIVOICE_SHERPA_MODEL`	(unset)	Directory containing `model.onnx` + `tokens.txt`

Behaviour notes

Output defaults to 22.05 kHz (the VITS default); once a model is loaded, its own sample rate is used.
CPU is the universal baseline; the CUDA onnxruntime provider is available on Linux/Windows installs.
No cloning: voices come from the model itself. Multi-speaker VITS models select a voice by numeric speaker id; speed is supported.
Languages depend entirely on the model you download.

Known limits

One model at a time — switching models means changing OMNIVOICE_SHERPA_MODEL and restarting.
No voice design, no reference-audio cloning, no emotion controls (see expressive-speech.md).

Troubleshooting

"OMNIVOICE_SHERPA_MODEL not set" / "No model.onnx in …": follow Setup above — the variable must point at the unpacked model directory, not the archive.
Other issues: install/troubleshooting.md.

2.6 KiB Raw Blame History