Merge branch 'main' into v1.2.0

isletennos · Apr 28, 2022 · 510f44a · 510f44a
2 parents 350b6b5 + c008f62
commit 510f44a
Show file tree

Hide file tree

Showing 12 changed files with 574 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -101,6 +101,7 @@ https://drive.google.com/drive/folders/1XGpW0loNr1KjMtXVVG3WRd47R_ne6_X2?usp=sha
 
 5. notebookディレクトリにある「Train_MMVC.ipynb」をgoogle colab 上で実行してください。  
     logs/にモデルが生成されます。
+
 #### Ph3. 学習したモデルの性能検証
 1. notebookディレクトリにある「MMVC_Interface.ipynb」をgoogle colab 上で実行してください。
 ### 好きなキャラクターの声になる
@@ -110,7 +111,7 @@ https://drive.google.com/drive/folders/1XGpW0loNr1KjMtXVVG3WRd47R_ne6_X2?usp=sha
 
 2. 下記のようなディレクトリ構成になるように音声データとテキストデータを配置します。  
     textfulの直下には2ディレクトリになります。  
-    (1205_zundamonディレクトリは無くても問題ありません)  
+    (1205_zundamonディレクトリは無くても問題ありません) 
 
 ```
 dataset

diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,112 @@
+
+<!DOCTYPE html>
+
+<html lang="ja">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
+
+    <title>Welcome to MMVC&#39;s documentation! &#8212; MMVC 1.1.0 ドキュメント</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+    <script src="_static/jquery.js"></script>
+    <script src="_static/underscore.js"></script>
+    <script src="_static/doctools.js"></script>
+    <script src="_static/translations.js"></script>
+    <link rel="index" title="索引" href="genindex.html" />
+    <link rel="search" title="検索" href="search.html" />
+
+  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+  </head><body>
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+
+
+          <div class="body" role="main">
+
+  <section id="welcome-to-mmvc-s-documentation">
+<h1>Welcome to MMVC's documentation!<a class="headerlink" href="#welcome-to-mmvc-s-documentation" title="このヘッドラインへのパーマリンク">¶</a></h1>
+<div class="toctree-wrapper compound">
+</div>
+</section>
+<section id="indices-and-tables">
+<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="このヘッドラインへのパーマリンク">¶</a></h1>
+<ul class="simple">
+<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">索引</span></a></p></li>
+<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">モジュール索引</span></a></p></li>
+<li><p><a class="reference internal" href="search.html"><span class="std std-ref">検索ページ</span></a></p></li>
+</ul>
+</section>
+
+
+          </div>
+
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="#">MMVC</a></h1>
+
+
+
+
+
+
+
+
+<h3>ナビゲーション</h3>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="#">Documentation overview</a><ul>
+  </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">クイック検索</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="検索" />
+    </form>
+    </div>
+</div>
+<script>$('#searchbox').show(0);</script>
+
+
+
+
+
+
+
+
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &copy;2022, Isle.Tennos.
+
+      |
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
+
+      |
+      <a href="_sources/index.rst.txt"
+          rel="nofollow">Page source</a>
+    </div>
+
+
+
+
+  </body>
+</html>
diff --git a/docs/make.bat b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/source/chap1/chap1.rst b/docs/source/chap1/chap1.rst
@@ -0,0 +1,31 @@
+MMVCとは
+=========
+
+AIを使ったリアルタイムボイスチェンジャー「MMVC(RealTime-Many to Many Voice Conversion)」
+で使用するモデルを学習するためのリポジトリです。
+google colaboratoryを用いることで、個人の環境に依存せず、かつ簡単に機械学習の学習フェーズを実行可能です。
+
+
+Special thanks
+---------------------------------------------------------------------------
+- JVS (Japanese versatile speech) corpus
+    contributors : 高道 慎之介様/三井 健太郎様/齋藤 佑樹様/郡山 知樹様/丹治 尚子様/猿渡 洋様
+    https://sites.google.com/site/shinnosuketakamichi/research-topics/jvs_corpus
+- ITAコーパス マルチモーダルデータベース
+    contributors : 金井郁也様/千葉隆壱様/齊藤剛史様/森勢将雅様/小口純矢様/能勢隆様/尾上真惟子様/小田恭央様
+    CharacterVoice : 東北イタコ(木戸衣吹様)/ずんだもん(伊藤ゆいな様)/四国めたん(田中小雪様)
+    https://zunko.jp/multimodal_dev/login.php
+- つくよみちゃんコーパス
+    contributor : 夢前黎様
+    CharacterVoice : つくよみちゃん(夢前黎様)
+    https://tyc.rei-yumesaki.net/material/corpus/
+
+Reference
+---------------------------------------------------------------------------
+https://arxiv.org/abs/2106.06103
+https://github.com/jaywalnut310/vits
+
+Author
+---------------------------------------------------------------------------
+Isle Tennos
+Twitter : https://twitter.com/IsleTennos
diff --git a/docs/source/chap2/chap2.rst b/docs/source/chap2/chap2.rst
@@ -0,0 +1,24 @@
+利用規約
+=========
+2021/04/20
+
+| 
+| 本ソフトウェアの利用規約は基本的にMITライセンスに準拠します。
+| VRCでの利用などライセンス記載が不可の場合、記載は不要です。
+| ライセンスの記載が可能なプラットフォームでの利用の場合、下記クレジットどちらかををご利用ください。
+| (可能であればパターン2を使ってくれると製作者はうれしいです)
+| 
+| ライセンスパターン 1
+| 
+| Copyright (c) 2021 Isle.Tennos
+| Released under the MIT license
+| https://opensource.org/licenses/mit-license.php
+| 
+| ライセンスパターン 2
+| 
+| MMVCv1.x.x(使用バージョン)
+| Copyright (c) 2021 Isle.Tennos
+| Released under the MIT license
+| https://opensource.org/licenses/mit-license.php
+| git:https://github.com/isletennos/MMVC_Trainer
+| community(discord):https://discord.gg/PgspuDSTEc 
diff --git a/docs/source/chap3/chap3.rst b/docs/source/chap3/chap3.rst
@@ -0,0 +1,52 @@
+MMVCの導入
+==================
+
+インストール
+---------------------------------------------------------------------------
+https://github.com/isletennos/MMVC_Trainer をダウンロードして、展開、展開したディレクトリをgoogle drive上にアップロードしてください。
+
+学習用のデータセットの作成および配置
+---------------------------------------------------------------------------
+| 1)自分の声の音声データとその音声データに対応するテキスト、変換したい声の音声データとその音声データに対応するテキストを用意します。この時、用意する音声(自分の声の音声データ/変換したい声の音声データ共に)は24000Hz 16bit 1chを強く推奨しております。
+| 2)下記のようなディレクトリ構成になるように音声データとテキストデータを配置します。textfulの直下には2ディレクトリになります。
+|
+|    dataset
+|    ├── textful
+|    │   ├── 000_myvoice
+|    │   │   ├── text
+|    │   │   │   ├── s_voice_001.txt
+|    │   │   │   ├── s_voice_002.txt
+|    │   │   │   ├── ...
+|    │   │   └── wav
+|    │   │        ├── s_voice_001.wav
+|    │   │        ├── s_voice_002.wav
+|    │   │        ├── ...
+|    │   └── 001_target
+|    │       ├── text
+|    │       │   ├── t_voice_001.txt
+|    │       │   ├── t_voice_002.txt
+|    │       │   ├── ...
+|    │       └── wav
+|    │            ├── t_voice_001.wav
+|    │            ├── t_voice_002.wav
+|    │            ├── ...      
+|    │        
+|    └── textless
+
+
+モデルの学習方法
+---------------------------------------------------------------------------
+| 1)下記リンクより、「G_232000.pth」「D_232000.pth」をダウンロード。
+|     https://drive.google.com/drive/u/8/folders/1ZZ1tTPuXtwWZugJiMCAjvlz-xPdLQV6M
+| 2)G_232000.pth」「D_232000.pth」をfine_modelに移動。
+| 3)notebookディレクトリにある「Create_Configfile.ipynb」をgoogle colab 上で実行、学習に必要なconfigファイルを作成
+| 4)下記の2項目を環境に応じて学習したコンフィグファイル(json)で変更してください。
+|     - "eval_interval"
+|         modelを保存する間隔です
+|     - "batch_size"
+|         colabで割り当てたGPUに合わせて調整してください。
+| 5)notebookディレクトリにある「Train_MMVC.ipynb」をgoogle colab 上で実行してください。logs/にモデルが生成されます。
+
+学習したモデルの性能検証、評価
+---------------------------------------------------------------------------
+1)MMVC_interface.ipynbを実行
diff --git a/docs/source/chap4/chap4.rst b/docs/source/chap4/chap4.rst
@@ -0,0 +1,6 @@
+よくある質問
+==================
+.. toctree::
+   ./ph6_QA
+
+最終更新:2021/04/19