README update

README.md

@@ -1,11 +1,11 @@
-# TTS (Work in Progress...)
-This project is a part of [Mozilla Common Voice](https://voice.mozilla.org/en). TTS targets a Text2Speech engine lightweight in computation with high quality speech synthesis. You might hear a sample [here](https://soundcloud.com/user-565970875/commonvoice-loc-sens-attn).
+# TTS
+This project is a part of [Mozilla Common Voice](https://voice.mozilla.org/en). TTS aims a Text2Speech engine low in cost and high in quality. To begin with, you can hear a sample [here](https://soundcloud.com/user-565970875/commonvoice-loc-sens-attn).
 
-Here we have pytorch implementation of Tacotron: [A Fully End-to-End Text-To-Speech Synthesis Model](https://arxiv.org/abs/1703.10135). We plan to improve the model by the time with new architectural updates.
+The model here is highly inspired from Tacotron: [A Fully End-to-End Text-To-Speech Synthesis Model](https://arxiv.org/abs/1703.10135) however, it has many important updates over the baseline model that make training faster and computationally very efficient. Feel free to experiment new ideas and propose changes. 
 
 You can find [here](http://www.erogol.com/text-speech-deep-learning-architectures/) a brief note pointing possible TTS architectures and their comparisons.
 
-## Requirements
+## Requirements and Installation
 Highly recommended to use [miniconda](https://conda.io/miniconda.html) for easier installation.
   * python 3.6
   * pytorch 0.4
@@ -15,6 +15,14 @@ Highly recommended to use [miniconda](https://conda.io/miniconda.html) for easie
   * matplotlib
   * unidecode
 
+Install TTS using ```setup.py```. It will install all of the requirements automatically and make TTS available to all python environment as an ordinary python module. This makes things easier to run your model outside of the project folder.
+
+```python setup.py develop```
+
+Or you can use ```requirements.txt``` to install the requirements only.
+
+```pip install -r requirements.txt```
+
 ## Checkpoints and Audio Samples
 Checkout [here](https://mycroft.ai/blog/available-voices/#the-human-voice-is-the-most-perfect-instrument-of-all-arvo-part) to compare the samples (except the first) below.
 
@@ -25,12 +33,20 @@ Checkout [here](https://mycroft.ai/blog/available-voices/#the-human-voice-is-the
 | Best: [iter-270K](https://drive.google.com/drive/folders/1Q6BKeEkZyxSGsocK2p_mqgzLwlNvbHFJ?usp=sharing)|[256ed63](https://github.com/mozilla/TTS/tree/256ed63)|[link](https://soundcloud.com/user-565970875/sets/samples-1650226)|Stop-Token prediction is added, to detect end of speech.|
 | Best: [iter-K] | [bla]() | [link]() | Location Sensitive attention |
 
+## Example Model Outputs
+Below you see the model after 16K iteration with batch-size 32. 
+
+Sentence -- "Recent research at Harvard has shown meditating for as little as 8 weeks can actually increase the grey matter in the parts of the brain responsible for emotional regulation and learning."
+
+[[https://github.com/mozilla/TTS/blob/master/images/example_model_output.png|alt=example_model_output]]
+
+
 ## Data
-Currently TTS provides data loaders for
+Currently TTS provides data loaders for datasets depicted below. It is also very is to adapt new datasets with few changes.
 - [LJ Speech](https://keithito.com/LJ-Speech-Dataset/)
 
-## Training and Finetunning
-Split ```metadata.csv``` into train and validation subsets respectively ```metadata_train.csv``` and ```metadata_val.csv```.
+## Training and Fine-tuning
+Split ```metadata.csv``` into train and validation subsets respectively ```metadata_train.csv``` and ```metadata_val.csv```. Note that having a validation split does not work well as oppose to other ML problems since at the validation time model generates spectrogram slices without "Teacher-Forcing" and that leads misalignment between the ground-truth and the prediction. Therefore, validation loss does not really show the model performance. Rather, you might use the all data for training and check the model performance by relying on human inspection.
 
 ```
 shuf metadata.csv > metadata_shuf.csv
@@ -42,63 +58,34 @@ To train a new model, you need to define a ```config.json``` file (simple templa
 
 ```train.py --config_path config.json```
 
-To finetune a model, use ```--restore_path``` argument.
+To fine-tune a model, use ```--restore_path```.
 
 ```train.py --config_path config.json --restore_path /path/to/your/model.pth.tar```
 
-If you like to use specific set of GPUs, you need set an environment variable. The code uses automatically all the provided GPUs for data parallel training. If you don't specify the GPUs, it uses all GPUs of the system.
+If you like to use specific set of GPUs, you need set an environment variable. The code uses automatically all the available GPUs for data parallel training. If you don't specify the GPUs, it uses the all.
 
 ```CUDA_VISIBLE_DEVICES="0,1,4" train.py --config_path config.json```
 
-Each run creates an experiment folder with some meta information, under the folder you set in ```config.json```.
+Each run creates an experiment folder with some meta information, under the folder you set in ```config.json```. Also a copy of ```config.json``` is moved under the experiment folder for reproducibility. 
+
 In case of any error or intercepted execution, if there is no checkpoint yet under the execution folder, the whole folder is going to be removed.
 
 You can also enjoy Tensorboard, if you point the Tensorboard argument```--logdir``` to the experiment folder.
 
-Example ```config.json```:
-```
-{
-  "model_name": "my-model", // used in the experiment folder name
-  "num_mels": 80,
-  "num_freq": 1025,
-  "sample_rate": 20000,
-  "frame_length_ms": 50,
-  "frame_shift_ms": 12.5,
-  "preemphasis": 0.97,
-  "min_level_db": -100,
-  "ref_level_db": 20,
-  "embedding_size": 256,
-  "text_cleaner": "english_cleaners",
-
-  "epochs": 1000,
-  "lr": 0.002,
-  "warmup_steps": 4000,
-  "batch_size": 32,
-  "eval_batch_size":32,
-  "r": 5,
-
-  "griffin_lim_iters": 60,
-  "power": 1.5,
-
-  "num_loader_workers": 8,
-
-  "checkpoint": true,
-  "save_step": 376,
-  "data_path": "/my/training/data/path",
-  "min_seq_len": 0,
-  "output_path": "/my/experiment/folder/path"
-}
-
-```
-
 ## Testing
-Best way to test your pretrained network is to use Notebooks under ```notebooks``` folder.
+Best way to test your pre-trained network is to use Notebooks under ```notebooks``` folder.
 
-## Contribution
-Any kind of contribution is highly welcome as we are propelled by the open-source spirit. If you like to add or edit things in code, please also consider to write tests to verify your segment so that we can be sure things are on track as this repo gets bigger.
+## What is new with TTS
+If you train TTS with LJSpeech dataset, you start to hear reasonable results after 12.5K iterations with batch size 32. This is the fastest training with character based methods up to our knowledge. Out implementation is also quite robust against long sentences.
 
-## TODO
-Checkout issues and Project field.
+- Location sensitive attention ([ref](https://arxiv.org/pdf/1506.07503.pdf)). Attention is the vital part of text2speech models. Therefore, it is important to use an attention mechanism that suits the diagonal nature of the problem where the output strictly aligns with the text monotonically. Location sensitive attention performs better by looking into the previous alignment vectors and learns diagonal attention more easily. Yet, I believe there is a good space for research at this front to find a better solution.
+- Attention smoothing with sigmoid ([ref](https://arxiv.org/pdf/1506.07503.pdf)). Attention weights are computed by normalized sigmoid values instead of softmax for sharper values. That enables the model to pick multiple highly scored inputs for alignments while reducing the noise. 
+- Weight decay ([ref](http://www.fast.ai/2018/07/02/adam-weight-decay/)). After a certain point of the training, you might observe the model over-fitting. That is, model is able to pronounce words probably better but quality of the speech quality gets lower and sometimes attention alignment gets disoriented. 
+- Stop token prediction with an additional module. The original Tacotron model does not propose a stop token to stop the decoding process. Therefore, you need to use heuristic measures to stop the decoder. Here, we prefer to use additional layers at the end to decide when to stop.
+- Applying sigmoid to the model outputs. Since the output values are expected to be in the range [0, 1], we apply sigmoid to make things easier to approximate the expected output distribution. 
+
+One common question is to ask why we don't use Tacotron2 architecture. According to the experiments we performed by the individual components, noting, except the Location Sensitive Attention, improves the baseline perfomance of the Tacotron. 
+Please feel free to offer new changes and pull things off. We are happy to discuss and make things better. 
 
 ## References
 - [Efficient Neural Audio Synthesis](https://arxiv.org/pdf/1802.08435.pdf)