Improve consistency in variant -> config rename (#87)

Small follow-up on #59
This commit is contained in:
Václav Volhejn
2026-01-27 08:55:34 +00:00
committed by GitHub
parent 2b51649a65
commit 28b8244428
5 changed files with 14 additions and 16 deletions
+1 -2
View File
@@ -19,11 +19,10 @@ This will generate a WAV file `./tts_output.wav` with the default text and voice
- `--text TEXT`: Text to generate (default: "Hello world! I am Kyutai Pocket TTS. I'm fast enough to run on small CPUs. I hope you'll like me.")
- `--voice VOICE`: Path to audio conditioning file (voice to clone) (default: "hf://kyutai/tts-voices/alba-mackenna/casual.wav"). Urls and local paths are supported.
- `--output-path OUTPUT_PATH`: Output path for generated audio (default: "./tts_output.wav")
- `--confg CONFIG_PATH`: Path to custom config.yaml (for loading local model files)
### Generation Parameters
- `--variant VARIANT`: Model signature (default: "b6369a24")
- `--config CONFIG_PATH`: Path to custom config.yaml (for loading local model files) or model signature (default: "b6369a24")
- `--lsd-decode-steps LSD_DECODE_STEPS`: Number of generation steps (default: 1)
- `--temperature TEMPERATURE`: Temperature for generation (default: 0.7)
- `--noise-clamp NOISE_CLAMP`: Noise clamp value (default: None)
+2 -2
View File
@@ -37,12 +37,12 @@ The main class for text-to-speech generation.
#### Class Methods
##### `load_model(variant="b6369a24", temp=0.7, lsd_decode_steps=1, noise_clamp=None, eos_threshold=-4.0)`
##### `load_model(config="b6369a24", temp=0.7, lsd_decode_steps=1, noise_clamp=None, eos_threshold=-4.0)`
Load and return a TTSModel instance with pre-trained weights.
**Parameters:**
- `variant` (str): Model variant identifier (default: "b6369a24")
- `config` (str): Path to model config YAML file or a variant identifier (default: "b6369a24")
- `temp` (float): Sampling temperature for generation (default: 0.7)
- `lsd_decode_steps` (int): Number of generation steps (default: 1)
- `noise_clamp` (float | None): Maximum value for noise sampling (default: None)