Text-to-Speech
GGUF
Vietnamese
realtime
tts
cpu
vietnamese
pnnbao-ump commited on
Commit
0cfcfc3
·
verified ·
1 Parent(s): 8ecc7ae

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +41 -19
README.md CHANGED
@@ -16,43 +16,62 @@ tags:
16
  - gguf
17
  ---
18
 
19
- # VieNeu-TTS-0.3B-Q8-GGUF (High Quality CPU)
20
 
21
  [![GitHub](https://img.shields.io/badge/GitHub-Repository-blue)](https://github.com/pnnbao97/VieNeu-TTS)
22
  [![Base Model](https://img.shields.io/badge/Hugging%20Face-Base%20Model-yellow)](https://huggingface.co/pnnbao-ump/VieNeu-TTS-0.3B)
 
23
 
24
- **VieNeu-TTS-0.3B-Q8-GGUF** là phiên bản nén định dạng **GGUF Q8_0** của [VieNeu-TTS-0.3B](https://huggingface.co/pnnbao-ump/VieNeu-TTS-0.3B). Mô hình này cung cấp sự cân bằng hoàn hảo giữa hiệu năng CPU và chất lượng giọng nói (giữ lại gần như trọn vẹn độ chính xác của bản gốc).
25
 
26
- ## 🚀 Hướng dẫn sử dụng
27
 
28
- Sử dụng mã nguồn tại GitHub để có trải nghiệm tốt nhất với đầy đủ các bộ tiền xử lý văn bản:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
29
 
30
  ```bash
31
  # 1. Clone repository
32
  git clone https://github.com/pnnbao97/VieNeu-TTS.git
33
  cd VieNeu-TTS
34
 
35
- # 2. Cài đặt môi trường & llama-cpp-python (Yêu cầu bản 0.3.16)
36
  uv sync
37
- uv add llama-cpp-python==0.3.16
38
 
39
- # 3. Chạy giao diện web
40
  uv run gradio_app.py
41
  ```
42
- Trong giao diện, chọn **Backbone**: `VieNeu-TTS-0.3B-q8-gguf` và **Device**: `CPU`.
43
 
44
- ## 📊 Thông số kỹ thuật
45
- - **Định dạng**: GGUF (Q8_0)
46
- - **Kích thước**: ~500 MB
47
- - **Chất lượng**: ⭐⭐⭐⭐ (Gần tương đương bản PyTorch gốc)
48
- - **Hiệu năng**: Chạy tốt trên các dòng CPU hiện đại, tốc độ cực nhanh.
49
 
50
- ## ⚠️ Lưu ý về bản quyền
51
- Mô hình này được phát hành dưới giấy phép **CC BY-NC 4.0**.
52
- - **KHÔNG** được sử dụng cho mục đích thương mại nếu không được sự đồng ý của tác giả.
53
- - Mọi thắc mắc về bản quyền hoặc cấp phép thương mại, vui lòng liên hệ: **Phạm Nguyễn Ngọc Bảo**.
 
54
 
55
- ## Citation
56
  ```bibtex
57
  @misc{vieneutts03bggufq82026,
58
  title = {VieNeu-TTS-0.3B-Q8-GGUF: High-Quality CPU-Optimized Vietnamese Text-to-Speech},
@@ -61,4 +80,7 @@ Mô hình này được phát hành dưới giấy phép **CC BY-NC 4.0**.
61
  publisher = {Hugging Face},
62
  howpublished = {\url{https://huggingface.co/pnnbao-ump/VieNeu-TTS-0.3B-q8-gguf}}
63
  }
64
- ```
 
 
 
 
16
  - gguf
17
  ---
18
 
19
+ # 🦜 VieNeu-TTS-0.3B-Q8-GGUF (High-Quality CPU)
20
 
21
  [![GitHub](https://img.shields.io/badge/GitHub-Repository-blue)](https://github.com/pnnbao97/VieNeu-TTS)
22
  [![Base Model](https://img.shields.io/badge/Hugging%20Face-Base%20Model-yellow)](https://huggingface.co/pnnbao-ump/VieNeu-TTS-0.3B)
23
+ [![Discord](https://img.shields.io/badge/Discord-Join%20Us-5865F2?logo=discord&logoColor=white)](https://discord.gg/yJt8kzjzWZ)
24
 
25
+ **VieNeu-TTS-0.3B-Q8-GGUF** is a **Q8_0** quantized version of [VieNeu-TTS-0.3B](https://huggingface.co/pnnbao-ump/VieNeu-TTS-0.3B). This model provides a perfect balance between CPU performance and voice quality, retaining almost all the precision of the original PyTorch model.
26
 
27
+ Author: **Phạm Nguyễn Ngọc Bảo**
28
 
29
+ ## ☕ Support This Project
30
+
31
+ Training high-quality TTS models requires significant GPU resources. If you find this model useful, please consider supporting the development:
32
+
33
+ [![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-Support-orange?logo=buy-me-a-coffee)](https://buymeacoffee.com/pnnbao)
34
+
35
+ ---
36
+
37
+ ## �️ Requirements (eSpeak NG)
38
+ eSpeak NG is **mandatory** for phonemization.
39
+ - **Windows:** Download `.msi` from [eSpeak NG Releases](https://github.com/espeak-ng/espeak-ng/releases).
40
+ - **macOS:** `brew install espeak`
41
+ - **Linux:** `sudo apt install espeak-ng`
42
+
43
+ ---
44
+
45
+ ## 🚀 How to Use
46
+
47
+ Use the source code from GitHub for the best experience with full text preprocessing support:
48
 
49
  ```bash
50
  # 1. Clone repository
51
  git clone https://github.com/pnnbao97/VieNeu-TTS.git
52
  cd VieNeu-TTS
53
 
54
+ # 2. Sync environment (requires uv)
55
  uv sync
 
56
 
57
+ # 3. Launch Web UI
58
  uv run gradio_app.py
59
  ```
60
+ In the UI, select **Backbone**: `VieNeu-TTS-0.3B-q8-gguf` and **Device**: `CPU`.
61
 
62
+ ## 📊 Technical Specifications
63
+ - **Format**: GGUF (Q8_0)
64
+ - **Size**: ~300 MB
65
+ - **Quality**: ⭐⭐⭐⭐ (Near original PyTorch quality)
66
+ - **Performance**: Runs smoothly on modern CPUs with high efficiency.
67
 
68
+ ## ⚠️ Licensing & Copyright
69
+ This model is released under the **CC BY-NC 4.0** license.
70
+ - ✅ **Free:** For students, researchers, and non-profit purposes.
71
+ - ⚠️ **Commercial/Enterprise:** Use for businesses or commercial products is strictly prohibited without prior authorization.
72
+ - **Commercial Licensing:** Please contact the author (**Phạm Nguyễn Ngọc Bảo**) for licensing terms (Estimated: **5,000 USD/year** - negotiable).
73
 
74
+ ## 📑 Citation
75
  ```bibtex
76
  @misc{vieneutts03bggufq82026,
77
  title = {VieNeu-TTS-0.3B-Q8-GGUF: High-Quality CPU-Optimized Vietnamese Text-to-Speech},
 
80
  publisher = {Hugging Face},
81
  howpublished = {\url{https://huggingface.co/pnnbao-ump/VieNeu-TTS-0.3B-q8-gguf}}
82
  }
83
+ ```
84
+
85
+ ---
86
+ **Made with ❤️ for the Vietnamese TTS community**