valenti/spark-pocket-tts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix export-voice docs (#135)

Browse Source
This commit is contained in:
Gabriel de Marmiesse
2026-02-17 11:13:57 +01:00
committed by GitHub
parent aba1465fe5
commit e43b4851d0
1 changed files with 9 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/CLI Commands/export_voice.md
+9 -16
View File
@@ -1,8 +1,8 @@
# Export Voice # Export Voice
Kyutai Pocket TTS allows you to generate speech from an audio sample. However, processing an audio file each time is relatively slow and inefficient. Kyutai Pocket TTS allows you to generate speech with voice cloning from an audio sample. However, processing an audio file each time is relatively slow and inefficient.
The `export-voice` command allows you to convert an audio file to a voice embedding in safetensors format. The safetensors file can then be loaded very quickly whenever you generate speech. The `export-voice` command allows you to convert an audio file to a voice embedding (it's actually the kvcache) in safetensors format. The safetensors file can then be loaded very quickly whenever you generate speech.
## Basic Usage ## Basic Usage
@@ -12,18 +12,19 @@ uvx pocket-tts export-voice audio-path export-path
pocket-tts export-voice audio-path export-path pocket-tts export-voice audio-path export-path
``` ```
Only the first 30 seconds of the audio file will be processed.
## Command Options ## Command Options
### Required Parameters ### Required Parameters
- `audio-path`: Path of the audio file or directory to convert. `audio-path` can point to an `http:` or `hf:` (hugging face) file. If `audio-path` is a local directory, all audio files found inside it will be batch converted. Supports popular audio file formats like wav and mp3. - `audio-path`: Path of the audio file to convert. `audio-path` can point to an `http:` or `hf:` (hugging face) file. Supports popular audio file formats like wav and mp3.
- `export-path`: Path of safetensors file or directory to export to. For batch conversion, export-path should be a directory. The directory will be created if it does not exist. - `export-path`: Path of the output safetensors file to write.
### Options ### Options
- `--truncate`: Automatically truncate long audio files down to 30 seconds. - `--quiet`: Do not print any output except errors.
- `--config`: Model config path or signature
The other parameters such as `--lsd-decode-steps` and `--temperature` are the same as for the `generate` command. See the [generate documentation](https://github.com/kyutai-labs/pocket-tts/tree/main/docs/generate.md) for more details.
## Examples ## Examples
@@ -31,17 +32,9 @@ The other parameters such as `--lsd-decode-steps` and `--temperature` are the sa
# export a single file # export a single file
pocket-tts export-voice voice_memo127762.mp3 jack.safetensors pocket-tts export-voice voice_memo127762.mp3 jack.safetensors
# export a single file to a different directory (output is embbeddings/mary.safetensors
pocket-tts export-voice voices/mary.wav embeddings/
# export an entire directory of audio files, truncate long audios
pocket-tts export-voice voices/ embeddings/ --truncate
# export an online file to current directory # export an online file to current directory
pocket-tts export-voice https://huggingface.co/kyutai/tts-voices/resolve/main/alba-mackenna/announcer.wav . pocket-tts export-voice https://huggingface.co/kyutai/tts-voices/resolve/main/alba-mackenna/announcer.wav ./announcer.safetensors
# use the exported safetensors # use the exported safetensors
pocket-tts generate --text "Hello, welcome to today's game between the Bears and Cubs." --voice announcer.safetensors pocket-tts generate --text "Hello, welcome to today's game between the Bears and Cubs." --voice announcer.safetensors
``` ```
Note: to indicate a directory rather than a file, please be sure to include a trailing / (\ on Windows).