From df9f9f68a0d8487b669374e37e38150a232bc4bf Mon Sep 17 00:00:00 2001 From: Hiroshiba Date: Thu, 7 Dec 2023 00:42:33 +0900 Subject: [PATCH] =?UTF-8?q?[docs]=20=E3=83=89=E3=82=AD=E3=83=A5=E3=83=A1?= =?UTF-8?q?=E3=83=B3=E3=83=88=E6=95=B4=E7=90=86=EF=BC=88=E3=83=A6=E3=83=BC?= =?UTF-8?q?=E3=82=B6=E3=83=BC=E3=82=AC=E3=82=A4=E3=83=89=E3=82=92=E3=83=AA?= =?UTF-8?q?=E3=83=B3=E3=82=AF=E3=80=81VVM=E3=81=AE=E3=83=AA=E3=83=B3?= =?UTF-8?q?=E3=82=AF=E8=BF=BD=E5=8A=A0=E3=80=81=E5=88=A9=E7=94=A8=E8=A6=8F?= =?UTF-8?q?=E7=B4=84=E3=81=8C=E3=81=82=E3=82=8B=E3=81=93=E3=81=A8=E3=82=92?= =?UTF-8?q?=E6=A1=88=E5=86=85=EF=BC=89=20(#707)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 12 ++++++++++-- docs/downloader.md | 4 +++- docs/usage.md | 5 ++++- 3 files changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f8f080166..4024e9721 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,15 @@ [API ドキュメント](https://voicevox.github.io/voicevox_core/apis/c_api/globals_func.html)をご覧ください。 +## ユーザーガイド + +[VOICEVOX コア ユーザーガイド](./docs/usage.md)をご覧ください。 + ## 環境構築 +> [!NOTE] +> 音声モデル（VVM ファイル）には利用規約が存在します。詳しくはダウンロードしたファイル内の README に記載されています。 + Downloader を用いて環境構築を行う場合 ### Windows の場合 @@ -66,8 +73,9 @@ Raspberry Pi 用の ONNX Runtime は以下からダウンロードできます --> 1. まず [Releases](https://github.com/VOICEVOX/voicevox_core/releases/latest) からダウンロードしたコアライブラリの zip を、適当なディレクトリ名で展開します。CUDA 版、DirectML 版はかならずその zip ファイルをダウンロードしてください。 -2. [Open JTalk から配布されている辞書ファイル](https://jaist.dl.sourceforge.net/project/open-jtalk/Dictionary/open_jtalk_dic-1.11/open_jtalk_dic_utf_8-1.11.tar.gz) をダウンロードしてコアライブラリを展開したディレクトリに展開してください。 -3. CUDA や DirectML を利用する場合は、 [追加ライブラリ](https://github.com/VOICEVOX/voicevox_additional_libraries/releases/latest) をダウンロードして、コアライブラリを展開したディレクトリに展開してください。 +2. 同じく Releases から音声モデルの zip をダウンロードしてください。 +3. [Open JTalk から配布されている辞書ファイル](https://jaist.dl.sourceforge.net/project/open-jtalk/Dictionary/open_jtalk_dic-1.11/open_jtalk_dic_utf_8-1.11.tar.gz) をダウンロードしてコアライブラリを展開したディレクトリに展開してください。 +4. CUDA や DirectML を利用する場合は、 [追加ライブラリ](https://github.com/VOICEVOX/voicevox_additional_libraries/releases/latest) をダウンロードして、コアライブラリを展開したディレクトリに展開してください。 diff --git a/docs/downloader.md b/docs/downloader.md index 9f5ba7530..aeff5b4a8 100644 --- a/docs/downloader.md +++ b/docs/downloader.md @@ -1,7 +1,9 @@ # VOICEVOX CORE Downloader -VOICEVOX COREの実行にはモデルやOpen JTalkなどの外部ライブラリのダウンロードが必要になります。 +VOICEVOX COREの実行には音声モデル（VVM ファイル）やOpen JTalkなどの外部ライブラリのダウンロードが必要になります。 VOICEVOX CORE Downloaderは環境に合わせてそれらをダウンロードします。 +> [!NOTE] +> 音声モデル（VVM ファイル）には利用規約が存在します。詳しくはダウンロードしたファイル内の README に記載されています。 # ダウンローダーの入手 diff --git a/docs/usage.md b/docs/usage.md index e602e72fd..e649a0949 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -14,6 +14,9 @@ VOICEVOX の音声合成のコア部分で、VOICEVOX 音声合成が可能で コアを動作させるには依存ライブラリである ONNX Runtime や、音声合成のための音声モデル（VVM ファイル）が必要です。これらはコア用の Downloader を用いてダウンロードすることができます。 +> [!NOTE] +> 音声モデル（VVM ファイル）には利用規約が存在します。詳しくはダウンロードしたファイル内の README に記載されています。 + [最新のリリース](https://github.com/VOICEVOX/voicevox_core/releases/latest/)から、お使いの環境にあった Downloader （例えば Windows の x64 環境の場合は`download-windows-x64.exe`）をダウンロードし、ファイル名を`download`に変更します。macOS や Linux の場合は実行権限を付与します。 ```sh @@ -88,7 +91,7 @@ asyncio.run(main()) ### 2. 音声モデルの読み込み -VVM ファイルから`VoiceModel`インスタンスを作成し、`Synthesizer`に読み込ませます。その VVM ファイルにどの声が含まれているかは`VoiceModel`の`.metas`で確認できます。 +VVM ファイルから`VoiceModel`インスタンスを作成し、`Synthesizer`に読み込ませます。その VVM ファイルにどの声が含まれているかは`VoiceModel`の`.metas`や[音声モデルと声の対応表](https://github.com/VOICEVOX/voicevox_fat_resource/blob/main/core/model/README.md#%E9%9F%B3%E5%A3%B0%E3%83%A2%E3%83%87%E3%83%ABvvm%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%A8%E5%A3%B0%E3%82%AD%E3%83%A3%E3%83%A9%E3%82%AF%E3%82%BF%E3%83%BC%E3%82%B9%E3%82%BF%E3%82%A4%E3%83%AB%E5%90%8D%E3%81%A8%E3%82%B9%E3%82%BF%E3%82%A4%E3%83%AB-id-%E3%81%AE%E5%AF%BE%E5%BF%9C%E8%A1%A8)で確認できます。 ```python model = await VoiceModel.from_path("model/0.vvm")