miotts-cpp-gguf / README.md
mmnga's picture
Update README.md
6ffcbb6 verified
---
license: unknown
---
# miotts-cpp-gguf (for mio-tts-cpp)
`mio-tts-cpp`(C++/llama.cpp ベース)で **MioTTS 推論**を行うための GGUF/補助ファイル一式です。
収録物は **上流(Aratako さん)モデル**を元に、`mmnga-o`**配布・変換・同梱**しています。
## 対応アプリ / リポジトリ
- 推論アプリ(C++): https://github.com/mmnga/mio-tts-cpp (MIT License)
- 参考(上流の推論/付帯物): https://github.com/Aratako/MioTTS-Inference (MIT License)
## 含まれるファイル(作者・出典・ライセンス)
> 注意: この Hugging Face リポジトリ自体の License 表示が `unknown` のため、**各ファイルは上流のライセンスに従います**
> https://huggingface.co/mmnga-o/miotts-cpp-gguf
| ファイル | 役割 | 作者/出典 | ライセンス/注意 |
|---|---|---|---|
| `MioTTS-0.1B-Q8_0.gguf` | TTS LLM 本体(0.1B / GGUF) | https://huggingface.co/Aratako/MioTTS-0.1B | **Falcon-LLM License**(上流に従う) |
| `miocodec.gguf` | ボコーダ/音声コーデック(24kHz 系) | https://huggingface.co/Aratako/MioCodec-25Hz-24kHz | **MIT License**(上流に従う) |
| `miocodec-24khz.gguf` | 24kHz 系ボコーダ別ビルド | 本リポジトリ同梱 | **要確認**(上流ライセンス継承の想定。配布側で明記推奨) |
| `miocodec-25hz-44k-v2.gguf` | 44.1kHz 系ボコーダ別ビルド | 本リポジトリ同梱 | **要確認**(上流ライセンス継承の想定。配布側で明記推奨) |
| `en_female.emb.gguf` / `en_male.emb.gguf` / `jp_female.emb.gguf` / `jp_male.emb.gguf` | プリセット話者埋め込み | 本リポジトリ同梱 | **要確認**:生成元(参照音声/モデル)により利用条件が変わり得ます。上流 `MioTTS-Inference` にはプリセット音声に関する注意が記載されています。 |
## 使い方(例)
```bash
./build/llama-tts-mio \
-m models/MioTTS-0.1B-Q8_0.gguf \
-mv models/miocodec.gguf \
-emb models/jp_female.emb.gguf \
-p "こんにちは、今日はいい天気ですね。" \
-o out.wav
```
## クレジット
- MioTTS-0.1B: Aratako(Falcon-LLM License)
https://huggingface.co/Aratako/MioTTS-0.1B
- MioCodec-25Hz-24kHz: Aratako(MIT)
https://huggingface.co/Aratako/MioCodec-25Hz-24kHz
- mio-tts-cpp(推論アプリ): mmnga(MIT)
https://github.com/mmnga/mio-tts-cpp
## 免責
本リポジトリは変換/同梱物を含みます。**利用時は各上流モデル/付帯物のライセンス・利用条件に従ってください**
特に埋め込み(`.emb.gguf`)などのプリセット類は、生成元次第で制限が変わる可能性があります。
---
# miotts-cpp-gguf (for mio-tts-cpp) — English
A bundle of GGUF + auxiliary files for running **MioTTS inference** with `mio-tts-cpp` (C++/llama.cpp-based).
Contents are based on upstream work by **Aratako**, packaged/converted and redistributed by `mmnga-o`.
## Related repositories
- Inference app (C++): https://github.com/mmnga/mio-tts-cpp (MIT License)
- Upstream inference utilities / assets reference: https://github.com/Aratako/MioTTS-Inference (MIT License)
## Included files (author, source, license)
> Note: This Hugging Face repo shows License = `unknown`, so **each file follows its upstream license/terms**.
> https://huggingface.co/mmnga-o/miotts-cpp-gguf
| File | Purpose | Author / Source | License / Notes |
|---|---|---|---|
| `MioTTS-0.1B-Q8_0.gguf` | Main TTS model (0.1B / GGUF) | https://huggingface.co/Aratako/MioTTS-0.1B | **Falcon-LLM License** (follow upstream) |
| `miocodec.gguf` | Vocoder / audio codec (24kHz) | https://huggingface.co/Aratako/MioCodec-25Hz-24kHz | **MIT License** (follow upstream) |
| `miocodec-24khz.gguf` | 24kHz codec build variant | bundled in this repo | **TBD** (expected to inherit upstream; explicitly document when distributing) |
| `miocodec-25hz-44k-v2.gguf` | 44.1kHz codec build variant | bundled in this repo | **TBD** (expected to inherit upstream; explicitly document when distributing) |
| `en_female.emb.gguf` / `en_male.emb.gguf` / `jp_female.emb.gguf` / `jp_male.emb.gguf` | Preset speaker embeddings | bundled in this repo | **TBD**: terms may depend on how embeddings were produced. Upstream `MioTTS-Inference` includes caveats around preset audio/assets. |
## Usage (example)
```bash
./build/llama-tts-mio \
-m models/MioTTS-0.1B-Q8_0.gguf \
-mv models/miocodec.gguf \
-emb models/jp_female.emb.gguf \
-p "Hello! This is a test." \
-o out.wav
```
## Credits
- MioTTS-0.1B: Aratako (Falcon-LLM License)
https://huggingface.co/Aratako/MioTTS-0.1B
- MioCodec-25Hz-24kHz: Aratako (MIT)
https://huggingface.co/Aratako/MioCodec-25Hz-24kHz
- mio-tts-cpp (inference app): mmnga (MIT)
https://github.com/mmnga/mio-tts-cpp
## Disclaimer
This repo contains converted/bundled artifacts. **Please comply with upstream licenses and usage terms** for each file.
Preset embeddings (`.emb.gguf`) and other assets may have additional constraints depending on how they were created.