t8star commited on
Commit
63effca
Β·
verified Β·
1 Parent(s): ffd450c

docs: document v1 quantized model revisions

Browse files
Files changed (1) hide show
  1. README.md +14 -15
README.md CHANGED
@@ -20,16 +20,18 @@ This repository provides the pinned FireRedAudio model snapshot used by both:
20
  - [FireRedAudio T8star-Aix Desktop](https://github.com/T8mars/FireRedAudio-T8-Desktop)
21
  - [comfyui-fireredaudio-T8](https://github.com/T8mars/comfyui-fireredaudio-T8)
22
 
23
- The model files retain the upstream directory layout and are not converted or quantized. The source project and model are maintained by [FireRedTeam/FireRedAudio](https://github.com/FireRedTeam/FireRedAudio). This mirror exists to give the T8star-Aix integrations a stable, resumable download location. Review the upstream license, model documentation, and limitations before use.
24
 
25
  ## Profiles
26
 
27
- | Profile | Download | Capabilities |
28
- |---|---:|---|
29
- | Lite | about 19.8 GiB | ASR and audio understanding |
30
- | Full | about 27.6 GiB | Lite plus TTS, voice design, and speech editing |
 
 
31
 
32
- Full adds `RedAE_decoder/model.pt`. Voice generation, design, and editing cannot run with Lite alone.
33
 
34
  ## Required layout
35
 
@@ -39,17 +41,14 @@ The same directory can be used by Desktop and ComfyUI:
39
  FireRedAudio/
40
  β”œβ”€ FireRedAudio/
41
  β”‚ β”œβ”€ config.json
42
- β”‚ β”œβ”€ model-00001-of-00005.safetensors
43
- β”‚ β”œβ”€ model-00002-of-00005.safetensors
44
- β”‚ β”œβ”€ model-00003-of-00005.safetensors
45
- β”‚ β”œβ”€ model-00004-of-00005.safetensors
46
- β”‚ β”œβ”€ model-00005-of-00005.safetensors
47
  β”‚ β”œβ”€ model.safetensors.index.json
48
  β”‚ β”œβ”€ processor_config.json
49
  β”‚ β”œβ”€ tokenizer.json
50
  β”‚ └─ tokenizer_config.json
51
  └─ RedAE_decoder/
52
- └─ model.pt
53
  ```
54
 
55
  ## Desktop installation
@@ -63,8 +62,8 @@ from huggingface_hub import snapshot_download
63
 
64
  snapshot_download(
65
  repo_id="t8star/Firered-Audio-Comfy",
 
66
  local_dir=r"D:\FireRedAudio-Models",
67
- allow_patterns=["FireRedAudio/*", "RedAE_decoder/*"],
68
  )
69
  ```
70
 
@@ -87,8 +86,8 @@ from huggingface_hub import snapshot_download
87
 
88
  snapshot_download(
89
  repo_id="t8star/Firered-Audio-Comfy",
 
90
  local_dir=r"D:\ComfyUI\models\TTS\FireRedAudio",
91
- allow_patterns=["FireRedAudio/*", "RedAE_decoder/*"],
92
  )
93
  ```
94
 
@@ -96,7 +95,7 @@ Restart ComfyUI and select `FireRedAudio` in the `T8 FireRedAudio Model Loader`
96
 
97
  ## Integrity and reproducibility
98
 
99
- The integrations pin a specific immutable Hub revision. Expected sizes and SHA-256 values are stored in `manifests/model_firered_audio.json` in both GitHub repositories. The downloader performs a fast structural/size validation after download and can optionally perform a full SHA-256 validation.
100
 
101
  ## Responsible use
102
 
 
20
  - [FireRedAudio T8star-Aix Desktop](https://github.com/T8mars/FireRedAudio-T8-Desktop)
21
  - [comfyui-fireredaudio-T8](https://github.com/T8mars/comfyui-fireredaudio-T8)
22
 
23
+ The source project and model are maintained by [FireRedTeam/FireRedAudio](https://github.com/FireRedTeam/FireRedAudio). This mirror provides pinned, resumable T8star-Aix revisions. Every revision keeps the same top-level layout and includes its own integrity and quantization metadata. Review the upstream license, model documentation, and limitations before use.
24
 
25
  ## Profiles
26
 
27
+ | Revision | Download | Status | Capabilities |
28
+ |---|---:|---|---|
29
+ | `bf16-slim-v1` | about 21.19 GiB | stable, lossless | Full stack, original BF16 main weights and inference-only RedAE decoder |
30
+ | `int8-wo-safe-v1` | about 14.76 GiB | stable, recommended | Full stack, TorchAO A16W8 Qwen blocks; audio modules stay in released precision |
31
+ | `int8-wo-extended-v1` | about 13.58 GiB | experimental | Full stack, extended A16W8 including audio blocks |
32
+ | `int8-convrot-experimental-v1` | about 14.76 GiB | experimental | Full stack, Comfy-Kitchen ConvRot A8W8 |
33
 
34
+ All revisions above include `RedAE_decoder/model.safetensors`. GGUF is not provided because existing GGUF runtimes cannot execute the complete audio encoder, continuous latent, DiT, and RedAE graph.
35
 
36
  ## Required layout
37
 
 
41
  FireRedAudio/
42
  β”œβ”€ FireRedAudio/
43
  β”‚ β”œβ”€ config.json
44
+ β”‚ β”œβ”€ model-00001-of-*.safetensors
45
+ β”‚ β”œβ”€ ...
 
 
 
46
  β”‚ β”œβ”€ model.safetensors.index.json
47
  β”‚ β”œβ”€ processor_config.json
48
  β”‚ β”œβ”€ tokenizer.json
49
  β”‚ └─ tokenizer_config.json
50
  └─ RedAE_decoder/
51
+ └─ model.safetensors
52
  ```
53
 
54
  ## Desktop installation
 
62
 
63
  snapshot_download(
64
  repo_id="t8star/Firered-Audio-Comfy",
65
+ revision="int8-wo-safe-v1",
66
  local_dir=r"D:\FireRedAudio-Models",
 
67
  )
68
  ```
69
 
 
86
 
87
  snapshot_download(
88
  repo_id="t8star/Firered-Audio-Comfy",
89
+ revision="int8-wo-safe-v1",
90
  local_dir=r"D:\ComfyUI\models\TTS\FireRedAudio",
 
91
  )
92
  ```
93
 
 
95
 
96
  ## Integrity and reproducibility
97
 
98
+ The integrations pin a specific immutable Hub revision. Every profile contains `fireredaudio-model.json` with its exact file sizes and SHA-256 values; INT8 profiles also contain `FireRedAudio/fireredaudio_quantization.json`. Desktop and ComfyUI perform a fast structural/size validation after selection and can optionally perform a full SHA-256 validation.
99
 
100
  ## Responsible use
101