Dev v0.0.10

.circleci/config.yml

@@ -25,17 +25,15 @@ jobs:
  - checkout
  - run: |
  sudo apt update
- sudo apt install espeak git
+ sudo apt install espeak-ng git
  - run: sudo pip install --upgrade pip
  - run: sudo pip install -e .
  - run: |
  sudo pip install --quiet --upgrade cardboardlint pylint
  cardboardlinter --refspec ${CIRCLE_BRANCH} -n auto
- - run: nosetests tests --nocapture
+ - run: nosetests tests --nocapture --processes=0 --process-timeout=20 --process-restartworker
  - run: |
- sudo ./tests/test_server_package.sh
  sudo ./tests/test_glow-tts_train.sh
- sudo ./tests/test_server_package.sh
  sudo ./tests/test_tacotron_train.sh
  sudo ./tests/test_vocoder_gan_train.sh
  sudo ./tests/test_vocoder_wavegrad_train.sh

.github/workflows/main.yml

@@ -0,0 +1,60 @@
+name: Test
+
+on:
+ push:
+ branches:
+ - master
+ - dev
+ pull_request:
+ types: [opened, synchronize, reopened]
+jobs:
+ check_skip:
+ runs-on: ubuntu-latest
+ if: "! contains(github.event.head_commit.message, '[ci skip]')"
+ steps:
+ - run: echo "${{ github.event.head_commit.message }}"
+
+ test:
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ matrix:
+ python-version: [3.6, 3.7, 3.8]
+
+ steps:
+ - uses: actions/checkout@v2
+ - uses: actions/cache@v1
+ with:
+ path: ~/.cache/pip
+ key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('**/setup.py') }}
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v2
+ with:
+ python-version: ${{ matrix.python-version }}
+ - name: check OS
+ run: cat /etc/os-release
+ - name: Install dependencies
+ run: |
+ sudo apt update
+ sudo apt install espeak-ng git
+ - name: Upgrade pip
+ # so we can take advantage of pyproject.toml build-dependency support
+ run: python3 -m pip install --upgrade pip
+ - name: Install TTS
+ run: |
+ python3 -m pip install .
+ python3 setup.py egg_info
+ - name: Lint check
+ run: |
+ cardboardlinter -n auto
+ - name: Unit tests
+ run: nosetests tests --nocapture --processes=0 --process-timeout=20 --process-restartworker
+ - name: Test scripts
+ run: |
+ ./tests/test_demo_server.sh
+ ./tests/test_glow-tts_train.sh
+ ./tests/test_tacotron_train.sh
+ ./tests/test_vocoder_gan_train.sh
+ ./tests/test_vocoder_wavegrad_train.sh
+ ./tests/test_vocoder_wavernn_train.sh
+ ./tests/test_speedy_speech_train.sh

.gitignore

