summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHiroshiba Kazuyuki <kazuyuki_hiroshiba@dwango.co.jp>2018-03-08 01:58:34 +0900
committerHiroshiba Kazuyuki <kazuyuki_hiroshiba@dwango.co.jp>2018-03-08 02:00:09 +0900
commit7b268e80d1c27be0db48854eb6cc918f8b61635d (patch)
treed41831cf7b3719866a361748458f382ff8474a6f
parent731fcb4c35a7989570c832058542c8fd35ab57f0 (diff)
READMEに記載
-rw-r--r--readme.md62
1 files changed, 40 insertions, 22 deletions
diff --git a/readme.md b/readme.md
index efbce21..e4b1600 100644
--- a/readme.md
+++ b/readme.md
@@ -1,27 +1,45 @@
-* 第1段階の学習
- * 音声データを用意する
- * 2つのディレクトリに、入出力の音声データを置く(ファイル名を揃える)
- * 音響特徴量切り出しをする
- * scripts/extract_acoustic_feature.py
- * 学習を回す
- * train.py
- * 実際に使用する
- * scripts/voice_conversion_test.py
-* 第2段階の学習
- * 音声データを用意する
- * 1つのディレクトリの超大量の結月ゆかり音声データを置く
- * 音響特徴量切り出しをする
- * scripts/extract_spectrogram_pair.py
- * 学習を回す
- * train_sr.py
- * 実際に使用する
- * scripts/super_resolution_test.py
- * 実際に使う
- * SuperResolutionクラスとAcousticConverterクラスを使ってモデルを読み込ませればいい
-    * [サンプルコート](https://github.com/Hiroshiba/become-yukarin/blob/ipynb/show%20vc%20and%20sr.ipynb)
-* 参考
+# 使い方
+
+## 必要なライブラリのインストール
+```bash
+pip install -r requirements.txt
+```
+
+## 学習させる
+学習用のPythonスクリプトを実行するには、`become_yukarin`ライブラリをパス(PYTHONPATH)に通す必要があります。
+例えば`scripts/extract_acoustic_feature.py`を以下のように書いて、パスを通しつつ実行します。
+
+```bash
+PYTHONPATH=`pwd` python scripts/extract_acoustic_feature.py ---
+```
+
+## 第1段階の学習
+* 音声データを用意する
+ * 2つのディレクトリに、入出力の音声データを置く(ファイル名を揃える)
+* 音響特徴量切り出しをする
+ * scripts/extract_acoustic_feature.py
+* 学習を回す
+ * train.py
+* 実際に使用する
+ * scripts/voice_conversion_test.py
+
+## 第2段階の学習
+* 音声データを用意する
+ * 1つのディレクトリの超大量の結月ゆかり音声データを置く
+* 音響特徴量切り出しをする
+ * scripts/extract_spectrogram_pair.py
+* 学習を回す
+ * train_sr.py
+* 実際に使用する
+ * scripts/super_resolution_test.py
+* 実際に使う
+ * SuperResolutionクラスとAcousticConverterクラスを使ってモデルを読み込ませればいい
+ * [サンプルコード](https://github.com/Hiroshiba/become-yukarin/blob/ipynb/show%20vc%20and%20sr.ipynb)
+
+## 参考
* [ipynbブランチ](https://github.com/Hiroshiba/become-yukarin/tree/ipynb)に大量にサンプルが置いてある
+## ファイル構造
```
├── become_yukarin # このディレクトリは外から使えることを想定
│   ├── __init__.py