Update model card: rlx_bundle merge layout and just fetch recipe
Browse files
README.md
CHANGED
|
@@ -25,15 +25,24 @@ RLX compile bundle for [KittenML/kitten-tts-mini-0.8](https://huggingface.co/Kit
|
|
| 25 |
|
| 26 |
## Quick start
|
| 27 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 28 |
```bash
|
| 29 |
# 1. Upstream ONNX checkpoint + voices
|
| 30 |
-
|
| 31 |
|
| 32 |
-
# 2. This RLX bundle (
|
| 33 |
-
|
| 34 |
|
| 35 |
-
# 3. Sentinel file for native auto-detection
|
| 36 |
-
ln -sf weights.safetensors .cache/kittentts-mini-0.8/model.safetensors
|
| 37 |
|
| 38 |
# 4. Synthesize (from rlx-models checkout)
|
| 39 |
cargo run -p rlx-kittentts --features native --release -- \
|
|
@@ -41,16 +50,6 @@ cargo run -p rlx-kittentts --features native --release -- \
|
|
| 41 |
--native --ipa "həˈloʊ" --voice Jasper --out-wav out.wav
|
| 42 |
```
|
| 43 |
|
| 44 |
-
Or with `just`:
|
| 45 |
-
|
| 46 |
-
```bash
|
| 47 |
-
just fetch-kittentts
|
| 48 |
-
huggingface-cli download eugenehp/kitten-tts-mini-0.8-rlx \
|
| 49 |
-
--local-dir .cache/kittentts-mini-0.8
|
| 50 |
-
ln -sf weights.safetensors .cache/kittentts-mini-0.8/model.safetensors
|
| 51 |
-
just kittentts -- --native --ipa "həˈloʊ" --out-wav /tmp/out.wav
|
| 52 |
-
```
|
| 53 |
-
|
| 54 |
## Layout after merge
|
| 55 |
|
| 56 |
```text
|
|
@@ -58,13 +57,14 @@ just kittentts -- --native --ipa "həˈloʊ" --out-wav /tmp/out.wav
|
|
| 58 |
config.json # from KittenML
|
| 59 |
voices.npz # from KittenML
|
| 60 |
kitten_tts_mini_v0_8.onnx
|
| 61 |
-
model.safetensors # symlink → weights.safetensors
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
|
|
|
|
| 65 |
```
|
| 66 |
|
| 67 |
-
Alternatively,
|
| 68 |
|
| 69 |
## Environment variables
|
| 70 |
|
|
@@ -74,6 +74,7 @@ Alternatively, keep `rlx_bundle/` as a subdirectory and set `RLX_ONNX_BUNDLE` to
|
|
| 74 |
| `RLX_ONNX_BUNDLE` | Bundle directory if not co-located with weights |
|
| 75 |
| `KITTEN_RLX_WEIGHTS` | Directory containing `model.safetensors` |
|
| 76 |
| `KITTEN_RLX_BUNDLE` | Legacy alias for `RLX_ONNX_BUNDLE` |
|
|
|
|
| 77 |
|
| 78 |
## Re-export
|
| 79 |
|
|
|
|
| 25 |
|
| 26 |
## Quick start
|
| 27 |
|
| 28 |
+
```bash
|
| 29 |
+
# From rlx-models root
|
| 30 |
+
just fetch-kittentts
|
| 31 |
+
just fetch-kitten-rlx-bundle
|
| 32 |
+
just kittentts -- --native --ipa "həˈloʊ" --voice Jasper --out-wav out.wav
|
| 33 |
+
```
|
| 34 |
+
|
| 35 |
+
Manual download:
|
| 36 |
+
|
| 37 |
```bash
|
| 38 |
# 1. Upstream ONNX checkpoint + voices
|
| 39 |
+
hf download KittenML/kitten-tts-mini-0.8 --local-dir .cache/kittentts-mini-0.8
|
| 40 |
|
| 41 |
+
# 2. This RLX bundle (into rlx_bundle/ subdirectory)
|
| 42 |
+
hf download eugenehp/kitten-tts-mini-0.8-rlx --local-dir .cache/kittentts-mini-0.8/rlx_bundle
|
| 43 |
|
| 44 |
+
# 3. Sentinel file for native auto-detection
|
| 45 |
+
ln -sf rlx_bundle/weights.safetensors .cache/kittentts-mini-0.8/model.safetensors
|
| 46 |
|
| 47 |
# 4. Synthesize (from rlx-models checkout)
|
| 48 |
cargo run -p rlx-kittentts --features native --release -- \
|
|
|
|
| 50 |
--native --ipa "həˈloʊ" --voice Jasper --out-wav out.wav
|
| 51 |
```
|
| 52 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 53 |
## Layout after merge
|
| 54 |
|
| 55 |
```text
|
|
|
|
| 57 |
config.json # from KittenML
|
| 58 |
voices.npz # from KittenML
|
| 59 |
kitten_tts_mini_v0_8.onnx
|
| 60 |
+
model.safetensors # symlink → rlx_bundle/weights.safetensors
|
| 61 |
+
rlx_bundle/ # this repo
|
| 62 |
+
graph.json
|
| 63 |
+
manifest.json
|
| 64 |
+
weights.safetensors
|
| 65 |
```
|
| 66 |
|
| 67 |
+
Alternatively, set `RLX_ONNX_BUNDLE` to the bundle directory path.
|
| 68 |
|
| 69 |
## Environment variables
|
| 70 |
|
|
|
|
| 74 |
| `RLX_ONNX_BUNDLE` | Bundle directory if not co-located with weights |
|
| 75 |
| `KITTEN_RLX_WEIGHTS` | Directory containing `model.safetensors` |
|
| 76 |
| `KITTEN_RLX_BUNDLE` | Legacy alias for `RLX_ONNX_BUNDLE` |
|
| 77 |
+
| `KITTEN_RLX_HF_REPO` | Override RLX bundle HF repo (default: `eugenehp/kitten-tts-mini-0.8-rlx`) |
|
| 78 |
|
| 79 |
## Re-export
|
| 80 |
|