@@ -130,3 +130,4 @@ TODO.txt
 data/*
 notebooks/data/*
 TTS/tts/layers/glow_tts/monotonic_align/core.c
+temp_build/*

CODE_OF_CONDUCT.md

@@ -1,19 +1,133 @@
-# Ethical Notice
 
-Please consider possible consequences and be mindful of any adversarial use cases of this project. In this regard, please contact us if you have any concerns. 
+# Contributor Covenant Code of Conduct
 
-# Community Participation Guidelines
+## Our Pledge
 
-This repository is governed by Mozilla's code of conduct and etiquette guidelines. 
-For more details, please read the
-[Mozilla Community Participation Guidelines](https://www.mozilla.org/about/governance/policies/participation/). 
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
 
-## How to Report
-For more information on how to report violations of the Community Participation Guidelines, please read our '[How to Report](https://www.mozilla.org/about/governance/policies/participation/reporting/)' page.
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
-<!--
-## Project Specific Etiquette
+## Our Standards
 
-In some cases, there will be additional project etiquette i.e.: (https://bugzilla.mozilla.org/page.cgi?id=etiquette.html).
-Please update for your project.
--->
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+ and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+ overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+ advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+ address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+coc-report@coqui.ai.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by 
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available 
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

README.md

@@ -1,17 +1,18 @@
 # <img src="images/coqui-log-green-TTS.png" height="56"/>
 
-TTS is a library for advanced Text-to-Speech generation. It's built on the latest research, was designed to achieve the best trade-off among ease-of-training, speed and quality.
-TTS comes with [pretrained models](https://github.com/coqui-ai/TTS/wiki/Released-Models), tools for measuring dataset quality and already used in **20+ languages** for products and research projects.
+:frog: TTS is a library for advanced Text-to-Speech generation. It's built on the latest research, was designed to achieve the best trade-off among ease-of-training, speed and quality.
+:frog: TTS comes with [pretrained models](https://github.com/coqui-ai/TTS/wiki/Released-Models), tools for measuring dataset quality and already used in **20+ languages** for products and research projects.
 
 <!-- [![CircleCI](TODO)]() -->
 [![License](<https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg>)](https://opensource.org/licenses/MPL-2.0)
 [![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)
 
-:loudspeaker: [English Voice Samples](https://erogol.github.io/ddc-samples/) and [SoundCloud playlist](https://soundcloud.com/user-565970875/pocket-article-wavernn-and-tacotron2)
+📢 [English Voice Samples](https://erogol.github.io/ddc-samples/) and [SoundCloud playlist](https://soundcloud.com/user-565970875/pocket-article-wavernn-and-tacotron2)
 
-:man_cook: [TTS training recipes](https://github.com/erogol/TTS_recipes)
+👩🏽‍🍳 [TTS training recipes](https://github.com/erogol/TTS_recipes)
 
-:page_facing_up: [Text-to-Speech paper collection](https://github.com/erogol/TTS-papers)
+📄 [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.
@@ -87,24 +88,29 @@ Underlined "TTS*" and "Judy*" are :frog:TTS models
 - WaveRNN: [origin](https://github.com/fatchord/WaveRNN/)
 - WaveGrad: [paper](https://arxiv.org/abs/2009.00713)
 
-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. Some :frog: TTS related work can be found [here](https://github.com/erogol/TTS-papers).
 
 ## Install TTS
-TTS is tested on Ubuntu 18.04 with **python >= 3.6, < 3.9**.
+:frog: TTS is tested on Ubuntu 18.04 with **python >= 3.6, < 3.9**.
 
-If you are only interested in [synthesizing speech](https://github.com/coqui-ai/TTS/tree/dev#example-synthesizing-speech-on-terminal-using-the-released-models) with the released TTS models, installing from PyPI is the easiest option.
+If you are only interested in [synthesizing speech](https://github.com/coqui-ai/TTS/tree/dev#example-synthesizing-speech-on-terminal-using-the-released-models) with the released :frog: TTS models, installing from PyPI is the easiest option.
 
 ```bash
 pip install TTS
 ```
 
-If you plan to code or train models, clone TTS and install it locally.
+If you plan to code or train models, clone :frog: TTS and install it locally.
 
 ```bash
 git clone https://github.com/coqui-ai/TTS
 pip install -e .
 ```
 
+We use ```espeak-ng``` to convert graphemes to phonemes. You might need to install separately.
+```bash
+sudo apt-get install espeak-ng
+```
+
 ## Directory Structure
 ```
 |- notebooks/ (Jupyter Notebooks for model evaluation, parameter selection and data analysis.)
@@ -136,11 +142,11 @@ Audio examples: [soundcloud](https://soundcloud.com/user-565970875/pocket-articl
 <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.
+:frog: 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:
+Some of the public datasets that we successfully applied :frog: TTS:
 
 - [LJ Speech](https://keithito.com/LJ-Speech-Dataset/)
 - [Nancy](http://www.cstr.ed.ac.uk/projects/blizzard/2011/lessac_blizzard2011/)
@@ -151,9 +157,9 @@ Some of the public datasets that we successfully applied TTS:
 
 ## Example: Synthesizing Speech on Terminal Using the Released Models.
 
-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 the TTS project.
+After the installation, :frog: TTS provides a CLI interface for synthesizing speech using pre-trained models. You can either use your own model or the release models under :frog: TTS.
 
-Listing released TTS models.
+Listing released :frog: TTS models.
 ```bash
 tts --list_models
 ```
@@ -230,25 +236,28 @@ In case of any error or intercepted execution, if there is no checkpoint yet und
 You can also enjoy Tensorboard, if you point Tensorboard argument```--logdir``` to the experiment folder.
 
 ## Contribution guidelines
-Please send your Pull Request to ```dev``` branch. Before making a Pull Request, check your changes for basic mistakes and style problems by using a linter. We have cardboardlinter setup in this repository, so for example, if you've made some changes and would like to run the linter on just the changed code, you can use the follow command:
+Please follow the steps below as you send a PR for :frog:. It helps us to keep things organized.
 
+1. Create a new branch.
+2. Implement your changes.
+3. (if applicable) Add [Google Style](https://google.github.io/styleguide/pyguide.html#381-docstrings) docstrings.
+4. (if applicable) Implement a test case under ```tests``` folder.
+5. (Optional but Prefered) Run tests.
+```bash
+./run_tests.sh
+```
+6. Run the linter.
 ```bash
 pip install pylint cardboardlint
 cardboardlinter --refspec master
 ```
 7. Send a PR to ```dev``` branch, explain what the change is about.
-8. Let us discuss until we make it perfect :).
+8. Let us discuss until we make it perfect :) 💪.
 9. We merge it to the ```dev``` branch once things look good.
 
 Feel free to ping us at any step you need help using our communication channels.
+[Here](https://github.com/firstcontributions/first-contributions) is a good resource for complete beginners.
 
-## Collaborative Experimentation Guide
-If you like to use TTS to try a new idea and like to share your experiments with the community, we urge you to use the following guideline for a better collaboration.
-(If you have an idea for better collaboration, let us know)
-- Create a new branch.
-- Open an issue pointing your branch.
-- Explain your idea and experiment.
-- Share your results regularly. (Tensorboard log files, audio results, visuals etc.)
 
 ### Acknowledgement
 - https://github.com/keithito/tacotron (Dataset pre-processing)