drbaph commited on
Commit
f404d20
·
verified ·
1 Parent(s): b2fb59c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +86 -11
README.md CHANGED
@@ -121,12 +121,11 @@ pipeline_tag: text-to-speech
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, 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, a Windows CUDA engine DLL, checksums, and a manifest used by the desktop app downloader.
129
-
130
 
131
  ## What This Is
132
 
@@ -145,6 +144,7 @@ The app provides:
145
  - Whisper-assisted reference transcript workflow
146
  - Model/engine download UI
147
  - Hardware telemetry and VRAM diagnostics
 
148
 
149
  ## App Download
150
 
@@ -166,7 +166,13 @@ The app expects this Hugging Face repository layout:
166
  ├─ checksums/
167
  │ └─ SHA256SUMS.txt
168
  ├─ engines/
169
- ─ audiocpp_engine.dll
 
 
 
 
 
 
170
  └─ models/
171
  ├─ higgs-q4_k_m/
172
  │ └─ q4_k_m.gguf
@@ -185,8 +191,14 @@ The app expects this Hugging Face repository layout:
185
  | File | Purpose |
186
  |---|---|
187
  | `manifest.json` | App downloader manifest with file names, sizes, hashes, and recommended model metadata |
188
- | `checksums/SHA256SUMS.txt` | SHA256 checksums for engine and model files |
189
  | `engines/audiocpp_engine.dll` | Windows CUDA engine DLL used by the Tauri desktop app |
 
 
 
 
 
 
190
  | `models/higgs-q4_k_m/q4_k_m.gguf` | Smaller quantized model |
191
  | `models/higgs-q5_k/q5_k.gguf` | Balanced K-quant model |
192
  | `models/higgs-q6_k/q6_k.gguf` | Higher-quality K-quant model |
@@ -205,13 +217,44 @@ The app expects this Hugging Face repository layout:
205
 
206
  ## Engine Requirements
207
 
208
- The prebuilt engine DLL is intended for:
209
 
210
  - Windows x64
211
  - NVIDIA RTX 30xx, 40xx, or 50xx GPU
212
- - CUDA 13 compatible NVIDIA driver/runtime support
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
213
 
214
- The engine DLL is bundled with the GitHub installer/portable builds, but the app can also download it from this repository if missing.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
215
 
216
  ## C++ Port Overview
217
 
@@ -258,6 +301,7 @@ The current app and engine include several production-focused improvements:
258
  - Saved speaker reference cache support through `.hspkcache`
259
  - Speaker ZIP import/export for reusable speaker identities
260
  - Manifest/checksum-based model and engine downloads
 
261
 
262
  ## Quantization Notes
263
 
@@ -269,7 +313,7 @@ The GGUF builds in this repository are provided so users can choose a quality/VR
269
  - `q8_0`: recommended default for most users with enough VRAM
270
  - `bf16`: highest-fidelity build, largest VRAM requirement
271
 
272
- The app keeps the 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.
273
 
274
  ## API Support
275
 
@@ -296,7 +340,7 @@ Recommended path:
296
 
297
  1. Download the latest installer or portable build from GitHub releases.
298
  2. Open Higgs Audio v3 Studio.
299
- 3. Download or select an engine DLL if needed.
300
  4. Download or select a Higgs GGUF model.
301
  5. Load engine.
302
  6. Load model.
@@ -306,6 +350,33 @@ GitHub releases:
306
 
307
  https://github.com/Saganaki22/Higgs-Audio-v3-Studio/releases
308
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
309
  ## Safety And Responsible Use
310
 
311
  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.
@@ -324,10 +395,14 @@ Desktop app and ported runtime repository:
324
 
325
  https://github.com/Saganaki22/Higgs-Audio-v3-Studio
326
 
327
- Whisper.cpp
328
 
329
  https://github.com/ggml-org/whisper.cpp
330
 
 
 
 
 
331
  ## Citation
332
 
333
  ```bibtex
 
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
 
 
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
 
 
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
 
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 |
 
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
 
 
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
 
 
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
 
 
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.
 
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.
 
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