Add model card and Desktop/ComfyUI installation guide

README.md

@@ -0,0 +1,103 @@
+---
+license: apache-2.0
+library_name: transformers
+language:
+- zh
+- en
+tags:
+- audio
+- speech-recognition
+- text-to-speech
+- voice-cloning
+- speech-editing
+- comfyui
+---
+
+# FireRedAudio · T8star-Aix distribution
+
+This repository provides the pinned FireRedAudio model snapshot used by both:
+
+- [FireRedAudio T8star-Aix Desktop](https://github.com/T8mars/FireRedAudio-T8-Desktop)
+- [comfyui-fireredaudio-T8](https://github.com/T8mars/comfyui-fireredaudio-T8)
+
+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.
+
+## Profiles
+
+| Profile | Download | Capabilities |
+|---|---:|---|
+| Lite | about 19.8 GiB | ASR and audio understanding |
+| Full | about 27.6 GiB | Lite plus TTS, voice design, and speech editing |
+
+Full adds `RedAE_decoder/model.pt`. Voice generation, design, and editing cannot run with Lite alone.
+
+## Required layout
+
+The same directory can be used by Desktop and ComfyUI:
+
+```text
+FireRedAudio/
+├─ FireRedAudio/
+│  ├─ config.json
+│  ├─ model-00001-of-00005.safetensors
+│  ├─ model-00002-of-00005.safetensors
+│  ├─ model-00003-of-00005.safetensors
+│  ├─ model-00004-of-00005.safetensors
+│  ├─ model-00005-of-00005.safetensors
+│  ├─ model.safetensors.index.json
+│  ├─ processor_config.json
+│  ├─ tokenizer.json
+│  └─ tokenizer_config.json
+└─ RedAE_decoder/
+   └─ model.pt
+```
+
+## Desktop installation
+
+The desktop application has a built-in downloader. Choose `Hugging Face` or `Auto`, select Lite/Full, and click **开始/继续下载**. Interrupted downloads resume using Hugging Face Hub metadata.
+
+For a manual download:
+
+```python
+from huggingface_hub import snapshot_download
+
+snapshot_download(
+    repo_id="t8star/Firered-Audio-Comfy",
+    local_dir=r"D:\FireRedAudio-Models",
+    allow_patterns=["FireRedAudio/*", "RedAE_decoder/*"],
+)
+```
+
+Then select `D:\FireRedAudio-Models` as the model root in the desktop application.
+
+## ComfyUI installation
+
+Install the node first, then run its downloader:
+
+```powershell
+cd ComfyUI\custom_nodes\comfyui-fireredaudio-T8
+python scripts\setup_runtime.py
+python scripts\download_models.py --target "D:\ComfyUI\models\TTS\FireRedAudio" --profile full --source huggingface
+```
+
+Or use `snapshot_download` directly with this destination:
+
+```python
+from huggingface_hub import snapshot_download
+
+snapshot_download(
+    repo_id="t8star/Firered-Audio-Comfy",
+    local_dir=r"D:\ComfyUI\models\TTS\FireRedAudio",
+    allow_patterns=["FireRedAudio/*", "RedAE_decoder/*"],
+)
+```
+
+Restart ComfyUI and select `FireRedAudio` in the `T8 FireRedAudio Model Loader` node. Do not place these dependencies into ComfyUI's Python environment; the node uses its own pinned worker runtime to keep Transformers 5.8 isolated from other nodes.
+
+## Integrity and reproducibility
+
+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.
+
+## Responsible use
+
+Only clone or edit voices with the speaker's authorization and in compliance with applicable law and platform policies. Do not use generated audio for impersonation, fraud, harassment, infringement, or deceptive attribution. Generated output may contain errors or artifacts and requires human review before publication.