Upload README.md with huggingface_hub

README.md

@@ -7,30 +7,47 @@ tags:
 - melotts
 - vits2
 - rlx
+- onnx
 ---
 
-# TinyTTS RLX bundle
+# TinyTTS / MeloTTS RLX bundle
 
-MeloTTS/VITS2 English ONNX subgraphs + frontend for RLX TinyTTS (and MeloTTS). Prefer ONNX tree or `tiny-tts.rlxpack` — not community `*.f16.gguf` wraps.
+MeloTTS/VITS2 English ONNX subgraphs + frontend for RLX TinyTTS and MeloTTS. Metal/MLX/CPU validated.
 
-**Kind:** RLX-native weight bundle (not a plain upstream mirror).
+| Field | Value |
+|---|---|
+| **Hub id** | [`eugenehp/tiny-tts-rlx`](https://huggingface.co/eugenehp/tiny-tts-rlx) |
+| **Kind** | RLX-native weight bundle (graphs + sidecars ready for `rlx-*` crates). |
+| **RLX crate** | [`rlx-tiny-tts`](https://github.com/MIT-RLX/rlx-models/tree/main/crates/rlx-tiny-tts) |
+| **Upstream** | https://github.com/tronghieuit/tiny-tts |
 
-**Suggested Hub repo:** `eugenehp/tiny-tts-rlx`
+## Quick start
 
-**Upstream:** https://github.com/tronghieuit/tiny-tts
+```bash
+hf download eugenehp/tiny-tts-rlx --exclude '*.f16.gguf' --local-dir weights/tts/tiny-tts-rlx
+just fetch-tiny-tts && cargo run -p rlx-tiny-tts --release --features apple-silicon -- --data weights/tts/tiny-tts-rlx --text "Hi." --device metal --out /tmp/tiny.wav
+```
+
+## Primary files (use these)
 
-**RLX crate:** [`rlx-tiny-tts`](https://github.com/MIT-RLX/rlx-models/tree/main/crates/rlx-tiny-tts)
+- `tiny-tts.rlxpack` — 48.5 MiB
+- `config.json` — 325 B
+- `onnx/decoder.onnx` — 13.8 MiB
 
 ## Contents
 
-`config.json`, `onnx/*.onnx`, `frontend/`, optional `tiny-tts.rlxpack` (`just export-tiny-tts-rlxpack`).
+Either unpack `tiny-tts.rlxpack` or use the ONNX + `frontend/` tree. Also used by `rlx-melotts`.
+
+## Note
+
+MeloTTS (`rlx-melotts`) loads this same bundle — locally `weights/tts/melotts` is a symlink.
 
 ## Run with RLX
 
-From [rlx-models](https://github.com/MIT-RLX/rlx-models) with this directory as the model path:
+Clone [rlx-models](https://github.com/MIT-RLX/rlx-models), place this repo under `weights/tts/tiny-tts-rlx` (or pass the path explicitly), then:
 
 ```bash
-cargo run -p rlx-tiny-tts --release -- --data . --text "The weather is nice today." --out out.wav
+just fetch-tiny-tts && cargo run -p rlx-tiny-tts --release --features apple-silicon -- --data weights/tts/tiny-tts-rlx --text "Hi." --device metal --out /tmp/tiny.wav
 ```
 
 ## License
@@ -39,6 +56,6 @@ MIT — see `LICENSE`. Inherit upstream terms when redistributing.
 
 Original weights and authorship: https://github.com/tronghieuit/tiny-tts
 
-## Staging note
+## Maintenance
 
-Prepared from the local `weights/` tree in [rlx-models](https://github.com/MIT-RLX/rlx-models) for a future standalone Hub upload. Prefer fetching upstream when this is only a redistrib.
+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`.