eugenehp commited on
Commit
c2a0ac0
·
verified ·
1 Parent(s): 97b90e5

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +26 -9
README.md CHANGED
@@ -12,21 +12,38 @@ tags:
12
 
13
  MioCodec weights + ONNX decoder body (local parity fixtures removed).
14
 
15
- **Kind:** Staging redistrib of an upstream checkpoint for RLX runners.
 
 
 
 
 
16
 
17
- **Suggested Hub repo:** `eugenehp/miocodec`
18
 
19
- **Upstream:** https://huggingface.co/Aratako/MioCodec-25Hz-24kHz
 
 
 
 
 
 
 
 
 
 
 
 
20
 
21
- **RLX crate:** [`rlx-miotts`](https://github.com/MIT-RLX/rlx-models/tree/main/crates/rlx-miotts)
22
 
23
- ## Contents
24
 
25
- Weight tensors and configs in this directory (see file listing on the Hub).
26
 
27
  ## Run with RLX
28
 
29
- From [rlx-models](https://github.com/MIT-RLX/rlx-models) with this directory as the model path:
30
 
31
  ```bash
32
  cargo run -p rlx-miotts --release -- --codec-dir .
@@ -38,6 +55,6 @@ MIT — see `LICENSE`. Inherit upstream terms when redistributing.
38
 
39
  Original weights and authorship: https://huggingface.co/Aratako/MioCodec-25Hz-24kHz
40
 
41
- ## Staging note
42
 
43
- 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.
 
12
 
13
  MioCodec weights + ONNX decoder body (local parity fixtures removed).
14
 
15
+ | Field | Value |
16
+ |---|---|
17
+ | **Hub id** | [`eugenehp/miocodec`](https://huggingface.co/eugenehp/miocodec) |
18
+ | **Kind** | Staging redistrib of an upstream checkpoint for RLX runners. |
19
+ | **RLX crate** | [`rlx-miotts`](https://github.com/MIT-RLX/rlx-models/tree/main/crates/rlx-miotts) |
20
+ | **Upstream** | https://huggingface.co/Aratako/MioCodec-25Hz-24kHz |
21
 
22
+ ## Quick start
23
 
24
+ ```bash
25
+ hf download eugenehp/miocodec --local-dir .
26
+ cargo run -p rlx-miotts --release -- --codec-dir .
27
+ ```
28
+
29
+ ## File highlights
30
+
31
+ - `model.safetensors` (498.9 MiB)
32
+ - `decoder_body.onnx` (348.4 MiB)
33
+ - `miocodec.f16.gguf` (249.4 MiB)
34
+ - `config.yaml` (2.3 KiB)
35
+
36
+ ## Do not use as the main runtime pack
37
 
38
+ These files may be present for historical / staging reasons but are **not** the supported RLX load path:
39
 
40
+ - `miocodec.f16.gguf`
41
 
42
+ Community `*.f16.gguf` / LM-only Q4 packs are format wraps they are not drop-in replacements for the RLX primary file above.
43
 
44
  ## Run with RLX
45
 
46
+ Clone [rlx-models](https://github.com/MIT-RLX/rlx-models), place this repo under `weights/tts/miocodec` (or pass the path explicitly), then:
47
 
48
  ```bash
49
  cargo run -p rlx-miotts --release -- --codec-dir .
 
55
 
56
  Original weights and authorship: https://huggingface.co/Aratako/MioCodec-25Hz-24kHz
57
 
58
+ ## Redistrib note
59
 
60
+ This Hub repo exists so RLX recipes have a stable fetch target. When you only need the upstream checkpoint, prefer the Upstream link above.