piper / README.md
eugenehp's picture
Upload README.md with huggingface_hub
1a71053 verified
|
Raw
History Blame Contribute Delete
1.75 kB
---
license: mit
pipeline_tag: text-to-speech
library_name: rlx
tags:
- piper
- tts
- onnx
- rlx
---
# Piper en_US-lessac-medium (RLX staging)
Piper ONNX voice + RLX `rlx-split/` subgraphs.
| Field | Value |
|---|---|
| **Hub id** | [`eugenehp/piper`](https://huggingface.co/eugenehp/piper) |
| **Kind** | Converted / re-laid-out for RLX from an upstream checkpoint. |
| **RLX crate** | [`rlx-piper`](https://github.com/MIT-RLX/rlx-models/tree/main/crates/rlx-piper) |
| **Upstream** | https://huggingface.co/rhasspy/piper-voices |
## Quick start
```bash
hf download eugenehp/piper --local-dir .
cargo run -p rlx-piper --release -- --dir .
```
## File highlights
- `en_US-lessac-medium.onnx` (60.3 MiB)
- `piper.f16.gguf` (58.7 MiB)
- `rlx-split/flow_dec.onnx` (33.5 MiB)
- `rlx-split/enc_p.onnx` (24.4 MiB)
- `rlx-split/dp_manifest.json` (14.8 KiB)
- `en_US-lessac-medium.onnx.json` (4.8 KiB)
## Do not use as the main runtime pack
These files may be present for historical / staging reasons but are **not** the supported RLX load path:
- `piper.f16.gguf`
Community `*.f16.gguf` / LM-only Q4 packs are format wraps — they are not drop-in replacements for the RLX primary file above.
## Run with RLX
Clone [rlx-models](https://github.com/MIT-RLX/rlx-models), place this repo under `weights/tts/piper` (or pass the path explicitly), then:
```bash
cargo run -p rlx-piper --release -- --dir .
```
## License
MIT — see `LICENSE`. Inherit upstream terms when redistributing.
Original weights and authorship: https://huggingface.co/rhasspy/piper-voices
## Maintenance
Cards and LFS attrs are regenerated from the local `weights/` tree in [rlx-models](https://github.com/MIT-RLX/rlx-models) via `python3 scripts/prepare_weights_hf.py`.