Duplicate from HoppouAI/Breeze-TTS-2.cpp
Browse filesCo-authored-by: Hoppou AI <HoppouAI@users.noreply.huggingface.co>
- .gitattributes +43 -0
- README.md +128 -0
- breeze-tts-2-f16.gguf +3 -0
- breeze-tts-2-q4_k-dd2.gguf +3 -0
- breeze-tts-2-q4_k.gguf +3 -0
- breeze-tts-2-q6_k.gguf +3 -0
- breeze-tts-2-q8_0-dd2.gguf +3 -0
- breeze-tts-2-q8_0-dd4.gguf +3 -0
- breeze-tts-2-q8_0.gguf +3 -0
- ref_voice.wav +3 -0
.gitattributes
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
*.7z filter=lfs diff=lfs merge=lfs -text
|
| 2 |
+
*.arrow filter=lfs diff=lfs merge=lfs -text
|
| 3 |
+
*.bin filter=lfs diff=lfs merge=lfs -text
|
| 4 |
+
*.bz2 filter=lfs diff=lfs merge=lfs -text
|
| 5 |
+
*.ckpt filter=lfs diff=lfs merge=lfs -text
|
| 6 |
+
*.ftz filter=lfs diff=lfs merge=lfs -text
|
| 7 |
+
*.gz filter=lfs diff=lfs merge=lfs -text
|
| 8 |
+
*.h5 filter=lfs diff=lfs merge=lfs -text
|
| 9 |
+
*.joblib filter=lfs diff=lfs merge=lfs -text
|
| 10 |
+
*.lfs.* filter=lfs diff=lfs merge=lfs -text
|
| 11 |
+
*.mlmodel filter=lfs diff=lfs merge=lfs -text
|
| 12 |
+
*.model filter=lfs diff=lfs merge=lfs -text
|
| 13 |
+
*.msgpack filter=lfs diff=lfs merge=lfs -text
|
| 14 |
+
*.npy filter=lfs diff=lfs merge=lfs -text
|
| 15 |
+
*.npz filter=lfs diff=lfs merge=lfs -text
|
| 16 |
+
*.onnx filter=lfs diff=lfs merge=lfs -text
|
| 17 |
+
*.ot filter=lfs diff=lfs merge=lfs -text
|
| 18 |
+
*.parquet filter=lfs diff=lfs merge=lfs -text
|
| 19 |
+
*.pb filter=lfs diff=lfs merge=lfs -text
|
| 20 |
+
*.pickle filter=lfs diff=lfs merge=lfs -text
|
| 21 |
+
*.pkl filter=lfs diff=lfs merge=lfs -text
|
| 22 |
+
*.pt filter=lfs diff=lfs merge=lfs -text
|
| 23 |
+
*.pth filter=lfs diff=lfs merge=lfs -text
|
| 24 |
+
*.rar filter=lfs diff=lfs merge=lfs -text
|
| 25 |
+
*.safetensors filter=lfs diff=lfs merge=lfs -text
|
| 26 |
+
saved_model/**/* filter=lfs diff=lfs merge=lfs -text
|
| 27 |
+
*.tar.* filter=lfs diff=lfs merge=lfs -text
|
| 28 |
+
*.tar filter=lfs diff=lfs merge=lfs -text
|
| 29 |
+
*.tflite filter=lfs diff=lfs merge=lfs -text
|
| 30 |
+
*.tgz filter=lfs diff=lfs merge=lfs -text
|
| 31 |
+
*.wasm filter=lfs diff=lfs merge=lfs -text
|
| 32 |
+
*.xz filter=lfs diff=lfs merge=lfs -text
|
| 33 |
+
*.zip filter=lfs diff=lfs merge=lfs -text
|
| 34 |
+
*.zst filter=lfs diff=lfs merge=lfs -text
|
| 35 |
+
*tfevents* filter=lfs diff=lfs merge=lfs -text
|
| 36 |
+
ref_voice.wav filter=lfs diff=lfs merge=lfs -text
|
| 37 |
+
breeze-tts-2-f16.gguf filter=lfs diff=lfs merge=lfs -text
|
| 38 |
+
breeze-tts-2-q4_k-dd2.gguf filter=lfs diff=lfs merge=lfs -text
|
| 39 |
+
breeze-tts-2-q4_k.gguf filter=lfs diff=lfs merge=lfs -text
|
| 40 |
+
breeze-tts-2-q6_k.gguf filter=lfs diff=lfs merge=lfs -text
|
| 41 |
+
breeze-tts-2-q8_0-dd2.gguf filter=lfs diff=lfs merge=lfs -text
|
| 42 |
+
breeze-tts-2-q8_0-dd4.gguf filter=lfs diff=lfs merge=lfs -text
|
| 43 |
+
breeze-tts-2-q8_0.gguf filter=lfs diff=lfs merge=lfs -text
|
README.md
ADDED
|
@@ -0,0 +1,128 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
base_model: BreezeBlue/Breeze-TTS-2
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
- zh
|
| 6 |
+
library_name: gguf
|
| 7 |
+
license: other
|
| 8 |
+
license_name: breezeblue-research-and-non-commercial
|
| 9 |
+
license_link: https://huggingface.co/BreezeBlue/Breeze-TTS-2
|
| 10 |
+
pipeline_tag: text-to-speech
|
| 11 |
+
tags:
|
| 12 |
+
- text-to-speech
|
| 13 |
+
- tts
|
| 14 |
+
- gguf
|
| 15 |
+
- ggml
|
| 16 |
+
- vulkan
|
| 17 |
+
- voice-cloning
|
| 18 |
+
- voice-conversion
|
| 19 |
+
---
|
| 20 |
+
|
| 21 |
+
# Breeze-TTS-2 GGUF
|
| 22 |
+
|
| 23 |
+
GGUF conversions of [BreezeBlue/Breeze-TTS-2](https://huggingface.co/BreezeBlue/Breeze-TTS-2) for
|
| 24 |
+
[**Breeze-TTS-2.cpp**](https://github.com/HoppouAI/Breeze-TTS-2.cpp), a C++ reimplementation running on
|
| 25 |
+
ggml with a Vulkan backend, so it works on NVIDIA, AMD and Intel GPUs and falls back to CPU.
|
| 26 |
+
|
| 27 |
+
Bilingual English and Mandarin, 24 kHz, around 1.2x realtime at Q8_0 on an RTX 3060.
|
| 28 |
+
|
| 29 |
+
These files will not load in llama.cpp. They need the Breeze-TTS-2.cpp runtime, which implements all
|
| 30 |
+
four stages of the model: the T5Gemma2 text encoder, the Qwen3 backbone, the 15 step depth decoder and
|
| 31 |
+
the vocoder.
|
| 32 |
+
|
| 33 |
+
## Files
|
| 34 |
+
|
| 35 |
+
| File | Size | Notes |
|
| 36 |
+
| --- | --- | --- |
|
| 37 |
+
| `breeze-tts-2-f16.gguf` | 5.9 GB | Reference quality, unquantized |
|
| 38 |
+
| `breeze-tts-2-q8_0.gguf` | 3.3 GB | **Recommended.** No audible loss against F16 |
|
| 39 |
+
| `breeze-tts-2-q6_k.gguf` | 2.9 GB | |
|
| 40 |
+
| `breeze-tts-2-q4_k.gguf` | 2.4 GB | Smallest safe choice, holds up well |
|
| 41 |
+
| `breeze-tts-2-q8_0-dd4.gguf` | 3.2 GB | Experimental, Q8_0 base with a Q4_K depth decoder |
|
| 42 |
+
| `breeze-tts-2-q8_0-dd2.gguf` | 3.1 GB | Experimental, Q8_0 base with a Q2_K depth decoder |
|
| 43 |
+
| `breeze-tts-2-q4_k-dd2.gguf` | 2.3 GB | Experimental, Q4_K base with a Q2_K depth decoder |
|
| 44 |
+
|
| 45 |
+
Approximate VRAM is about 1 GB above the file size.
|
| 46 |
+
|
| 47 |
+
### About the `-dd` variants
|
| 48 |
+
|
| 49 |
+
Everything except the `-dd` files keeps the depth decoder at higher precision than the rest of the
|
| 50 |
+
model. The `-dd` variants quantize it too, which is why they are smaller.
|
| 51 |
+
|
| 52 |
+
The depth decoder runs **15 sequential steps for every single frame of audio**, so on hardware where
|
| 53 |
+
that is the bottleneck rather than memory bandwidth, shrinking it can speed generation up noticeably.
|
| 54 |
+
That is the reason these exist and it is worth benchmarking on your own card.
|
| 55 |
+
|
| 56 |
+
The tradeoff is that depth codes feed back into the backbone every frame, so quantization error
|
| 57 |
+
compounds as generation continues. Output holds up early and then drifts progressively muffled and
|
| 58 |
+
thin past **roughly 45 seconds of continuous generation**. Short lines and dialogue are fine. Long
|
| 59 |
+
narration is not, and the failure is gradual rather than obvious, so it is easy to miss on quick tests.
|
| 60 |
+
|
| 61 |
+
Treat them as experimental. If in doubt, use `q8_0` or `q4_k`.
|
| 62 |
+
|
| 63 |
+
## Usage
|
| 64 |
+
|
| 65 |
+
```bash
|
| 66 |
+
git clone --recursive https://github.com/HoppouAI/Breeze-TTS-2.cpp
|
| 67 |
+
cd Breeze-TTS-2.cpp
|
| 68 |
+
cmake -B build -DCMAKE_BUILD_TYPE=Release
|
| 69 |
+
cmake --build build -j
|
| 70 |
+
```
|
| 71 |
+
|
| 72 |
+
```bash
|
| 73 |
+
# invent a voice from a description
|
| 74 |
+
build/breeze-cli breeze-tts-2-q8_0.gguf \
|
| 75 |
+
--text "Welcome aboard. Your journey begins now." \
|
| 76 |
+
--instruction "A warm, thoughtful young woman with a clear, calm delivery." \
|
| 77 |
+
--output design.wav
|
| 78 |
+
|
| 79 |
+
# clone a voice from a clip
|
| 80 |
+
build/breeze-cli breeze-tts-2-q8_0.gguf \
|
| 81 |
+
--text "It is good to hear your voice again." \
|
| 82 |
+
--ref-audio ref_voice.wav --ref-text "The harbour lights came on one by one as the evening tide began to turn." \
|
| 83 |
+
--output clone.wav
|
| 84 |
+
```
|
| 85 |
+
|
| 86 |
+
Or run the server, which has a web UI built in plus HTTP and WebSocket streaming:
|
| 87 |
+
|
| 88 |
+
```bash
|
| 89 |
+
build/breeze-server breeze-tts-2-q8_0.gguf --host 127.0.0.1 --port 8080 --webui
|
| 90 |
+
```
|
| 91 |
+
|
| 92 |
+
`ref_voice.wav` in this repo is a sample reference clip. Its transcript is
|
| 93 |
+
"The harbour lights came on one by one as the evening tide began to turn."
|
| 94 |
+
|
| 95 |
+
## Vocal events
|
| 96 |
+
|
| 97 |
+
Inline tags in round brackets produce non speech sounds: `(laugh)`, `(sigh)`, `(cough)`,
|
| 98 |
+
`(clears throat)`, and `[笑]` or `[叹气]` in Chinese. The vocabulary is free form rather than a fixed
|
| 99 |
+
token list, so descriptive tags like `(nervous chuckle)` often work.
|
| 100 |
+
|
| 101 |
+
They usually need `--cfg-scale 2` to `3` to actually fire. At the default of 1.0 the model treats a tag
|
| 102 |
+
as a suggestion and tends to read straight past anything outside the common set.
|
| 103 |
+
|
| 104 |
+
## Voice conversion
|
| 105 |
+
|
| 106 |
+
The runtime can also respeak an existing recording in a different voice, keeping the original timing,
|
| 107 |
+
phrasing and emphasis while changing only the speaker. This is not part of the upstream model, it falls
|
| 108 |
+
out of how the codec separates semantic content from acoustic detail.
|
| 109 |
+
|
| 110 |
+
It is experimental. Pitch is regenerated rather than copied, so a converted vocal is re-sung in the
|
| 111 |
+
target voice's own register instead of at the source's. Whether a tune survives varies clip to clip,
|
| 112 |
+
and `keep_acoustic 1` or `2` copies the lowest acoustic codebooks from the source to pull more of the
|
| 113 |
+
original contour through. Judge it by ear, and leave `keep_acoustic` at 0 for ordinary speech.
|
| 114 |
+
|
| 115 |
+
## Conversion
|
| 116 |
+
|
| 117 |
+
Produced with `scripts/convert_hf_to_gguf.py` and `breeze-quantize` from the repo. The source download
|
| 118 |
+
must include the `audio_tokenizer/` directory, which holds the vocoder that the model actually uses at
|
| 119 |
+
inference time.
|
| 120 |
+
|
| 121 |
+
## License
|
| 122 |
+
|
| 123 |
+
Weights are governed by the **BreezeBlue Research and Non-Commercial License** from the
|
| 124 |
+
[original model](https://huggingface.co/BreezeBlue/Breeze-TTS-2). Converting to GGUF does not change
|
| 125 |
+
that. The Breeze-TTS-2.cpp source code is Apache 2.0.
|
| 126 |
+
|
| 127 |
+
You are responsible for complying with the weight license and for obtaining consent for any reference
|
| 128 |
+
audio or voices you use.
|
breeze-tts-2-f16.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:db740cd464d75f2635a891586f083c5b466fd63542bebd957fe7890324b04c35
|
| 3 |
+
size 6279630784
|
breeze-tts-2-q4_k-dd2.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:6d675f8c1ce43bdd368489e9c9f52a725e9ede23e3bbf338ec5c9c31d8169cf0
|
| 3 |
+
size 2460266176
|
breeze-tts-2-q4_k.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:483418fbbb438f5f1c08dbe2b017e42db0f1d126765cd3f772d8622a30a4915c
|
| 3 |
+
size 2538909376
|
breeze-tts-2-q6_k.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:0eb51de6cbccd54b1c408198797254ac46b3cbd55ca1174c630eaac6d01064d3
|
| 3 |
+
size 3069969664
|
breeze-tts-2-q8_0-dd2.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:c43155fdd783e459f84c78b88f6cd91e833cf8b54649f289de7825139ee2d1c9
|
| 3 |
+
size 3322429120
|
breeze-tts-2-q8_0-dd4.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:5248f348388cb7fd904a8bde3e65383a0fbc562d2fe48d7c375cf17372d3751b
|
| 3 |
+
size 3401072320
|
breeze-tts-2-q8_0.gguf
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:a02bcc4b69b0601032727f8040c4942149b1b73aa0f69022fe5aaa6a8f0ef879
|
| 3 |
+
size 3568844480
|
ref_voice.wav
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version https://git-lfs.github.com/spec/v1
|
| 2 |
+
oid sha256:1c4a899338a9f737e73799fe29fa81e8591c48a475881aed710af2c721b9e697
|
| 3 |
+
size 257324
|