Skip to content

Commit 5fe6b07

Browse files
Songchen XuSongchen Xu
authored andcommitted
update README (vibeasr-lm-i2_s-embed-q6_k_arm.gguf on huggingface and uasge)
1 parent a6470f1 commit 5fe6b07

2 files changed

Lines changed: 33 additions & 4 deletions

File tree

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,28 +114,50 @@ cmake --build build -j$(nproc)
114114
# Download pre-quantized models
115115
pip install huggingface_hub
116116
huggingface-cli download microsoft/VibeVoice-ASR-BitNet --local-dir models/vibeasr
117+
# NOTE: The LM I2_S GGUF is architecture-specific.
118+
# x86: use vibeasr-lm-i2_s-embed-q6_k.gguf
119+
# ARM: use vibeasr-lm-i2_s-embed-q6_k_arm.gguf
117120
```
118121

119122
---
120123

121124
## Usage
122125

126+
### Pre-quantized Models
127+
128+
> **⚠️ Architecture Note:** The LM (I2\_S) GGUF uses platform-specific bit-packing layouts — ARM (NEON) and x86 (AVX) versions are **not interchangeable**. The VAE (I8\_S) GGUF is architecture-independent.
129+
>
130+
> When downloading from [HuggingFace](https://huggingface.co/microsoft/VibeVoice-ASR-BitNet):
131+
> - **x86 (Intel/AMD):** use `vibeasr-lm-i2_s-embed-q6_k.gguf`
132+
> - **ARM (Apple Silicon / aarch64):** use `vibeasr-lm-i2_s-embed-q6_k_arm.gguf`
133+
>
134+
> If you build from source with `llama-quantize`, the output GGUF will automatically match your host architecture.
135+
123136
### CLI Inference
124137

125138
```bash
139+
# x86 (Intel / AMD)
126140
./build/bin/asr_infer \
127141
--vae-model models/vibeasr/vibeasr-vae-encoder-i8_s.gguf \
128142
--lm-model models/vibeasr/vibeasr-lm-i2_s-embed-q6_k.gguf \
129143
--audio input.wav -t 4
144+
145+
# ARM (Apple Silicon / aarch64)
146+
./build/bin/asr_infer \
147+
--vae-model models/vibeasr/vibeasr-vae-encoder-i8_s.gguf \
148+
--lm-model models/vibeasr/vibeasr-lm-i2_s-embed-q6_k_arm.gguf \
149+
--audio input.wav -t 4
130150
```
131151

132152
### Web Demo (Gradio)
133153

134154
```bash
135155
pip install gradio soundfile numpy
156+
157+
# Use the LM GGUF matching your architecture (see note above)
136158
python demo/gradio_asr_demo.py --port 7860 \
137159
--vae-model models/vibeasr/vibeasr-vae-encoder-i8_s.gguf \
138-
--lm-model models/vibeasr/vibeasr-lm-i2_s-embed-q6_k.gguf
160+
--lm-model models/vibeasr/vibeasr-lm-i2_s-embed-q6_k.gguf # or *_arm.gguf on ARM
139161
```
140162

141163
---

setup_env.py

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -168,15 +168,22 @@ def main():
168168
download_model()
169169

170170
if not args.skip_build and not args.skip_download:
171+
_, arch = system_info()
172+
model_name = SUPPORTED_HF_MODELS.get(args.hf_repo, {}).get("model_name", "vibeasr")
173+
model_dir = Path(args.model_dir) / model_name
174+
lm_suffix = "_arm" if arch == "arm64" else ""
175+
lm_gguf = f"vibeasr-lm-i2_s-embed-q6_k{lm_suffix}.gguf"
176+
171177
logger.info("=" * 60)
172178
logger.info("Setup complete! Try running:")
173179
logger.info("")
174-
model_name = SUPPORTED_HF_MODELS.get(args.hf_repo, {}).get("model_name", "vibeasr")
175-
model_dir = Path(args.model_dir) / model_name
176180
logger.info(f" ./build/bin/asr_infer \\")
177181
logger.info(f" --vae-model {model_dir}/vibeasr-vae-encoder-i8_s.gguf \\")
178-
logger.info(f" --lm-model {model_dir}/vibeasr-lm-i2_s-embed-q6_k.gguf \\")
182+
logger.info(f" --lm-model {model_dir}/{lm_gguf} \\")
179183
logger.info(f" --audio <your_audio.wav> -t 4")
184+
if arch == "arm64":
185+
logger.info("")
186+
logger.info(" NOTE: Using ARM-specific LM GGUF (I2_S bit-packing differs between ARM and x86)")
180187
logger.info("=" * 60)
181188

182189

0 commit comments

Comments
 (0)