Add preliminary sphinx documentation

Author: erogol

.gitignore

@@ -140,7 +140,7 @@ events.out*
 old_configs/*
 model_importers/*
 model_profiling/*
-docs/*
+docs/source/TODO/*
 .noseids
 .dccache
 log.txt

Makefile

@@ -6,16 +6,6 @@ help:
 
 target_dirs := tests TTS notebooks
 
-system-deps:	## install linux system deps
-	sudo apt-get install -y libsndfile1-dev
-
-dev-deps:  ## install development deps
-	pip install -r requirements.dev.txt
-	pip install -r requirements.tf.txt
-
-deps:	## install 🐸 requirements.
-	pip install -r requirements.txt
-
 test_all:	## run tests and don't stop on an error.
 	nosetests --with-cov -cov  --cover-erase --cover-package TTS tests --nologcapture --with-id
 	./run_bash_tests.sh
@@ -34,5 +24,21 @@ style:	## update code style.
 lint:	## run pylint linter.
 	pylint ${target_dirs}
 
+system-deps:	## install linux system deps
+	sudo apt-get install -y libsndfile1-dev
+
+dev-deps:  ## install development deps
+	pip install -r requirements.dev.txt
+	pip install -r requirements.tf.txt
+
+doc-deps:  ## install docs dependencies
+	pip install -r docs/requirements.txt
+
+hub-deps:  ## install deps for torch hub use
+	pip install -r requirements.hub.txt
+
+deps:	## install 🐸 requirements.
+	pip install -r requirements.txt
+
 install:	## install 🐸 TTS for development.
 	pip install -e .[all]

README.md

@@ -5,6 +5,7 @@
 
 [![CircleCI](https://github.com/coqui-ai/TTS/actions/workflows/main.yml/badge.svg)]()
 [![License](<https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg>)](https://opensource.org/licenses/MPL-2.0)
+[![Docs](<https://readthedocs.org/projects/tts/badge/?version=latest&style=plastic>)](https://tts.readthedocs.io/en/latest/)
 [![PyPI version](https://badge.fury.io/py/TTS.svg)](https://badge.fury.io/py/TTS)
 [![Covenant](https://camo.githubusercontent.com/7d620efaa3eac1c5b060ece5d6aacfcc8b81a74a04d05cd0398689c01c4463bb/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f436f6e7472696275746f72253230436f76656e616e742d76322e3025323061646f707465642d6666363962342e737667)](https://github.com/coqui-ai/TTS/blob/master/CODE_OF_CONDUCT.md)
 [![Downloads](https://pepy.tech/badge/tts)](https://pepy.tech/project/tts)
@@ -16,12 +17,10 @@
 
 📢 [English Voice Samples](https://erogol.github.io/ddc-samples/) and [SoundCloud playlist](https://soundcloud.com/user-565970875/pocket-article-wavernn-and-tacotron2)
 
-👩🏽‍🍳 [TTS training recipes](https://github.com/erogol/TTS_recipes)
-
 📄 [Text-to-Speech paper collection](https://github.com/erogol/TTS-papers)
 
 ## 💬 Where to ask questions
-Please use our dedicated channels for questions and discussion. Help is much more valuable if it's shared publicly, so that more people can benefit from it.
+Please use our dedicated channels for questions and discussion. Help is much more valuable if it's shared publicly so that more people can benefit from it.
 
 | Type                            | Platforms                               |
 | ------------------------------- | --------------------------------------- |
@@ -40,14 +39,11 @@ Please use our dedicated channels for questions and discussion. Help is much mor
 ## 🔗 Links and Resources
 | Type                            | Links                               |
 | ------------------------------- | --------------------------------------- |
+| 💼 **Documentation**              | [ReadTheDocs](https://tts.readthedocs.io/en/latest/)
 | 💾 **Installation**               | [TTS/README.md](https://github.com/coqui-ai/TTS/tree/dev#install-tts)|
 | 👩‍💻 **Contributing**               | [CONTRIBUTING.md](https://github.com/coqui-ai/TTS/blob/main/CONTRIBUTING.md)|
 | 📌 **Road Map**                   | [Main Development Plans](https://github.com/coqui-ai/TTS/issues/378)
-| 👩🏾‍🏫 **Tutorials and Examples**     | [TTS/Wiki](https://github.com/coqui-ai/TTS/wiki/%F0%9F%90%B8-TTS-Notebooks,-Examples-and-Tutorials) |
 | 🚀 **Released Models**            | [TTS Releases](https://github.com/coqui-ai/TTS/releases) and [Experimental Models](https://github.com/coqui-ai/TTS/wiki/Experimental-Released-Models)|
-| 🖥️ **Demo Server**                | [TTS/server](https://github.com/coqui-ai/TTS/tree/master/TTS/server)|
-| 🤖 **Synthesize speech**          | [TTS/README.md](https://github.com/coqui-ai/TTS#example-synthesizing-speech-on-terminal-using-the-released-models)|
-| 🛠️ **Implementing a New Model**   | [TTS/Wiki](https://github.com/coqui-ai/TTS/wiki/Implementing-a-New-Model-in-%F0%9F%90%B8TTS)|
 
 ## 🥇 TTS Performance
 <p align="center"><img src="https://raw.githubusercontent.com/coqui-ai/TTS/main/images/TTS-performance.png" width="800" /></p>
@@ -56,20 +52,19 @@ Underlined "TTS*" and "Judy*" are 🐸TTS models
 <!-- [Details...](https://github.com/coqui-ai/TTS/wiki/Mean-Opinion-Score-Results) -->
 
 ## Features
-- High performance Deep Learning models for Text2Speech tasks.
+- High-performance Deep Learning models for Text2Speech tasks.
     - Text2Spec models (Tacotron, Tacotron2, Glow-TTS, SpeedySpeech).
     - Speaker Encoder to compute speaker embeddings efficiently.
     - Vocoder models (MelGAN, Multiband-MelGAN, GAN-TTS, ParallelWaveGAN, WaveGrad, WaveRNN)
 - Fast and efficient model training.
-- Detailed training logs on console and Tensorboard.
-- Support for multi-speaker TTS.
-- Efficient Multi-GPUs training.
+- Detailed training logs on the terminal and Tensorboard.
+- Support for Multi-speaker TTS.
+- Efficient, flexible, lightweight but feature complete `Trainer API`.
 - Ability to convert PyTorch models to Tensorflow 2.0 and TFLite for inference.
-- Released models in PyTorch, Tensorflow and TFLite.
+- Released and read-to-use models.
 - Tools to curate Text2Speech datasets under```dataset_analysis```.
-- Demo server for model testing.
-- Notebooks for extensive model benchmarking.
-- Modular (but not too much) code base enabling easy testing for new ideas.
+- Utilities to use and test your models.
+- Modular (but not too much) code base enabling easy implementation of new ideas.
 
 ## Implemented Models
 ### Text-to-Spectrogram
@@ -98,8 +93,9 @@ Underlined "TTS*" and "Judy*" are 🐸TTS models
 - WaveRNN: [origin](https://github.com/fatchord/WaveRNN/)
 - WaveGrad: [paper](https://arxiv.org/abs/2009.00713)
 - HiFiGAN: [paper](https://arxiv.org/abs/2010.05646)
+- UnivNet: [paper](https://arxiv.org/abs/2106.07889)
 
-You can also help us implement more models. Some 🐸TTS related work can be found [here](https://github.com/erogol/TTS-papers).
+You can also help us implement more models.
 
 ## Install TTS
 🐸TTS is tested on Ubuntu 18.04 with **python >= 3.6, < 3.9**.
@@ -110,7 +106,7 @@ If you are only interested in [synthesizing speech](https://github.com/coqui-ai/
 pip install TTS
 ```
 
-By default this only installs the requirements for PyTorch. To install the tensorflow dependencies as well, use the `tf` extra.
+By default, this only installs the requirements for PyTorch. To install the tensorflow dependencies as well, use the `tf` extra.
 
 ```bash
 pip install TTS[tf]
@@ -123,12 +119,6 @@ git clone https://github.com/coqui-ai/TTS
 pip install -e .[all,dev,notebooks,tf]  # Select the relevant extras
 ```
 
-We use ```espeak-ng``` to convert graphemes to phonemes. You might need to install separately.
-
-```bash
-sudo apt-get install espeak-ng
-```
-
 If you are on Ubuntu (Debian), you can also run following commands for installation.
 
 ```bash
@@ -137,6 +127,7 @@ $ make install
 ```
 
 If you are on Windows, 👑@GuyPaddock wrote installation instructions [here](https://stackoverflow.com/questions/66726331/how-can-i-run-mozilla-tts-coqui-tts-training-with-cuda-on-a-windows-system).
+
 ## Directory Structure
 ```
 |- notebooks/       (Jupyter Notebooks for model evaluation, parameter selection and data analysis.)
@@ -147,6 +138,7 @@ If you are on Windows, 👑@GuyPaddock wrote installation instructions [here](ht
       |- distribute.py              (train your TTS model using Multiple GPUs.)
       |- compute_statistics.py      (compute dataset statistics for normalization.)
       |- convert*.py                (convert target torch model to TF.)
+      |- ...
     |- tts/             (text to speech models)
         |- layers/          (model layer definitions)
         |- models/          (model definitions)
@@ -156,167 +148,4 @@ If you are on Windows, 👑@GuyPaddock wrote installation instructions [here](ht
         |- (same)
     |- vocoder/         (Vocoder models.)
         |- (same)
-```
-
-## Sample Model Output
-Below you see Tacotron model state after 16K iterations with batch-size 32 with LJSpeech dataset.
-
-> "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."
-
-Audio examples: [soundcloud](https://soundcloud.com/user-565970875/pocket-article-wavernn-and-tacotron2)
-
-<img src="images/example_model_output.png?raw=true" alt="example_output" width="400"/>
-
-## Datasets and Data-Loading
-🐸TTS provides a generic dataloader easy to use for your custom dataset.
-You just need to write a simple function to format the dataset. Check ```datasets/preprocess.py``` to see some examples.
-After that, you need to set ```dataset``` fields in ```config.json```.
-
-Some of the public datasets that we successfully applied 🐸TTS:
-
-- [LJ Speech](https://keithito.com/LJ-Speech-Dataset/)
-- [Nancy](http://www.cstr.ed.ac.uk/projects/blizzard/2011/lessac_blizzard2011/)
-- [TWEB](https://www.kaggle.com/bryanpark/the-world-english-bible-speech-dataset)
-- [M-AI-Labs](http://www.caito.de/2019/01/the-m-ailabs-speech-dataset/)
-- [LibriTTS](https://openslr.org/60/)
-- [Spanish](https://drive.google.com/file/d/1Sm_zyBo67XHkiFhcRSQ4YaHPYM0slO_e/view?usp=sharing) - thx! @carlfm01
-
-## Example: Synthesizing Speech on Terminal Using the Released Models.
-<img src="images/tts_cli.gif"/>
-
-After the installation, 🐸TTS provides a CLI interface for synthesizing speech using pre-trained models. You can either use your own model or the release models under 🐸TTS.
-
-Listing released 🐸TTS models.
-
-```bash
-tts --list_models
-```
-
-Run a TTS model, from the release models list, with its default vocoder. (Simply copy and paste the full model names from the list as arguments for the command below.)
-
-```bash
-tts --text "Text for TTS" \
-    --model_name "<type>/<language>/<dataset>/<model_name>" \
-    --out_path folder/to/save/output.wav
-```
-
-Run a tts and a vocoder model from the released model list. Note that not every vocoder is compatible with every TTS model.
-
-```bash
-tts --text "Text for TTS" \
-    --model_name "<type>/<language>/<dataset>/<model_name>" \
-    --vocoder_name "<type>/<language>/<dataset>/<model_name>" \
-    --out_path folder/to/save/output.wav
-```
-
-Run your own TTS model (Using Griffin-Lim Vocoder)
-
-```bash
-tts --text "Text for TTS" \
-    --model_path path/to/model.pth.tar \
-    --config_path path/to/config.json \
-    --out_path folder/to/save/output.wav
-```
-
-Run your own TTS and Vocoder models
-
-```bash
-tts --text "Text for TTS" \
-    --config_path path/to/config.json \
-    --model_path path/to/model.pth.tar \
-    --out_path folder/to/save/output.wav \
-    --vocoder_path path/to/vocoder.pth.tar \
-    --vocoder_config_path path/to/vocoder_config.json
-```
-
-Run a multi-speaker TTS model from the released models list.
-
-```bash
-tts --model_name "<type>/<language>/<dataset>/<model_name>"  --list_speaker_idxs  # list the possible speaker IDs.
-tts --text "Text for TTS." --out_path output/path/speech.wav --model_name "<language>/<dataset>/<model_name>"  --speaker_idx "<speaker_id>"
-```
-
-**Note:** You can use ```./TTS/bin/synthesize.py``` if you prefer running ```tts``` from the TTS project folder.
-
-## Example: Using the Demo Server for Synthesizing Speech
-
- <!-- <img src="https://raw.githubusercontent.com/coqui-ai/TTS/main/images/demo_server.gif" height="56"/> -->
- <img src="images/demo_server.gif"/>
-
-You can boot up a demo 🐸TTS server to run inference with your models. Note that the server is not optimized for performance
-but gives you an easy way to interact with the models.
-
-The demo server provides pretty much the same interface as the CLI command.
-
-```bash
-tts-server -h # see the help
-tts-server --list_models  # list the available models.
-```
-
-Run a TTS model, from the release models list, with its default vocoder.
-If the model you choose is a multi-speaker TTS model, you can select different speakers on the Web interface and synthesize
-speech.
-
-```bash
-tts-server --model_name "<type>/<language>/<dataset>/<model_name>"
-```
-
-Run a TTS and a vocoder model from the released model list. Note that not every vocoder is compatible with every TTS model.
-
-```bash
-tts-server --model_name "<type>/<language>/<dataset>/<model_name>" \
-           --vocoder_name "<type>/<language>/<dataset>/<model_name>"
-```
-
-
-## Example: Training and Fine-tuning LJ-Speech Dataset
-Here you can find a [CoLab](https://gist.github.com/erogol/97516ad65b44dbddb8cd694953187c5b) notebook for a hands-on example, training LJSpeech. Or you can manually follow the guideline below.
-
-To start with, split ```metadata.csv``` into train and validation subsets respectively ```metadata_train.csv``` and ```metadata_val.csv```. Note that for text-to-speech, validation performance might be misleading since the loss value does not directly measure the voice quality to the human ear and it also does not measure the attention module performance. Therefore, running the model with new sentences and listening to the results is the best way to go.
-
-```
-shuf metadata.csv > metadata_shuf.csv
-head -n 12000 metadata_shuf.csv > metadata_train.csv
-tail -n 1100 metadata_shuf.csv > metadata_val.csv
-```
-
-To train a new model, you need to define your own ```config.json``` to define model details, trainin configuration and more (check the examples). Then call the corressponding train script.
-
-For instance, in order to train a tacotron or tacotron2 model on LJSpeech dataset, follow these steps.
-
-```bash
-python TTS/bin/train_tacotron.py --config_path TTS/tts/configs/config.json
-```
-
-To fine-tune a model, use ```--restore_path```.
-
-```bash
-python TTS/bin/train_tacotron.py --config_path TTS/tts/configs/config.json --restore_path /path/to/your/model.pth.tar
-```
-
-To continue an old training run, use ```--continue_path```.
-
-```bash
-python TTS/bin/train_tacotron.py --continue_path /path/to/your/run_folder/
-```
-
-For multi-GPU training, call ```distribute.py```. It runs any provided train script in multi-GPU setting.
-
-```bash
-CUDA_VISIBLE_DEVICES="0,1,4" python TTS/bin/distribute.py --script train_tacotron.py --config_path TTS/tts/configs/config.json
-```
-
-Each run creates a new output folder accomodating used ```config.json```, model checkpoints and tensorboard logs.
-
-In case of any error or intercepted execution, if there is no checkpoint yet under the output folder, the whole folder is going to be removed.
-
-You can also enjoy Tensorboard,  if you point Tensorboard argument```--logdir``` to the experiment folder.
-
-## [Contribution guidelines](https://github.com/coqui-ai/TTS/blob/main/CONTRIBUTING.md)
-### Acknowledgement
-- https://github.com/keithito/tacotron (Dataset pre-processing)
-- https://github.com/r9y9/tacotron_pytorch (Initial Tacotron architecture)
-- https://github.com/kan-bayashi/ParallelWaveGAN (GAN based vocoder library)
-- https://github.com/jaywalnut310/glow-tts (Original Glow-TTS implementation)
-- https://github.com/fatchord/WaveRNN/ (Original WaveRNN implementation)
-- https://arxiv.org/abs/2010.05646 (Original HiFiGAN implementation)
+```

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)

docs/README.md

@@ -0,0 +1,5 @@
+furo
+myst-parser == 0.15.1
+sphinx == 4.0.2
+sphinx_inline_tabs
+sphinx_copybutton

docs/requirements.txt

@@ -0,0 +1,25 @@
+# AudioProcessor
+
+`TTS.utils.audio.AudioProcessor` is the core class for all the audio processing routines. It provides an API for
+
+- Feature extraction.
+- Sound normalization.
+- Reading and writing audio files.
+- Sampling audio signals.
+- Normalizing and denormalizing audio signals.
+- Griffin-Lim vocoder.
+
+The `AudioProcessor` needs to be initialized with `TTS.config.shared_configs.BaseAudioConfig`. Any model config
+also must inherit or initiate `BaseAudioConfig`.
+
+## AudioProcessor
+```{eval-rst}
+.. autoclass:: TTS.utils.audio.AudioProcessor
+    :members:
+```
+
+## BaseAudioConfig
+```{eval-rst}
+.. autoclass:: TTS.config.shared_configs.BaseAudioConfig
+    :members:
+```