Merge pull request #24 from idiap/coqui-refs

Update repository links, package names, release script

Author: eginhard

.github/workflows/pypi-release.yml

@@ -10,7 +10,7 @@ jobs:
   build-sdist:
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Verify tag matches version
         run: |
           set -ex
@@ -19,7 +19,7 @@ jobs:
           if [[ "v$version" != "$tag" ]]; then
             exit 1
           fi
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.9
       - run: |
@@ -28,7 +28,7 @@ jobs:
           python -m build
       - run: |
           pip install dist/*.tar.gz
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v4
         with:
           name: sdist
           path: dist/*.tar.gz
@@ -38,8 +38,8 @@ jobs:
       matrix:
         python-version: ["3.9", "3.10", "3.11"]
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install pip requirements
@@ -50,45 +50,38 @@ jobs:
         run: |
           python setup.py bdist_wheel --plat-name=manylinux1_x86_64
           python -m pip install dist/*-manylinux*.whl
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v4
         with:
           name: wheel-${{ matrix.python-version }}
           path: dist/*-manylinux*.whl
   publish-artifacts:
     runs-on: ubuntu-20.04
     needs: [build-sdist, build-wheels]
+    environment:
+      name: release
+      url: https://pypi.org/p/coqui-tts
+    permissions:
+      id-token: write
     steps:
       - run: |
           mkdir dist
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4
         with:
           name: "sdist"
           path: "dist/"
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4
         with:
           name: "wheel-3.9"
           path: "dist/"
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4
         with:
           name: "wheel-3.10"
           path: "dist/"
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4
         with:
           name: "wheel-3.11"
           path: "dist/"
       - run: |
           ls -lh dist/
-      - name: Setup PyPI config
-        run: |
-          cat << EOF > ~/.pypirc
-          [pypi]
-          username=__token__
-          password=${{ secrets.PYPI_TOKEN }}
-          EOF
-      - uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-      - run: |
-          python -m pip install twine
-      - run: |
-          twine upload --repository pypi dist/*
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/tests.yml

@@ -38,14 +38,14 @@ jobs:
           sudo apt-get install -y --no-install-recommends git make gcc
           make system-deps
       - name: Install/upgrade Python setup deps
-        run: python3 -m pip install --upgrade pip setuptools wheel uv
+        run: python3 -m pip install --upgrade pip setuptools wheel
       - name: Replace scarf urls
         if: contains(fromJSON('["data_tests", "inference_tests", "test_aux", "test_tts", "test_tts2", "test_xtts", "test_zoo0", "test_zoo1", "test_zoo2"]'), matrix.subset)
         run: |
           sed -i 's/https:\/\/coqui.gateway.scarf.sh\//https:\/\/github.com\/coqui-ai\/TTS\/releases\/download\//g' TTS/.models.json
       - name: Install TTS
         run: |
-          python3 -m uv pip install --system "TTS[all] @ ."
+          python3 -m pip install .[all]
           python3 setup.py egg_info
       - name: Unit tests
         run: make ${{ matrix.subset }}

CITATION.cff

@@ -10,8 +10,8 @@ authors:
 version: 1.4
 doi: 10.5281/zenodo.6334862
 license: "MPL-2.0"
-url: "https://www.coqui.ai"
-repository-code: "https://github.com/coqui-ai/TTS"
+url: "https://github.com/eginhard/coqui-tts"
+repository-code: "https://github.com/eginhard/coqui-tts"
 keywords:
   - machine learning
   - deep learning

CONTRIBUTING.md

@@ -2,7 +2,7 @@
 
 Welcome to the 🐸TTS!
 
-This repository is governed by [the Contributor Covenant Code of Conduct](https://github.com/coqui-ai/TTS/blob/main/CODE_OF_CONDUCT.md).
+This repository is governed by [the Contributor Covenant Code of Conduct](https://github.com/eginhard/coqui-tts/blob/main/CODE_OF_CONDUCT.md).
 
 ## Where to start.
 We welcome everyone who likes to contribute to 🐸TTS.
@@ -15,13 +15,13 @@ If you like to contribute code, squash a bug but if you don't know where to star
 
     You can pick something out of our road map. We keep the progess of the project in this simple issue thread. It has new model proposals or developmental updates etc.
 
-- [Github Issues Tracker](https://github.com/coqui-ai/TTS/issues)
+- [Github Issues Tracker](https://github.com/eginhard/coqui-tts/issues)
 
     This is a place to find feature requests, bugs.
 
     Issues with the ```good first issue``` tag are good place for beginners to take on.
 
-- ✨**PR**✨ [pages](https://github.com/coqui-ai/TTS/pulls) with the ```🚀new version``` tag.
+- ✨**PR**✨ [pages](https://github.com/eginhard/coqui-tts/pulls) with the ```🚀new version``` tag.
 
     We list all the target improvements for the next version. You can pick one of them and start contributing.
 
@@ -46,14 +46,14 @@ Let us know if you encounter a problem along the way.
 
 The following steps are tested on an Ubuntu system.
 
-1. Fork 🐸TTS[https://github.com/coqui-ai/TTS] by clicking the fork button at the top right corner of the project page.
+1. Fork 🐸TTS[https://github.com/eginhard/coqui-tts] by clicking the fork button at the top right corner of the project page.
 
 2. Clone 🐸TTS and add the main repo as a new remote named ```upstream```.
 
     ```bash
-    $ git clone git@github.com:<your Github name>/TTS.git
-    $ cd TTS
-    $ git remote add upstream https://github.com/coqui-ai/TTS.git
+    $ git clone git@github.com:<your Github name>/coqui-tts.git
+    $ cd coqui-tts
+    $ git remote add upstream https://github.com/eginhard/coqui-tts.git
     ```
 
 3. Install 🐸TTS for development.
@@ -105,7 +105,7 @@ The following steps are tested on an Ubuntu system.
 
     ```bash
     $ git fetch upstream
-    $ git rebase upstream/master
+    $ git rebase upstream/main
     # or for the development version
     $ git rebase upstream/dev
     ```
@@ -124,22 +124,22 @@ The following steps are tested on an Ubuntu system.
 
 13. Let's discuss until it is perfect. 💪
 
-    We might ask you for certain changes that would appear in the ✨**PR**✨'s page under 🐸TTS[https://github.com/coqui-ai/TTS/pulls].
+    We might ask you for certain changes that would appear in the ✨**PR**✨'s page under 🐸TTS[https://github.com/eginhard/coqui-tts/pulls].
 
 14. Once things look perfect, We merge it to the ```dev``` branch and make it ready for the next version.
 
 ## Development in Docker container
 
 If you prefer working within a Docker container as your development environment, you can do the following:
 
-1. Fork 🐸TTS[https://github.com/coqui-ai/TTS] by clicking the fork button at the top right corner of the project page.
+1. Fork 🐸TTS[https://github.com/eginhard/coqui-tts] by clicking the fork button at the top right corner of the project page.
 
 2. Clone 🐸TTS and add the main repo as a new remote named ```upsteam```.
 
     ```bash
-    $ git clone git@github.com:<your Github name>/TTS.git
-    $ cd TTS
-    $ git remote add upstream https://github.com/coqui-ai/TTS.git
+    $ git clone git@github.com:<your Github name>/coqui-tts.git
+    $ cd coqui-tts
+    $ git remote add upstream https://github.com/eginhard/coqui-tts.git
     ```
 
 3. Build the Docker Image as your development environment (it installs all of the dependencies for you):

README.md

@@ -26,7 +26,7 @@ ______________________________________________________________________
 [![Discord](https://img.shields.io/discord/1037326658807533628?color=%239B59B6&label=chat%20on%20discord)](https://discord.gg/5eXr5seRrv)
 [![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/eginhard/coqui-tts/blob/master/CODE_OF_CONDUCT.md)
+[![Covenant](https://camo.githubusercontent.com/7d620efaa3eac1c5b060ece5d6aacfcc8b81a74a04d05cd0398689c01c4463bb/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f436f6e7472696275746f72253230436f76656e616e742d76322e3025323061646f707465642d6666363962342e737667)](https://github.com/eginhard/coqui-tts/blob/main/CODE_OF_CONDUCT.md)
 [![Downloads](https://pepy.tech/badge/tts)](https://pepy.tech/project/tts)
 [![DOI](https://zenodo.org/badge/265612440.svg)](https://zenodo.org/badge/latestdoi/265612440)
 
@@ -62,7 +62,7 @@ Please use our dedicated channels for questions and discussion. Help is much mor
 | 💾 **Installation**               | [TTS/README.md](https://github.com/eginhard/coqui-tts/tree/dev#installation)|
 | 👩‍💻 **Contributing**               | [CONTRIBUTING.md](https://github.com/eginhard/coqui-tts/blob/main/CONTRIBUTING.md)|
 | 📌 **Road Map**                   | [Main Development Plans](https://github.com/coqui-ai/TTS/issues/378)
-| 🚀 **Released Models**            | [TTS Releases](https://github.com/coqui-ai/TTS/releases) and [Experimental Models](https://github.com/coqui-ai/TTS/wiki/Experimental-Released-Models)|
+| 🚀 **Released Models**            | [Standard models](https://github.com/eginhard/coqui-tts/blob/dev/TTS/.models.json) and [Fairseq models in ~1100 languages](https://github.com/eginhard/coqui-tts#example-text-to-speech-using-fairseq-models-in-1100-languages-)|
 | 📰 **Papers**                    | [TTS Papers](https://github.com/erogol/TTS-papers)|
 
 ## Features
@@ -135,7 +135,7 @@ You can also help us implement more models.
 If you are only interested in [synthesizing speech](https://coqui-tts.readthedocs.io/en/latest/inference.html) with the released 🐸TTS models, installing from PyPI is the easiest option.
 
 ```bash
-pip install TTS
+pip install coqui-tts
 ```
 
 If you plan to code or train models, clone 🐸TTS and install it locally.
@@ -152,7 +152,9 @@ $ make system-deps  # intended to be used on Ubuntu (Debian). Let us know if you
 $ 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).
+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)
+(note that these are out of date, e.g. you need to have at least Python 3.9).
 
 
 ## Docker Image

TTS/VERSION

@@ -1 +1 @@
-0.22.0
+0.22.1

TTS/server/README.md

@@ -1,8 +1,8 @@
 # :frog: TTS demo server
 Before you use the server, make sure you
-[install](https://github.com/coqui-ai/TTS/tree/dev#install-tts)) :frog: TTS
+[install](https://github.com/eginhard/coqui-tts/tree/dev#install-tts)) :frog: TTS
 properly and install the additional dependencies with `pip install
-TTS[server]`. Then, you can follow the steps below.
+coqui-tts[server]`. Then, you can follow the steps below.
 
 **Note:** If you install :frog:TTS using ```pip```, you can also use the ```tts-server``` end point on the terminal.
 

TTS/server/server.py

@@ -12,7 +12,7 @@
 try:
     from flask import Flask, render_template, render_template_string, request, send_file
 except ImportError as e:
-    raise ImportError("Server requires requires flask, use `pip install TTS[server]`.") from e
+    raise ImportError("Server requires requires flask, use `pip install coqui-tts[server]`.") from e
 
 from TTS.config import load_config
 from TTS.utils.manage import ModelManager

TTS/server/templates/index.html

@@ -30,7 +30,7 @@
 </head>
 
 <body>
-    <a href="https://github.com/coqui-ai/TTS"><img style="position: absolute; z-index:1000; top: 0; left: 0; border: 0;"
+    <a href="https://github.com/eginhard/coqui-tts"><img style="position: absolute; z-index:1000; top: 0; left: 0; border: 0;"
             src="https://s3.amazonaws.com/github/ribbons/forkme_left_darkblue_121621.png" alt="Fork me on GitHub"></a>
 
     <!-- Navigation -->
@@ -151,4 +151,4 @@
 
 </body>
 
-</html>
+</html>

TTS/tts/models/xtts.py

@@ -695,12 +695,12 @@ def inference_stream(
 
     def forward(self):
         raise NotImplementedError(
-            "XTTS has a dedicated trainer, please check the XTTS docs: https://tts.readthedocs.io/en/dev/models/xtts.html#training"
+            "XTTS has a dedicated trainer, please check the XTTS docs: https://coqui-tts.readthedocs.io/en/dev/models/xtts.html#training"
         )
 
     def eval_step(self):
         raise NotImplementedError(
-            "XTTS has a dedicated trainer, please check the XTTS docs: https://tts.readthedocs.io/en/dev/models/xtts.html#training"
+            "XTTS has a dedicated trainer, please check the XTTS docs: https://coqui-tts.readthedocs.io/en/dev/models/xtts.html#training"
         )
 
     @staticmethod
@@ -789,5 +789,5 @@ def load_checkpoint(
 
     def train_step(self):
         raise NotImplementedError(
-            "XTTS has a dedicated trainer, please check the XTTS docs: https://tts.readthedocs.io/en/dev/models/xtts.html#training"
+            "XTTS has a dedicated trainer, please check the XTTS docs: https://coqui-tts.readthedocs.io/en/dev/models/xtts.html#training"
         )

TTS/tts/utils/text/phonemizers/__init__.py

@@ -63,7 +63,7 @@ def get_phonemizer_by_name(name: str, **kwargs) -> BasePhonemizer:
         return ZH_CN_Phonemizer(**kwargs)
     if name == "ja_jp_phonemizer":
         if JA_JP_Phonemizer is None:
-            raise ValueError(" ❗ You need to install JA phonemizer dependencies. Try `pip install TTS[ja]`.")
+            raise ValueError(" ❗ You need to install JA phonemizer dependencies. Try `pip install coqui-tts[ja]`.")
         return JA_JP_Phonemizer(**kwargs)
     if name == "ko_kr_phonemizer":
         return KO_KR_Phonemizer(**kwargs)

docs/source/faq.md

@@ -3,7 +3,7 @@ We tried to collect common issues and questions we receive about 🐸TTS. It is
 
 ## Errors with a pre-trained model. How can I resolve this?
 - Make sure you use the right commit version of 🐸TTS. Each pre-trained model has its corresponding version that needs to be used. It is defined on the model table.
-- If it is still problematic, post your problem on [Discussions](https://github.com/coqui-ai/TTS/discussions). Please give as many details as possible (error message, your TTS version, your TTS model and config.json etc.)
+- If it is still problematic, post your problem on [Discussions](https://github.com/eginhard/coqui-tts/discussions). Please give as many details as possible (error message, your TTS version, your TTS model and config.json etc.)
 - If you feel like it's a bug to be fixed, then prefer Github issues with the same level of scrutiny.
 
 ## What are the requirements of a good 🐸TTS dataset?
@@ -16,7 +16,7 @@ We tried to collect common issues and questions we receive about 🐸TTS. It is
 - If you need faster models, consider SpeedySpeech, GlowTTS or AlignTTS. Keep in mind that SpeedySpeech requires a pre-trained Tacotron or Tacotron2 model to compute text-to-speech alignments.
 
 ## How can I train my own `tts` model?
-0. Check your dataset with notebooks in [dataset_analysis](https://github.com/coqui-ai/TTS/tree/master/notebooks/dataset_analysis) folder. Use [this notebook](https://github.com/coqui-ai/TTS/blob/master/notebooks/dataset_analysis/CheckSpectrograms.ipynb) to find the right audio processing parameters. A better set of parameters results in a better audio synthesis.
+0. Check your dataset with notebooks in [dataset_analysis](https://github.com/eginhard/coqui-tts/tree/main/notebooks/dataset_analysis) folder. Use [this notebook](https://github.com/eginhard/coqui-tts/blob/main/notebooks/dataset_analysis/CheckSpectrograms.ipynb) to find the right audio processing parameters. A better set of parameters results in a better audio synthesis.
 
 1. Write your own dataset `formatter` in `datasets/formatters.py` or format your dataset as one of the supported datasets, like LJSpeech.
     A `formatter` parses the metadata file and converts a list of training samples.

docs/source/inference.md

@@ -4,7 +4,7 @@
 First, you need to install TTS. We recommend using PyPi. You need to call the command below:
 
 ```bash
-$ pip install TTS
+$ pip install coqui-tts
 ```
 
 After the installation, 2 terminal commands are available.
@@ -14,7 +14,7 @@ After the installation, 2 terminal commands are available.
 3. In 🐍Python. - `from TTS.api import TTS`
 
 ## On the Commandline - `tts`
-![cli.gif](https://github.com/coqui-ai/TTS/raw/main/images/tts_cli.gif)
+![cli.gif](https://github.com/eginhard/coqui-tts/raw/main/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.
 
@@ -81,11 +81,11 @@ tts --model_name "voice_conversion/<language>/<dataset>/<model_name>"
 
 ## On the Demo Server - `tts-server`
 
- <!-- <img src="https://raw.githubusercontent.com/coqui-ai/TTS/main/images/demo_server.gif" height="56"/> -->
-![server.gif](https://github.com/coqui-ai/TTS/raw/main/images/demo_server.gif)
+ <!-- <img src="https://raw.githubusercontent.com/eginhard/coqui-tts/main/images/demo_server.gif" height="56"/> -->
+![server.gif](https://github.com/eginhard/coqui-tts/raw/main/images/demo_server.gif)
 
 You can boot up a demo 🐸TTS server to run an inference with your models (make
-sure to install the additional dependencies with `pip install TTS[server]`).
+sure to install the additional dependencies with `pip install coqui-tts[server]`).
 Note that the server is not optimized for performance but gives you an easy way
 to interact with the models.