Merge pull request #1 from idiap/update-docs

Update links and Github actions
idiap · Apr 5, 2024 · e626a29 · e626a29
2 parents a4ca02b + 31f1c8b
commit e626a29
Show file tree

Hide file tree

Showing 14 changed files with 57 additions and 56 deletions.
diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml
@@ -10,15 +10,15 @@ on:
 jobs:
   docker-build:
     name: "Build and push Docker image"
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         arch: ["amd64"]
         base:
         - "nvidia/cuda:11.8.0-base-ubuntu22.04" # GPU enabled
         - "python:3.10.8-slim" # CPU only
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Log in to the Container registry
         uses: docker/login-action@v1
         with:
@@ -29,11 +29,11 @@ jobs:
         id: compute-tag
         run: |
           set -ex
-          base="ghcr.io/coqui-ai/tts"
+          base="ghcr.io/idiap/coqui-tts"
           tags="" # PR build
 
           if [[ ${{ matrix.base }} = "python:3.10.8-slim" ]]; then
-            base="ghcr.io/coqui-ai/tts-cpu"
+            base="ghcr.io/idiap/coqui-tts-cpu"
           fi
 
           if [[ "${{ startsWith(github.ref, 'refs/heads/') }}" = "true" ]]; then

diff --git a/.github/workflows/pypi-release.yml b/.github/workflows/pypi-release.yml
@@ -8,7 +8,7 @@ defaults:
       bash
 jobs:
   build-sdist:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - name: Verify tag matches version
