hans00 commited on
Commit
0b704d8
·
verified ·
1 Parent(s): 0ff9d37

README: user-facing model card (files, run with codec.cpp tts-cli, license as upstream)

Browse files
Files changed (1) hide show
  1. README.md +33 -15
README.md CHANGED
@@ -1,23 +1,41 @@
1
  ---
2
- license: mit
 
 
 
 
 
 
 
3
  ---
4
 
5
  # codec.cpp GGUFs
6
 
7
- Audio codec GGUFs for [codec.cpp](https://github.com/mybigday/codec.cpp): IBM `DAC.speech.v1.0`
8
- (24 kHz), NVIDIA NeMo Nano Codec (22.05 kHz, 0.6 kbps, 12.5 fps) and WavTokenizer-large-speech
9
- (75 tokens/s). Each comes as F32, F16 (no suffix) and Q8_0 / Q5_K_M / Q4_K_M.
10
 
11
- codec.cpp computes every weight at the precision stored in the GGUF: F16 files run F16 kernels,
12
- Q8_0 files run Q8_0 kernels. F16 is the default; the quantized files trade quality for size and
13
- speed (for DAC.speech, decode-only SNR vs F32 is ~37 dB at Q8_0, ~27 dB at Q5_K_M, ~23 dB at
14
- Q4_K_M on a speech clip; end-to-end encode+decode is lower because quantized encoders flip codes).
 
15
 
16
- ## Changelog
 
 
17
 
18
- - 2026-10-18: `ibm-research--DAC.speech-{Q8_0,Q5_K_M,Q4_K_M}.gguf` regenerated. Their quantized
19
- conv kernels now use the layouts codec.cpp can run quantized: conv1d kernels flattened to
20
- `(K*C_in, 1, C_out)`, ConvTranspose kernels `(C_in, C_out, K)`. The previous files used the
21
- `(C_out, C_in, K)` layout, which only ran because older runtimes dequantized every weight to F32.
22
- **These files need codec.cpp 961162a or newer.** F32/F16 files and the NeMo / WavTokenizer files
23
- are unchanged.
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ license: other
3
+ license_name: per-codec
4
+ license_link: https://huggingface.co/BricksDisplay/codec.cpp-gguf#license
5
+ tags:
6
+ - codec.cpp
7
+ - gguf
8
+ - audio
9
+ - neural-audio-codec
10
  ---
11
 
12
  # codec.cpp GGUFs
13
 
14
+ Neural audio codecs for [codec.cpp](https://github.com/mybigday/codec.cpp): turn
15
+ speech into discrete tokens and back, offline on CPU or GPU.
 
16
 
17
+ | Codec | Sample rate | Token rate | Files |
18
+ |---|---|---|---|
19
+ | [IBM DAC.speech v1.0](https://huggingface.co/ibm-research/DAC.speech.v1.0) | 24 kHz | 75 frames/s | `ibm-research--DAC.speech*.gguf` |
20
+ | [NVIDIA NeMo Nano Codec](https://huggingface.co/nvidia/nemo-nano-codec-22khz-0.6kbps-12.5fps) | 22.05 kHz | 12.5 frames/s (0.6 kbps) | `nemo-nano-codec-22khz-0.6kbps-12.5fps*.gguf` |
21
+ | [WavTokenizer large (speech)](https://huggingface.co/novateur/WavTokenizer-large-speech-75token) | 24 kHz | 75 tokens/s | `wavtokenizer-large-speech-75tokens*.gguf` |
22
 
23
+ Each codec comes in several precisions: the file without a suffix is F16
24
+ (recommended), `-F32` is full precision, `-Q8_0` / `-Q5_K_M` / `-Q4_K_M` are
25
+ smaller and faster at some quality cost.
26
 
27
+ ## Run
28
+
29
+ ```bash
30
+ hf download BricksDisplay/codec.cpp-gguf ibm-research--DAC.speech.gguf --local-dir codecs
31
+
32
+ ./build/codec-cli encode --model codecs/ibm-research--DAC.speech.gguf --in speech.wav --out codes.npy
33
+ ./build/codec-cli decode --model codecs/ibm-research--DAC.speech.gguf --codes codes.npy --out decoded.wav
34
+ ```
35
+
36
+ Build instructions, GPU flags and the Python API are in the
37
+ [codec.cpp README](https://github.com/mybigday/codec.cpp).
38
+
39
+ ## License
40
+
41
+ Each codec keeps its original license: DAC.speech CDLA-Permissive-2.0, NeMo Nano Codec the NVIDIA Open Model License, WavTokenizer MIT.