| --- |
| license: other |
| license_link: https://amitaro.net/voice/voice_rule/ |
| language: |
| - ja |
| pipeline_tag: text-to-speech |
| library_name: melotts |
| tags: |
| - text-to-speech |
| - japanese |
| - melotts |
| - m5stack |
| - module-llm |
| - debian-package |
| - deb |
| - apt |
| - stackflow |
| - pulsar2 |
| - ax620e |
| - amitaro |
| - amitaro-terms-compliant |
| base_model: |
| - M5Stack/MeloTTS-Japanese-ax630c |
| --- |
| |
| # M5Stack Module LLM Amitaro MeloTTS Packages |
|
|
| <p align="right"><a href="#english">English</a> | <a href="#日本語">日本語</a></p> |
|
|
| <details open> |
| <summary id="english"><strong>English</strong></summary> |
|
|
| ## Overview |
|
|
| This repository provides unofficial Debian packages for Amitaro-style Japanese MeloTTS voice models for M5Stack Module LLM. |
|
|
| Unlike a raw AXModel folder distribution, these models are packaged as installable `.deb` packages. After installation, the model files are placed under `/opt/m5stack/data/` and can be used from the StackFlow MeloTTS runtime. |
|
|
| - Target device: M5Stack Module LLM |
| - Runtime: StackFlow MeloTTS |
| - Package format: Debian package (`.deb`) |
| - Architecture: `arm64` |
| - Dependency: `lib-llm (>= 1.6)` |
| - Source checkpoint: `G_6000.pth` |
| - Decoder conversion: Pulsar2 4.2, `dec_len=128` |
| - Test phrase: `これは推論テストです` |
|
|
| This repository does not include the raw Amitaro corpus WAV files. |
|
|
| ## Packages |
|
|
| The following model packages are provided: |
|
|
| ```text |
| llm-model-amitaro-ja-jp-normal_0.1_arm64.deb |
| llm-model-amitaro-ja-jp-runrun_0.1_arm64.deb |
| llm-model-amitaro-ja-jp-yofukashi_0.1_arm64.deb |
| llm-model-amitaro-ja-jp-punsuka_0.1_arm64.deb |
| llm-model-amitaro-ja-jp-sasayaki-a_0.1_arm64.deb |
| llm-model-amitaro-ja-jp-sasayaki-b_0.1_arm64.deb |
| ``` |
|
|
| ## Model names |
|
|
| Use the following model names when calling `tts.setup`: |
|
|
| ```text |
| amitaro-ja-jp-normal |
| amitaro-ja-jp-runrun |
| amitaro-ja-jp-yofukashi |
| amitaro-ja-jp-punsuka |
| amitaro-ja-jp-sasayaki-a |
| amitaro-ja-jp-sasayaki-b |
| ``` |
|
|
| When using the StackFlow socket API, the setup request should be sent to the MeloTTS worker: |
|
|
| ```json |
| { |
| "work_id": "melotts", |
| "action": "setup", |
| "object": "tts.setup", |
| "data": { |
| "model": "amitaro-ja-jp-punsuka", |
| "response_format": "sys.play.0_1", |
| "input": "tts.utf-8", |
| "enoutput": true |
| } |
| } |
| ``` |
|
|
| Note: Some custom model names may not appear in `sys.lsmode`, but they can still work when specified directly in `tts.setup`. |
|
|
| ## Direct download install |
|
|
| If the `.deb` package is hosted on Hugging Face, you can install it directly on the Module LLM with `wget` and `dpkg`. |
|
|
| Example: install the normal model. |
|
|
| ```sh |
| cd /root && \ |
| wget -O llm-model-amitaro-ja-jp-normal_0.1_arm64.deb \ |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb && \ |
| dpkg -i llm-model-amitaro-ja-jp-normal_0.1_arm64.deb && \ |
| apt -f install -y && \ |
| rm -f /root/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb |
| ``` |
|
|
| Example: install the punsuka model. |
|
|
| ```sh |
| cd /root && \ |
| wget -O llm-model-amitaro-ja-jp-punsuka_0.1_arm64.deb \ |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-punsuka_0.1_arm64.deb && \ |
| dpkg -i llm-model-amitaro-ja-jp-punsuka_0.1_arm64.deb && \ |
| apt -f install -y && \ |
| rm -f /root/llm-model-amitaro-ja-jp-punsuka_0.1_arm64.deb |
| ``` |
|
|
| If `wget` is not available, use `curl -L` instead. |
|
|
| ```sh |
| cd /root && \ |
| curl -L -o llm-model-amitaro-ja-jp-normal_0.1_arm64.deb \ |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb && \ |
| dpkg -i llm-model-amitaro-ja-jp-normal_0.1_arm64.deb && \ |
| apt -f install -y && \ |
| rm -f /root/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb |
| ``` |
|
|
| ### Download URLs |
|
|
| ```text |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-runrun_0.1_arm64.deb |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-yofukashi_0.1_arm64.deb |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-punsuka_0.1_arm64.deb |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-sasayaki-a_0.1_arm64.deb |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-sasayaki-b_0.1_arm64.deb |
| ``` |
|
|
| ## Install all packages |
|
|
| ```sh |
| scp llm-model-amitaro-ja-jp-*.deb root@<MODULE_IP>:/root/ |
| ssh root@<MODULE_IP> |
| cd /root |
| dpkg -i llm-model-amitaro-ja-jp-*.deb |
| apt -f install -y |
| rm -f /root/llm-model-amitaro-ja-jp-*.deb |
| ``` |
|
|
| ## Uninstall |
|
|
| Remove one model package: |
|
|
| ```sh |
| dpkg -r llm-model-amitaro-ja-jp-punsuka |
| ``` |
|
|
| Remove all Amitaro model packages: |
|
|
| ```sh |
| dpkg -r $(dpkg -l | awk '/llm-model-amitaro-ja-jp/ {print $2}') |
| ``` |
|
|
|
|
| ## Update / overwrite install |
|
|
| To update or overwrite an existing installation, install the new `.deb` with the same package name. `dpkg -i` will replace files owned by the same package. |
|
|
| Example: |
|
|
| ```sh |
| cd /root && \ |
| wget -O llm-model-amitaro-ja-jp-normal_0.1_arm64.deb \ |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb && \ |
| dpkg -i llm-model-amitaro-ja-jp-normal_0.1_arm64.deb && \ |
| apt -f install -y && \ |
| rm -f /root/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb |
| ``` |
|
|
| For clean reinstall, remove the package and its model directory first, then install again. |
|
|
| ```sh |
| apt remove -y llm-model-amitaro-ja-jp-normal || true |
| rm -rf /opt/m5stack/data/amitaro-ja-jp-normal |
| rm -f /opt/m5stack/data/models/mode_amitaro-ja-jp-normal.json |
| |
| cd /root && \ |
| wget -O llm-model-amitaro-ja-jp-normal_0.1_arm64.deb \ |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb && \ |
| dpkg -i llm-model-amitaro-ja-jp-normal_0.1_arm64.deb && \ |
| apt -f install -y && \ |
| rm -f /root/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb |
| ``` |
|
|
| When publishing a new build, it is recommended to increment the Debian package version, for example from `0.1` to `0.2`. |
|
|
| ## Volume warning |
|
|
| The default playback volume on Module LLM may be loud. Before testing, lower the mixer gains. |
|
|
| ```sh |
| tinymix -D 0 set 'RX LEFT ANA GAIN' 0 |
| tinymix -D 0 set 'RX RIGHT ANA GAIN' 0 |
| tinymix -D 0 set 'RX LEFT DIG GAIN' 1 |
| tinymix -D 0 set 'RX RIGHT DIG GAIN' 1 |
| tinymix -D 0 set 'TX LEFT ANA GAIN' 0 |
| tinymix -D 0 set 'TX RIGHT ANA GAIN' 0 |
| tinymix -D 0 set 'TX LEFT DIG GAIN' 1 |
| tinymix -D 0 set 'TX RIGHT DIG GAIN' 1 |
| tinymix -D 0 set 'ALC ENABLE' 0 |
| tinymix -D 0 set 'ALC GAIN MAX' 0 |
| ``` |
|
|
| ## Notes |
|
|
| - These are unofficial model packages for M5Stack Module LLM. |
| - They are not affiliated with or endorsed by M5Stack. |
| - The packages install model data under `/opt/m5stack/data/`. |
| - The raw Amitaro corpus WAV files are not included. |
| - Please comply with the MeloTTS, M5Stack, and Amitaro voice material terms. |
|
|
| ## License |
|
|
| License label: **Amitaro terms compliant**. |
|
|
| Required attribution: |
|
|
| ```text |
| Voice material by Amitaro's Voice Material Studio: https://amitaro.net/ |
| ``` |
|
|
| Main terms: |
|
|
| - Voice source: Amitaro ITA corpus voice recordings. |
| - Post-release reporting is requested/required when redistributing voice synthesis software or models made from the corpus. |
| - Commercial use is allowed under the Amitaro terms. |
| - Do not redistribute or sell the raw voice material itself as a material collection. |
| - Adult-restricted works, political/religious propaganda, hate, deceptive use, and defamation are not allowed. |
|
|
| References: |
|
|
| - Amitaro ITA corpus voice recordings: https://amitaro.net/voice/corpus-list/ita/ |
| - Amitaro voice material terms: https://amitaro.net/voice/voice_rule/ |
| - FAQ: https://amitaro.net/voice/faq/ |
| |
| See `LICENSE`, `NOTICE.md`, and `REPORT_TEMPLATE_JA.md` for details. |
| |
| </details> |
| |
| <details> |
| <summary id="日本語"><strong>日本語</strong></summary> |
| |
| ## 概要 |
| |
| このリポジトリは、M5Stack Module LLM 向けの、あみたろ風日本語 MeloTTS 音声モデル Debian パッケージを配布するものです。 |
| |
| 従来のような AXModel フォルダをそのままコピーする形式ではなく、`.deb` としてインストールできるパッケージ形式です。インストール後、モデルファイルは `/opt/m5stack/data/` 以下に配置され、StackFlow MeloTTS ランタイムから利用できます。 |
| |
| - 対象デバイス: M5Stack Module LLM |
| - 実行環境: StackFlow MeloTTS |
| - 配布形式: Debian パッケージ `.deb` |
| - アーキテクチャ: `arm64` |
| - 依存パッケージ: `lib-llm (>= 1.6)` |
| - 元 checkpoint: `G_6000.pth` |
| - decoder 変換: Pulsar2 4.2, `dec_len=128` |
| - テスト文: `これは推論テストです` |
|
|
| 学習元のあみたろ ITA コーパス wav 原音声は同梱していません。 |
|
|
| ## パッケージ一覧 |
|
|
| 以下のモデルパッケージを提供します。 |
|
|
| ```text |
| llm-model-amitaro-ja-jp-normal_0.1_arm64.deb |
| llm-model-amitaro-ja-jp-runrun_0.1_arm64.deb |
| llm-model-amitaro-ja-jp-yofukashi_0.1_arm64.deb |
| llm-model-amitaro-ja-jp-punsuka_0.1_arm64.deb |
| llm-model-amitaro-ja-jp-sasayaki-a_0.1_arm64.deb |
| llm-model-amitaro-ja-jp-sasayaki-b_0.1_arm64.deb |
| ``` |
|
|
| ## モデル名 |
|
|
| `tts.setup` で指定するモデル名は以下です。 |
|
|
| ```text |
| amitaro-ja-jp-normal |
| amitaro-ja-jp-runrun |
| amitaro-ja-jp-yofukashi |
| amitaro-ja-jp-punsuka |
| amitaro-ja-jp-sasayaki-a |
| amitaro-ja-jp-sasayaki-b |
| ``` |
|
|
| StackFlow のソケット API で使用する場合、`setup` は MeloTTS ワーカーに送ります。 |
|
|
| ```json |
| { |
| "work_id": "melotts", |
| "action": "setup", |
| "object": "tts.setup", |
| "data": { |
| "model": "amitaro-ja-jp-punsuka", |
| "response_format": "sys.play.0_1", |
| "input": "tts.utf-8", |
| "enoutput": true |
| } |
| } |
| ``` |
|
|
| 注意: カスタムモデル名は `sys.lsmode` に表示されない場合があります。ただし、`tts.setup` の `model` に直接指定することで利用できる場合があります。 |
|
|
|
|
| ## 直接ダウンロードしてインストール |
|
|
| `.deb` パッケージを Hugging Face に置いている場合、Module LLM 実機上で `wget` と `dpkg` を使って直接インストールできます。 |
|
|
| 例: normal モデルをインストールする場合。 |
|
|
| ```sh |
| cd /root && \ |
| wget -O llm-model-amitaro-ja-jp-normal_0.1_arm64.deb \ |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb && \ |
| dpkg -i llm-model-amitaro-ja-jp-normal_0.1_arm64.deb && \ |
| apt -f install -y && \ |
| rm -f /root/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb |
| ``` |
|
|
| 例: punsuka モデルをインストールする場合。 |
|
|
| ```sh |
| cd /root && \ |
| wget -O llm-model-amitaro-ja-jp-punsuka_0.1_arm64.deb \ |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-punsuka_0.1_arm64.deb && \ |
| dpkg -i llm-model-amitaro-ja-jp-punsuka_0.1_arm64.deb && \ |
| apt -f install -y && \ |
| rm -f /root/llm-model-amitaro-ja-jp-punsuka_0.1_arm64.deb |
| ``` |
|
|
| `wget` が使えない場合は、`curl -L` を使ってください。 |
|
|
| ```sh |
| cd /root && \ |
| curl -L -o llm-model-amitaro-ja-jp-normal_0.1_arm64.deb \ |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb && \ |
| dpkg -i llm-model-amitaro-ja-jp-normal_0.1_arm64.deb && \ |
| apt -f install -y && \ |
| rm -f /root/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb |
| ``` |
|
|
| ### ダウンロードURL |
|
|
| ```text |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-runrun_0.1_arm64.deb |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-yofukashi_0.1_arm64.deb |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-punsuka_0.1_arm64.deb |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-sasayaki-a_0.1_arm64.deb |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-sasayaki-b_0.1_arm64.deb |
| ``` |
|
|
| ## まとめてインストール |
|
|
| ```sh |
| scp llm-model-amitaro-ja-jp-*.deb root@<MODULE_IP>:/root/ |
| ssh root@<MODULE_IP> |
| cd /root |
| dpkg -i llm-model-amitaro-ja-jp-*.deb |
| apt -f install -y |
| rm -f /root/llm-model-amitaro-ja-jp-*.deb |
| ``` |
|
|
| ## アンインストール |
|
|
| 1つのモデルだけ削除する場合: |
|
|
| ```sh |
| dpkg -r llm-model-amitaro-ja-jp-punsuka |
| ``` |
|
|
| あみたろモデルパッケージをまとめて削除する場合: |
|
|
| ```sh |
| dpkg -r $(dpkg -l | awk '/llm-model-amitaro-ja-jp/ {print $2}') |
| ``` |
|
|
|
|
| ## 更新・上書きインストール |
|
|
| 既にインストール済みのモデルを更新または上書きしたい場合は、同じパッケージ名の新しい `.deb` を `dpkg -i` でインストールします。同じパッケージが所有するファイルは置き換えられます。 |
|
|
| 例: |
|
|
| ```sh |
| cd /root && \ |
| wget -O llm-model-amitaro-ja-jp-normal_0.1_arm64.deb \ |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb && \ |
| dpkg -i llm-model-amitaro-ja-jp-normal_0.1_arm64.deb && \ |
| apt -f install -y && \ |
| rm -f /root/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb |
| ``` |
|
|
| きれいに入れ直したい場合は、一度パッケージとモデルディレクトリを削除してから再インストールしてください。 |
|
|
| ```sh |
| apt remove -y llm-model-amitaro-ja-jp-normal || true |
| rm -rf /opt/m5stack/data/amitaro-ja-jp-normal |
| rm -f /opt/m5stack/data/models/mode_amitaro-ja-jp-normal.json |
| |
| cd /root && \ |
| wget -O llm-model-amitaro-ja-jp-normal_0.1_arm64.deb \ |
| https://huggingface.co/tori29umai/MeloTTS-amitaro-ja-jp-package/resolve/main/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb && \ |
| dpkg -i llm-model-amitaro-ja-jp-normal_0.1_arm64.deb && \ |
| apt -f install -y && \ |
| rm -f /root/llm-model-amitaro-ja-jp-normal_0.1_arm64.deb |
| ``` |
|
|
| 新しいビルドを配布する場合は、Debian パッケージの `Version` を `0.1` から `0.2` のように上げることをおすすめします。 |
|
|
| ## 音量に関する注意 |
|
|
| Module LLM の初期再生音量が大きい場合があります。テスト前に以下のように音量系の mixer gain を下げてください。 |
|
|
| ```sh |
| tinymix -D 0 set 'RX LEFT ANA GAIN' 0 |
| tinymix -D 0 set 'RX RIGHT ANA GAIN' 0 |
| tinymix -D 0 set 'RX LEFT DIG GAIN' 1 |
| tinymix -D 0 set 'RX RIGHT DIG GAIN' 1 |
| tinymix -D 0 set 'TX LEFT ANA GAIN' 0 |
| tinymix -D 0 set 'TX RIGHT ANA GAIN' 0 |
| tinymix -D 0 set 'TX LEFT DIG GAIN' 1 |
| tinymix -D 0 set 'TX RIGHT DIG GAIN' 1 |
| tinymix -D 0 set 'ALC ENABLE' 0 |
| tinymix -D 0 set 'ALC GAIN MAX' 0 |
| ``` |
|
|
| ## 注意事項 |
|
|
| - このパッケージは M5Stack 公式ではない非公式モデルパッケージです。 |
| - M5Stack 公式とは関係ありません。 |
| - パッケージは `/opt/m5stack/data/` 以下にモデルファイルを配置します。 |
| - 学習元のあみたろ ITA コーパス wav 原音声は同梱していません。 |
| - MeloTTS、M5Stack、あみたろ音声素材のライセンス・利用規約を確認したうえで利用してください。 |
|
|
| ## ライセンス |
|
|
| ライセンス表記: **あみたろ規約準拠** |
|
|
| 必須クレジット: |
|
|
| ```text |
| 音声素材：あみたろの声素材工房（https://amitaro.net/） |
| ``` |
|
|
| 主な条件: |
|
|
| - 音声元は「あみたろのITAコーパス読み上げ音声」です。 |
| - このコーパス音声を使った音声合成ソフト・音声合成モデルは、あみたろ規約の範囲で有償・無償配布できます。 |
| - 配布時は事後報告が必要/推奨されています。 |
| - 商用利用は可能です。 |
| - 元の音声素材そのものを素材集として販売・配布することはできません。 |
| - 年齢制限作品、政治・宗教・ヘイト、欺瞞目的、誹謗中傷用途では使えません。 |
|
|
| 参照: |
|
|
| - あみたろのITAコーパス読み上げ音声: https://amitaro.net/voice/corpus-list/ita/ |
| - フリー声素材ご利用規約: https://amitaro.net/voice/voice_rule/ |
| - FAQ: https://amitaro.net/voice/faq/ |
| |
| 詳細は `LICENSE`、`NOTICE.md`、`REPORT_TEMPLATE_JA.md` を確認してください。 |
| |
| </details> |
| |
