README.md
10.8 KB · 426 lines · markdown Raw
1 ---
2 license: other
3 license_name: boson-higgs-audio-v3-research-and-non-commercial-license
4 license_link: https://huggingface.co/bosonai/higgs-tts-3-4b/blob/main/LICENSE
5 language:
6 - af
7 - ar
8 - as
9 - ast
10 - az
11 - ba
12 - be
13 - bg
14 - bn
15 - bs
16 - ca
17 - ceb
18 - ckb
19 - cs
20 - cy
21 - da
22 - de
23 - el
24 - en
25 - eo
26 - es
27 - et
28 - eu
29 - fa
30 - fi
31 - fr
32 - ga
33 - gl
34 - gu
35 - ha
36 - he
37 - hi
38 - hr
39 - ht
40 - hu
41 - hy
42 - id
43 - is
44 - it
45 - jv
46 - ka
47 - kab
48 - kam
49 - kea
50 - kk
51 - kn
52 - ko
53 - ky
54 - la
55 - lb
56 - lg
57 - ln
58 - lt
59 - luo
60 - lv
61 - mhr
62 - mi
63 - mk
64 - ml
65 - mn
66 - mr
67 - ms
68 - mt
69 - ne
70 - nl
71 - no
72 - nso
73 - ny
74 - oc
75 - om
76 - pa
77 - pl
78 - ps
79 - pt
80 - ro
81 - ru
82 - rw
83 - sd
84 - sk
85 - sl
86 - sn
87 - so
88 - sq
89 - sr
90 - sv
91 - sw
92 - ta
93 - te
94 - tg
95 - tl
96 - tr
97 - ug
98 - uk
99 - umb
100 - ur
101 - uz
102 - vi
103 - xh
104 - zh
105 - zu
106 tags:
107 - text-to-speech
108 - speech-generation
109 - voice-cloning
110 - expressive-speech
111 - controllable-tts
112 - multilingual-tts
113 - cpp
114 - gguf
115 - windows
116 - whisper.cpp
117 - cuda
118 - higgs-audio-v3
119 pipeline_tag: text-to-speech
120 ---
121
122 # Higgs Audio v3 Studio Runtime Files
123
124 This repository hosts the downloadable runtime files for **Higgs Audio v3 Studio**, a Windows desktop app for local Higgs Audio v3 TTS, voice cloning, speech continuation, and multi-speaker generation.
125
126 GitHub app repository: https://github.com/Saganaki22/Higgs-Audio-v3-Studio
127
128 This repository is not the original upstream model release. It provides GGUF model builds, the Windows CUDA engine DLL package, checksums, and a manifest used by the desktop app downloader.
129
130 ## What This Is
131
132 Higgs Audio v3 Studio is a Rust/Tauri desktop application that runs a ported native C++/CUDA implementation of Higgs Audio v3 locally.
133
134 The app provides:
135
136 - Local TTS generation
137 - Voice clone workflow
138 - Continue speech workflow
139 - Multi-speaker workflow
140 - Speaker Gallery for reusable speaker identities
141 - WAV/MP3 export
142 - Local API server
143 - API streaming endpoint
144 - Whisper-assisted reference transcript workflow
145 - Model/engine download UI
146 - Hardware telemetry and VRAM diagnostics
147 - Engine dependency diagnostics for missing CUDA/MSVC runtime DLLs
148
149 ## App Download
150
151 Use the desktop app from GitHub releases:
152
153 https://github.com/Saganaki22/Higgs-Audio-v3-Studio/releases
154
155 Source code:
156
157 https://github.com/Saganaki22/Higgs-Audio-v3-Studio
158
159 ## Runtime Repository Layout
160
161 The app expects this Hugging Face repository layout:
162
163 ```text
164 /
165 ├─ manifest.json
166 ├─ checksums/
167 │ └─ SHA256SUMS.txt
168 ├─ engines/
169 │ ├─ audiocpp_engine.dll
170 │ ├─ cublas64_13.dll
171 │ ├─ cublasLt64_13.dll
172 │ ├─ MSVCP140.dll
173 │ ├─ VCOMP140.DLL
174 │ ├─ VCRUNTIME140.dll
175 │ └─ VCRUNTIME140_1.dll
176 └─ models/
177 ├─ higgs-q4_k_m/
178 │ └─ q4_k_m.gguf
179 ├─ higgs-q5_k/
180 │ └─ q5_k.gguf
181 ├─ higgs-q6_k/
182 │ └─ q6_k.gguf
183 ├─ higgs-q8_0/
184 │ └─ q8_0.gguf
185 └─ higgs-bf16/
186 └─ bf16.gguf
187 ```
188
189 ## Available Downloads
190
191 | File | Purpose |
192 |---|---|
193 | `manifest.json` | App downloader manifest with file names, sizes, hashes, and recommended model metadata |
194 | `checksums/SHA256SUMS.txt` | SHA256 checksums for engine package and model files |
195 | `engines/audiocpp_engine.dll` | Windows CUDA engine DLL used by the Tauri desktop app |
196 | `engines/cublas64_13.dll` | NVIDIA CUDA 13 cuBLAS runtime DLL required by the engine |
197 | `engines/cublasLt64_13.dll` | NVIDIA CUDA 13 cuBLASLt runtime DLL required by cuBLAS |
198 | `engines/MSVCP140.dll` | Microsoft C++ runtime DLL |
199 | `engines/VCOMP140.DLL` | Microsoft OpenMP runtime DLL |
200 | `engines/VCRUNTIME140.dll` | Microsoft Visual C++ runtime DLL |
201 | `engines/VCRUNTIME140_1.dll` | Microsoft Visual C++ runtime DLL |
202 | `models/higgs-q4_k_m/q4_k_m.gguf` | Smaller quantized model |
203 | `models/higgs-q5_k/q5_k.gguf` | Balanced K-quant model |
204 | `models/higgs-q6_k/q6_k.gguf` | Higher-quality K-quant model |
205 | `models/higgs-q8_0/q8_0.gguf` | Recommended default model |
206 | `models/higgs-bf16/bf16.gguf` | Highest-fidelity BF16 model |
207
208 ## Recommended VRAM
209
210 | Model | Recommended VRAM | Notes |
211 |---|---:|---|
212 | `q4_k_m` | 8 GB | Smaller model for lower VRAM systems |
213 | `q5_k` | 9 GB | Balanced K-quant option |
214 | `q6_k` | 10 GB | Higher-quality K-quant option |
215 | `q8_0` | 12 GB | Recommended default quality/speed balance |
216 | `bf16` | 16 GB | Highest-fidelity testing model |
217
218 ## Engine Requirements
219
220 The prebuilt engine package is intended for:
221
222 - Windows x64
223 - NVIDIA RTX 30xx, 40xx, or 50xx GPU
224 - CUDA 13 compatible NVIDIA driver
225 - Higgs Audio v3 Studio `0.2.31` or newer recommended
226
227 The `engines/` folder contains the app engine DLL plus the CUDA/MSVC runtime DLLs the current Windows engine build needs.
228
229 Important:
230
231 - `nvcuda.dll` is **not** included and should not be uploaded here.
232 - `nvcuda.dll` comes from the NVIDIA display driver.
233 - Users still need a working NVIDIA driver installed.
234 - Users should not need the full CUDA Toolkit installed if they use the app's `Download Engine DLLs` button.
235
236 The app can use either:
237
238 1. DLLs already installed on the user's system, such as CUDA/MSVC runtime DLLs found through system paths.
239 2. DLLs downloaded from this repository into the app's writable engine folder.
240
241 ## Engine Dependency Diagnostics
242
243 Higgs Audio v3 Studio checks the Windows loader dependencies before loading the engine.
244
245 The current validator checks for:
246
247 - `nvcuda.dll`
248 - `cublas64_13.dll`
249 - `cublasLt64_13.dll`
250 - `MSVCP140.dll`
251 - `VCOMP140.DLL`
252 - `VCRUNTIME140.dll`
253 - `VCRUNTIME140_1.dll`
254
255 If a runtime DLL is missing, users can press `Download Engine DLLs` in the app to download the files from this repository.
256
257 If `nvcuda.dll` is missing, users need to install or update their NVIDIA driver.
258
259 ## C++ Port Overview
260
261 The desktop app uses a ported native C++/CUDA inference engine instead of running the original Python pipeline directly.
262
263 At a high level:
264
265 - Higgs Audio v3 model weights are loaded from GGUF files.
266 - The native engine exposes a C ABI through `audiocpp_engine.dll`.
267 - The Rust/Tauri backend dynamically loads the DLL and calls the native API.
268 - The TypeScript frontend talks to Rust through Tauri IPC.
269 - The same engine path is used by the UI and the local API server.
270 - Whisper.cpp support is integrated into the engine path for reference transcript assistance.
271
272 Main runtime layers:
273
274 ```text
275 Tauri UI
276 ↓
277 Rust backend / local API / queue
278 ↓
279 C ABI engine wrapper
280 ↓
281 Ported C++ Higgs Audio v3 runtime
282 ↓
283 ggml / CUDA backend
284 ↓
285 GGUF Higgs model files
286 ```
287
288 ## Runtime Optimisations
289
290 The current app and engine include several production-focused improvements:
291
292 - Live streaming playback for generated audio
293 - API streaming through newline-delimited JSON events
294 - Unified UI/API generation queue
295 - Cancel checks inside the native decode loop
296 - Runtime graph cleanup after generation, cancellation, and error paths
297 - Per-stage VRAM diagnostics in the app Command Centre
298 - F16 decode KV cache enabled by default in the CUDA engine
299 - F32 decode KV fallback available for diagnostics
300 - Unsupported mixed K/V cache modes disabled to avoid CUDA flash-attention fatal paths
301 - Saved speaker reference cache support through `.hspkcache`
302 - Speaker ZIP import/export for reusable speaker identities
303 - Manifest/checksum-based model and engine downloads
304 - Engine dependency preflight for clearer Windows DLL loading errors
305
306 ## Quantization Notes
307
308 The GGUF builds in this repository are provided so users can choose a quality/VRAM tradeoff from inside the app.
309
310 - `q4_k_m`: smallest supported Higgs model option in this repo
311 - `q5_k`: middle option between Q4 and Q6
312 - `q6_k`: higher-quality K-quant option below Q8
313 - `q8_0`: recommended default for most users with enough VRAM
314 - `bf16`: highest-fidelity build, largest VRAM requirement
315
316 The app keeps the small model assets/config files bundled with the installer/portable package where possible, while the large GGUF weights are downloaded separately from this Hugging Face repository.
317
318 ## API Support
319
320 Higgs Audio v3 Studio includes a local API server.
321
322 Supported API capabilities include:
323
324 - Plain TTS
325 - Saved-speaker voice clone
326 - Continue speech
327 - WAV output
328 - MP3 output
329 - Streaming NDJSON audio/progress events
330 - Saved speaker discovery
331 - API Command Centre logs in the desktop app
332
333 For API examples and current endpoint details, see the GitHub README:
334
335 https://github.com/Saganaki22/Higgs-Audio-v3-Studio#http-api-streaming-and-command-centre
336
337 ## Installation
338
339 Recommended path:
340
341 1. Download the latest installer or portable build from GitHub releases.
342 2. Open Higgs Audio v3 Studio.
343 3. If the engine or runtime DLLs are missing, click `Download Engine DLLs`.
344 4. Download or select a Higgs GGUF model.
345 5. Load engine.
346 6. Load model.
347 7. Generate audio.
348
349 GitHub releases:
350
351 https://github.com/Saganaki22/Higgs-Audio-v3-Studio/releases
352
353 ## Manual Engine Folder
354
355 If placing files manually, keep the engine package together:
356
357 ```text
358 engines/
359 ├─ audiocpp_engine.dll
360 ├─ cublas64_13.dll
361 ├─ cublasLt64_13.dll
362 ├─ MSVCP140.dll
363 ├─ VCOMP140.DLL
364 ├─ VCRUNTIME140.dll
365 └─ VCRUNTIME140_1.dll
366 ```
367
368 Do not upload or redistribute `nvcuda.dll`. It belongs to the NVIDIA driver.
369
370 ## Checksums
371
372 Checksums are provided in:
373
374 ```text
375 checksums/SHA256SUMS.txt
376 ```
377
378 The desktop app and users can use this file to verify downloaded runtime/model files.
379
380 ## Safety And Responsible Use
381
382 Do not use Higgs Audio v3 Studio, Higgs Audio v3, or any voice cloning workflow to impersonate people without consent, create deceptive or malicious voices, defraud people, bypass identity checks, harass others, or cause harm.
383
384 Only generate speech when you have the rights and consent required for the source voice, transcript, and intended output use.
385
386 ## Credits
387
388 This project depends on the upstream Higgs Audio v3 model work by Boson AI.
389
390 Upstream model:
391
392 https://huggingface.co/bosonai/higgs-audio-v3-tts-4b
393
394 Desktop app and ported runtime repository:
395
396 https://github.com/Saganaki22/Higgs-Audio-v3-Studio
397
398 Whisper.cpp:
399
400 https://github.com/ggml-org/whisper.cpp
401
402 NVIDIA CUDA runtime components are provided under NVIDIA's CUDA Toolkit license terms.
403
404 Microsoft Visual C++ runtime components are provided under Microsoft's Visual Studio / Visual C++ Redistributable license terms.
405
406 ## Citation
407
408 ```bibtex
409 @misc{bosonai_higgs_audio_tts_v3_2026,
410 title = {Higgs TTS 3: Conversational Speech for Voice AI from Boson AI},
411 author = {Boson AI},
412 year = {2026},
413 howpublished = {https://huggingface.co/bosonai/higgs-tts-3-4b},
414 }
415 ```
416
417 ## License
418
419 The Higgs Audio v3 / Higgs TTS 3 model weights and upstream model assets are governed by the **Boson Higgs TTS 3 Research and Non-Commercial License**.
420
421 The desktop app and native port code are maintained separately on GitHub:
422
423 https://github.com/Saganaki22/Higgs-Audio-v3-Studio
424
425 Check all upstream licenses before redistributing weights, using generated audio commercially, or packaging this project into another product.
426