@@ -33,7 +33,7 @@ jobs:
           name: sdist
           path: dist/*.tar.gz
   build-wheels:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: ["3.9", "3.10", "3.11"]
@@ -55,7 +55,7 @@ jobs:
           name: wheel-${{ matrix.python-version }}
           path: dist/*-manylinux*.whl
   publish-artifacts:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     needs: [build-sdist, build-wheels]
     environment:
       name: release

diff --git a/.github/workflows/style_check.yml b/.github/workflows/style_check.yml
@@ -15,9 +15,9 @@ jobs:
         python-version: [3.9]
         experimental: [false]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           architecture: x64

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

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,7 +2,7 @@
 
 Welcome to the 🐸TTS!
 
-This repository is governed by [the Contributor Covenant Code of Conduct](https://github.com/eginhard/coqui-tts/blob/main/CODE_OF_CONDUCT.md).
+This repository is governed by [the Contributor Covenant Code of Conduct](https://github.com/idiap/coqui-ai-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/eginhard/coqui-tts/issues)
+- [Github Issues Tracker](https://github.com/idiap/coqui-ai-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/eginhard/coqui-tts/pulls) with the ```🚀new version``` tag.
+- ✨**PR**✨ [pages](https://github.com/idiap/coqui-ai-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/eginhard/coqui-tts] by clicking the fork button at the top right corner of the project page.
+1. Fork 🐸TTS[https://github.com/idiap/coqui-ai-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 [email protected]:<your Github name>/coqui-tts.git
-    $ cd coqui-tts
-    $ git remote add upstream https://github.com/eginhard/coqui-tts.git
+    $ git clone [email protected]:<your Github name>/coqui-ai-TTS.git
+    $ cd coqui-ai-TTS
+    $ git remote add upstream https://github.com/idiap/coqui-ai-TTS.git
     ```
 
 3. Install 🐸TTS for development.
@@ -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/eginhard/coqui-tts/pulls].
+    We might ask you for certain changes that would appear in the ✨**PR**✨'s page under 🐸TTS[https://github.com/idiap/coqui-ai-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/eginhard/coqui-tts] by clicking the fork button at the top right corner of the project page.
+1. Fork 🐸TTS[https://github.com/idiap/coqui-ai-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 [email protected]:<your Github name>/coqui-tts.git
-    $ cd coqui-tts
-    $ git remote add upstream https://github.com/eginhard/coqui-tts.git
+    $ git clone [email protected]:<your Github name>/coqui-ai-TTS.git
+    $ cd coqui-ai-TTS
+    $ git remote add upstream https://github.com/idiap/coqui-ai-TTS.git
     ```
 
 3. Build the Docker Image as your development environment (it installs all of the dependencies for you):

diff --git a/README.md b/README.md
@@ -1,7 +1,8 @@
 
-## 🐸Coqui.ai News
+## 🐸Coqui TTS News
+- 📣 Fork of the [original, unmaintained repository](https://github.com/coqui-ai/TTS). New PyPI package: [coqui-tts](https://pypi.org/project/coqui-tts)
 - 📣 ⓍTTSv2 is here with 16 languages and better performance across the board.
-- 📣 ⓍTTS fine-tuning code is out. Check the [example recipes](https://github.com/eginhard/coqui-tts/tree/dev/recipes/ljspeech).
+- 📣 ⓍTTS fine-tuning code is out. Check the [example recipes](https://github.com/idiap/coqui-ai-TTS/tree/dev/recipes/ljspeech).
 - 📣 ⓍTTS can now stream with <200ms latency.
 - 📣 ⓍTTS, our production TTS model that can speak 13 languages, is released [Blog Post](https://coqui.ai/blog/tts/open_xtts), [Demo](https://huggingface.co/spaces/coqui/xtts), [Docs](https://coqui-tts.readthedocs.io/en/dev/models/xtts.html)
 - 📣 [🐶Bark](https://github.com/suno-ai/bark) is now available for inference with unconstrained voice cloning. [Docs](https://coqui-tts.readthedocs.io/en/dev/models/bark.html)
@@ -11,7 +12,7 @@
 <div align="center">
 <img src="https://static.scarf.sh/a.png?x-pxid=cf317fe7-2188-4721-bc01-124bb5d5dbb2" />
 
-## <img src="https://raw.githubusercontent.com/eginhard/coqui-tts/main/images/coqui-log-green-TTS.png" height="56"/>
+## <img src="https://raw.githubusercontent.com/idiap/coqui-ai-TTS/main/images/coqui-log-green-TTS.png" height="56"/>
 
 
 **🐸TTS is a library for advanced Text-to-Speech generation.**
@@ -26,13 +27,13 @@ ______________________________________________________________________
 [![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/main/CODE_OF_CONDUCT.md)
+[![Covenant](https://camo.githubusercontent.com/7d620efaa3eac1c5b060ece5d6aacfcc8b81a74a04d05cd0398689c01c4463bb/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f436f6e7472696275746f72253230436f76656e616e742d76322e3025323061646f707465642d6666363962342e737667)](https://github.com/idiap/coqui-ai-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)
 
-![GithubActions](https://github.com/eginhard/coqui-tts/actions/workflows/tests.yml/badge.svg)
-![GithubActions](https://github.com/eginhard/coqui-tts/actions/workflows/docker.yaml/badge.svg)
-![GithubActions](https://github.com/eginhard/coqui-tts/actions/workflows/style_check.yml/badge.svg)
+![GithubActions](https://github.com/idiap/coqui-ai-TTS/actions/workflows/tests.yml/badge.svg)
+![GithubActions](https://github.com/idiap/coqui-ai-TTS/actions/workflows/docker.yaml/badge.svg)
+![GithubActions](https://github.com/idiap/coqui-ai-TTS/actions/workflows/style_check.yml/badge.svg)
 [![Docs](<https://readthedocs.org/projects/coqui-tts/badge/?version=latest&style=plastic>)](https://coqui-tts.readthedocs.io/en/latest/)
 
 </div>
@@ -49,8 +50,8 @@ Please use our dedicated channels for questions and discussion. Help is much mor
 | 👩‍💻 **Usage Questions**          | [GitHub Discussions]                    |
 | 🗯 **General Discussion**       | [GitHub Discussions] or [Discord]   |
 
-[github issue tracker]: https://github.com/eginhard/coqui-tts/issues
-[github discussions]: https://github.com/eginhard/coqui-tts/discussions
+[github issue tracker]: https://github.com/idiap/coqui-ai-TTS/issues
+[github discussions]: https://github.com/idiap/coqui-ai-TTS/discussions
 [discord]: https://discord.gg/5eXr5seRrv
 [Tutorials and Examples]: https://github.com/coqui-ai/TTS/wiki/TTS-Notebooks-and-Tutorials
 
@@ -59,10 +60,10 @@ Please use our dedicated channels for questions and discussion. Help is much mor
 | Type                            | Links                               |
 | ------------------------------- | --------------------------------------- |
 | 💼 **Documentation**              | [ReadTheDocs](https://coqui-tts.readthedocs.io/en/latest/)
-| 💾 **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)|
+| 💾 **Installation**               | [TTS/README.md](https://github.com/idiap/coqui-ai-TTS/tree/dev#installation)|
+| 👩‍💻 **Contributing**               | [CONTRIBUTING.md](https://github.com/idiap/coqui-ai-TTS/blob/main/CONTRIBUTING.md)|
 | 📌 **Road Map**                   | [Main Development Plans](https://github.com/coqui-ai/TTS/issues/378)
-| 🚀 **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-)|
+| 🚀 **Released Models**            | [Standard models](https://github.com/idiap/coqui-ai-TTS/blob/dev/TTS/.models.json) and [Fairseq models in ~1100 languages](https://github.com/idiap/coqui-ai-TTS#example-text-to-speech-using-fairseq-models-in-1100-languages-)|
 | 📰 **Papers**                    | [TTS Papers](https://github.com/erogol/TTS-papers)|
 
 ## Features
@@ -130,7 +131,7 @@ Please use our dedicated channels for questions and discussion. Help is much mor
 You can also help us implement more models.
 
 ## Installation
-🐸TTS is tested on Ubuntu 18.04 with **python >= 3.9, < 3.12.**.
+🐸TTS is tested on Ubuntu 22.04 with **python >= 3.9, < 3.12.**.
 
 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.
 
@@ -141,7 +142,7 @@ pip install coqui-tts
 If you plan to code or train models, clone 🐸TTS and install it locally.
 
 ```bash
-git clone https://github.com/eginhard/coqui-tts
+git clone https://github.com/idiap/coqui-ai-TTS
 pip install -e .[all,dev,notebooks,server]  # Select the relevant extras
 ```
 

diff --git a/TTS/server/README.md b/TTS/server/README.md
@@ -1,6 +1,6 @@
 # :frog: TTS demo server
 Before you use the server, make sure you
-[install](https://github.com/eginhard/coqui-tts/tree/dev#install-tts)) :frog: TTS
+[install](https://github.com/idiap/coqui-ai-TTS/tree/dev#install-tts)) :frog: TTS
 properly and install the additional dependencies with `pip install
 coqui-tts[server]`. Then, you can follow the steps below.
 

diff --git a/TTS/server/templates/index.html b/TTS/server/templates/index.html
@@ -30,7 +30,7 @@
 </head>
 
 <body>
-    <a href="https://github.com/eginhard/coqui-tts"><img style="position: absolute; z-index:1000; top: 0; left: 0; border: 0;"
+    <a href="https://github.com/idiap/coqui-ai-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 -->

diff --git a/docs/source/faq.md b/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/eginhard/coqui-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/idiap/coqui-ai-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/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.
+0. Check your dataset with notebooks in [dataset_analysis](https://github.com/idiap/coqui-ai-TTS/tree/main/notebooks/dataset_analysis) folder. Use [this notebook](https://github.com/idiap/coqui-ai-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.

diff --git a/docs/source/inference.md b/docs/source/inference.md
@@ -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/eginhard/coqui-tts/raw/main/images/tts_cli.gif)
+![cli.gif](https://github.com/idiap/coqui-ai-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,8 +81,8 @@ tts --model_name "voice_conversion/<language>/<dataset>/<model_name>"
 
 ## On the Demo Server - `tts-server`
 
- <!-- <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)
+ <!-- <img src="https://raw.githubusercontent.com/idiap/coqui-ai-TTS/main/images/demo_server.gif" height="56"/> -->
+![server.gif](https://github.com/idiap/coqui-ai-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 coqui-tts[server]`).

diff --git a/docs/source/installation.md b/docs/source/installation.md
@@ -15,16 +15,16 @@ pip install coqui-tts  # from PyPI
 Or install from Github:
 
 ```bash
-pip install git+https://github.com/eginhard/coqui-tts  # from Github
+pip install git+https://github.com/idiap/coqui-ai-TTS  # from Github
 ```
 
 ## Installing From Source
 
 This is recommended for development and more control over 🐸TTS.
 
 ```bash
-git clone https://github.com/eginhard/coqui-tts
-cd coqui-tts
+git clone https://github.com/idiap/coqui-ai-TTS
+cd coqui-ai-TTS
 make system-deps  # only on Linux systems.
 make install
 ```

diff --git a/docs/source/models/xtts.md b/docs/source/models/xtts.md
@@ -29,7 +29,7 @@ Stay tuned as we continue to add support for more languages. If you have any lan
 This model is licensed under [Coqui Public Model License](https://coqui.ai/cpml).
 
 ### Contact
-Come and join in our 🐸Community. We're active on [Discord](https://discord.gg/fBC58unbKE) and [Github](https://github.com/eginhard/coqui-tts/discussions).
+Come and join in our 🐸Community. We're active on [Discord](https://discord.gg/fBC58unbKE) and [Github](https://github.com/idiap/coqui-ai-TTS/discussions).
 
 ### Inference
 

diff --git a/docs/source/tutorial_for_nervous_beginners.md b/docs/source/tutorial_for_nervous_beginners.md
@@ -11,8 +11,8 @@ $ pip install coqui-tts
 Developer friendly installation.
 
 ```bash
-$ git clone https://github.com/eginhard/coqui-tts
-$ cd coqui-tts
+$ git clone https://github.com/idiap/coqui-ai-TTS
+$ cd coqui-ai-TTS
 $ pip install -e .
 ```
 
@@ -109,7 +109,7 @@ $ tts -h # see the help
 $ tts --list_models  # list the available models.
 ```
 
-![cli.gif](https://github.com/eginhard/coqui-tts/raw/main/images/tts_cli.gif)
+![cli.gif](https://github.com/idiap/coqui-ai-TTS/raw/main/images/tts_cli.gif)
 
 
 You can call `tts-server` to start a local demo server that you can open on
@@ -120,4 +120,4 @@ dependencies with `pip install coqui-tts[server]`).
 $ tts-server -h # see the help
 $ tts-server --list_models  # list the available models.
 ```
-![server.gif](https://github.com/eginhard/coqui-tts/raw/main/images/demo_server.gif)
+![server.gif](https://github.com/idiap/coqui-ai-TTS/raw/main/images/demo_server.gif)
diff --git a/setup.py b/setup.py
@@ -81,7 +81,7 @@ def pip_install(package_name):
 setup(
     name="coqui-tts",
     version=version,
-    url="https://github.com/eginhard/coqui-tts",
+    url="https://github.com/idiap/coqui-ai-TTS",
     author="Eren Gölge",
     author_email="[email protected]",
     maintainer="Enno Hermann",
@@ -104,9 +104,9 @@ def pip_install(package_name):
     },
     project_urls={
         "Documentation": "https://coqui-tts.readthedocs.io",
-        "Tracker": "https://github.com/eginhard/coqui-tts/issues",
-        "Repository": "https://github.com/eginhard/coqui-tts",
-        "Discussions": "https://github.com/eginhard/coqui-tts/discussions",
+        "Tracker": "https://github.com/idiap/coqui-ai-TTS/issues",
+        "Repository": "https://github.com/idiap/coqui-ai-TTS",
+        "Discussions": "https://github.com/idiap/coqui-ai-TTS/discussions",
     },
     cmdclass={
         "build_py": build_py,