Rebranding WIP

BIBLIOGRAPHY.md

@@ -1,5 +1,4 @@
-This file contains a list of papers in chronological order that have been published 
-using DeepSpeech.
+This file contains a list of papers in chronological order that have been published using 🐸STT.
 
 To appear
 ==========

CODE_OWNERS.rst

@@ -1,7 +1,7 @@
-DeepSpeech code owners / governance system
-==========================================
+Coqui STT code owners / governance system
+=========================================
 
-DeepSpeech is run under a governance system inspired (and partially copied from) by the `Mozilla module ownership system <https://www.mozilla.org/about/governance/policies/module-ownership/>`_. The project is roughly divided into modules, and each module has its own owners, which are responsible for reviewing pull requests and deciding on technical direction for their modules. Module ownership authority is given to people who have worked extensively on areas of the project.
+🐸STT is run under a governance system inspired (and partially copied from) by the `Mozilla module ownership system <https://www.mozilla.org/about/governance/policies/module-ownership/>`_. The project is roughly divided into modules, and each module has its own owners, which are responsible for reviewing pull requests and deciding on technical direction for their modules. Module ownership authority is given to people who have worked extensively on areas of the project.
 
 Module owners also have the authority of naming other module owners or appointing module peers, which are people with authority to review pull requests in that module. They can also sub-divide their module into sub-modules with their own owners.
 
@@ -46,7 +46,7 @@ Testing & CI
 Native inference client
 -----------------------
 
-Everything that goes into libdeepspeech.so and is not specifically covered in another area fits here.
+Everything that goes into libstt.so and is not specifically covered in another area fits here.
 
 - Alexandre Lissy (@lissyx)
 - Reuben Morais (@reuben)
@@ -110,7 +110,7 @@ Documentation
 - Alexandre Lissy (@lissyx)
 - Reuben Morais (@reuben)
 
-Third party bindings
---------------------
-
-Hosted externally and owned by the individual authors. See the `list of third-party bindings <https://deepspeech.readthedocs.io/en/master/USING.html#third-party-bindings>`_ for more info.
+.. Third party bindings
+   --------------------
+   
+   Hosted externally and owned by the individual authors. See the `list of third-party bindings <https://stt.readthedocs.io/en/latest/   USING.html#third-party-bindings>`_ for more info.

CONTRIBUTING.rst

@@ -1,14 +1,14 @@
 Contribution guidelines
 =======================
 
-Welcome to the DeepSpeech project! We are excited to see your interest, and appreciate your support!
+Welcome to the 🐸STT project! We are excited to see your interest, and appreciate your support!
 
 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/>`_.
 
 How to Make a Good Pull Request
 -------------------------------
 
-Here's some guidelines on how to make a good PR to DeepSpeech.
+Here's some guidelines on how to make a good PR to 🐸STT.
 
 Bug-fix PR
 ^^^^^^^^^^
@@ -18,20 +18,20 @@ You've found a bug and you were able to squash it! Great job! Please write a sho
 Documentation PR
 ^^^^^^^^^^^^^^^^
 
-If you're just making updates or changes to the documentation, there's no need to run all of DeepSpeech's tests for Continuous Integration (i.e. Taskcluster tests). In this case, at the end of your short but clear commit message, you should add **X-DeepSpeech: NOBUILD**. This will trigger the CI tests to skip your PR, saving both time and compute.
+If you're just making updates or changes to the documentation, there's no need to run all of 🐸STT's tests for Continuous Integration (i.e. Taskcluster tests). In this case, at the end of your short but clear commit message, you should add **X-DeepSpeech: NOBUILD**. This will trigger the CI tests to skip your PR, saving both time and compute.
 
 New Feature PR
 ^^^^^^^^^^^^^^
 
-You've made some core changes to DeepSpeech, and you would like to share them back with the community -- great! First things first: if you're planning to add a feature (not just fix a bug or docs) let the DeepSpeech team know ahead of time and get some feedback early. A quick check-in with the team can save time during code-review, and also ensure that your new feature fits into the project.
+You've made some core changes to 🐸STT, and you would like to share them back with the community -- great! First things first: if you're planning to add a feature (not just fix a bug or docs) let the 🐸STT team know ahead of time and get some feedback early. A quick check-in with the team can save time during code-review, and also ensure that your new feature fits into the project.
 
-The DeepSpeech codebase is made of many connected parts. There is Python code for training DeepSpeech, core C++ code for running inference on trained models, and multiple language bindings to the C++ core so you can use DeepSpeech in your favorite language.
+The 🐸STT codebase is made of many connected parts. There is Python code for training 🐸STT, core C++ code for running inference on trained models, and multiple language bindings to the C++ core so you can use 🐸STT in your favorite language.
 
-Whenever you add a new feature to DeepSpeech and what to contribute that feature back to the project, here are some things to keep in mind:
+Whenever you add a new feature to 🐸STT and what to contribute that feature back to the project, here are some things to keep in mind:
 
-1. You've made changes to the core C++ code. Core changes can have downstream effects on all parts of the DeepSpeech project, so keep that in mind. You should minimally also make necessary changes to the C client (i.e. **args.h** and **client.cc**). The bindings for Python, Java, and Javascript are SWIG generated, and in the best-case scenario you won't have to worry about them. However, if you've added a whole new feature, you may need to make custom tweaks to those bindings, because SWIG may not automagically work with your new feature, especially if you've exposed new arguments. The bindings for .NET and Swift are not generated automatically. It would be best if you also made the necessary manual changes to these bindings as well. It is best to communicate with the core DeepSpeech team and come to an understanding of where you will likely need to work with the bindings. They can't predict all the bugs you will run into, but they will have a good idea of how to plan for some obvious challenges.
+1. You've made changes to the core C++ code. Core changes can have downstream effects on all parts of the 🐸STT project, so keep that in mind. You should minimally also make necessary changes to the C client (i.e. **args.h** and **client.cc**). The bindings for Python, Java, and Javascript are SWIG generated, and in the best-case scenario you won't have to worry about them. However, if you've added a whole new feature, you may need to make custom tweaks to those bindings, because SWIG may not automagically work with your new feature, especially if you've exposed new arguments. The bindings for .NET and Swift are not generated automatically. It would be best if you also made the necessary manual changes to these bindings as well. It is best to communicate with the core 🐸STT team and come to an understanding of where you will likely need to work with the bindings. They can't predict all the bugs you will run into, but they will have a good idea of how to plan for some obvious challenges.
 2. You've made changes to the Python code. Make sure you run a linter (described below).
-3. Make sure your new feature doesn't regress the project. If you've added a significant feature or amount of code, you want to be sure your new feature doesn't create performance issues. For example, if you've made a change to the DeepSpeech decoder, you should know that inference performance doesn't drop in terms of latency, accuracy, or memory usage. Unless you're proposing a new decoding algorithm, you probably don't have to worry about affecting accuracy. However, it's very possible you've affected latency or memory usage. You should run local performance tests to make sure no bugs have crept in. There are lots of tools to check latency and memory usage, and you should use what is most comfortable for you and gets the job done. If you're on Linux, you might find [[perf](https://perf.wiki.kernel.org/index.php/Main_Page)] to be a useful tool. You can use sample WAV files for testing which are provided in the `DeepSpeech/data/` directory.
+3. Make sure your new feature doesn't regress the project. If you've added a significant feature or amount of code, you want to be sure your new feature doesn't create performance issues. For example, if you've made a change to the 🐸STT decoder, you should know that inference performance doesn't drop in terms of latency, accuracy, or memory usage. Unless you're proposing a new decoding algorithm, you probably don't have to worry about affecting accuracy. However, it's very possible you've affected latency or memory usage. You should run local performance tests to make sure no bugs have crept in. There are lots of tools to check latency and memory usage, and you should use what is most comfortable for you and gets the job done. If you're on Linux, you might find [[perf](https://perf.wiki.kernel.org/index.php/Main_Page)] to be a useful tool. You can use sample WAV files for testing which are provided in the `STT/data/` directory.
 
 Requesting review on your PR
 ----------------------------

Dockerfile.build.tmpl

@@ -3,8 +3,8 @@
 # Need devel version cause we need /usr/include/cudnn.h 
 FROM nvidia/cuda:10.1-cudnn7-devel-ubuntu18.04
 
-ENV DEEPSPEECH_REPO=#DEEPSPEECH_REPO#
-ENV DEEPSPEECH_SHA=#DEEPSPEECH_SHA#
+ENV STT_REPO=#STT_REPO#
+ENV STT_SHA=#STT_SHA#
 
 # >> START Install base software
 
@@ -113,15 +113,15 @@ RUN echo "build --spawn_strategy=standalone --genrule_strategy=standalone" \
 
 WORKDIR /
 
-RUN git clone --recursive $DEEPSPEECH_REPO DeepSpeech
-WORKDIR /DeepSpeech
-RUN git checkout $DEEPSPEECH_SHA
+RUN git clone --recursive $STT_REPO STT
+WORKDIR /STT
+RUN git checkout $STT_SHA
 RUN git submodule sync tensorflow/
 RUN git submodule update --init tensorflow/
 
 # >> START Build and bind
 
-WORKDIR /DeepSpeech/tensorflow
+WORKDIR /STT/tensorflow
 
 # Fix for not found script https://github.com/tensorflow/tensorflow/issues/471
 RUN ./configure
@@ -132,7 +132,7 @@ RUN ./configure
 
 # passing LD_LIBRARY_PATH is required cause Bazel doesn't pickup it from environment
 
-# Build DeepSpeech
+# Build STT
 RUN bazel build \
 	--workspace_status_command="bash native_client/bazel_workspace_status_cmd.sh" \
 	--config=monolithic \
@@ -149,22 +149,22 @@ RUN bazel build \
 	--copt=-msse4.2 \
 	--copt=-mavx \
 	--copt=-fvisibility=hidden \
-	//native_client:libdeepspeech.so \
+	//native_client:libstt.so \
 	--verbose_failures \
 	--action_env=LD_LIBRARY_PATH=${LD_LIBRARY_PATH}
 
-# Copy built libs to /DeepSpeech/native_client
-RUN cp bazel-bin/native_client/libdeepspeech.so /DeepSpeech/native_client/
+# Copy built libs to /STT/native_client
+RUN cp bazel-bin/native_client/libstt.so /STT/native_client/
 
 # Build client.cc and install Python client and decoder bindings
-ENV TFDIR /DeepSpeech/tensorflow
+ENV TFDIR /STT/tensorflow
 
 RUN nproc
 
-WORKDIR /DeepSpeech/native_client
-RUN make NUM_PROCESSES=$(nproc) deepspeech
+WORKDIR /STT/native_client
+RUN make NUM_PROCESSES=$(nproc) stt
 
-WORKDIR /DeepSpeech
+WORKDIR /STT
 RUN cd native_client/python && make NUM_PROCESSES=$(nproc) bindings
 RUN pip3 install --upgrade native_client/python/dist/*.whl
 
@@ -176,8 +176,8 @@ RUN pip3 install --upgrade native_client/ctcdecode/dist/*.whl
 # Allow Python printing utf-8
 ENV PYTHONIOENCODING UTF-8
 
-# Build KenLM in /DeepSpeech/native_client/kenlm folder
-WORKDIR /DeepSpeech/native_client
+# Build KenLM in /STT/native_client/kenlm folder
+WORKDIR /STT/native_client
 RUN rm -rf kenlm && \
 	git clone https://github.com/kpu/kenlm && \
 	cd kenlm && \
@@ -188,4 +188,4 @@ RUN rm -rf kenlm && \
 	make -j $(nproc)
 
 # Done
-WORKDIR /DeepSpeech
+WORKDIR /STT

Dockerfile.train.tmpl

@@ -3,8 +3,8 @@
 FROM tensorflow/tensorflow:1.15.4-gpu-py3
 ENV DEBIAN_FRONTEND=noninteractive
 
-ENV DEEPSPEECH_REPO=#DEEPSPEECH_REPO#
-ENV DEEPSPEECH_SHA=#DEEPSPEECH_SHA#
+ENV STT_REPO=#STT_REPO#
+ENV STT_SHA=#STT_SHA#
 
 RUN apt-get update && apt-get install -y --no-install-recommends \
         apt-utils \
@@ -20,7 +20,7 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
         unzip \
         wget
 
-# We need to remove it because it's breaking deepspeech install later with
+# We need to remove it because it's breaking STT install later with
 # weird errors about setuptools
 RUN apt-get purge -y python3-xdg
 
@@ -31,10 +31,10 @@ RUN apt-get install -y --no-install-recommends libopus0 libsndfile1
 RUN rm -rf /var/lib/apt/lists/*
 
 WORKDIR /
-RUN git clone $DEEPSPEECH_REPO DeepSpeech
+RUN git clone $STT_REPO STT
 
-WORKDIR /DeepSpeech
-RUN git checkout $DEEPSPEECH_SHA
+WORKDIR /STT
+RUN git checkout $STT_SHA
 
 # Build CTC decoder first, to avoid clashes on incompatible versions upgrades
 RUN cd native_client/ctcdecode && make NUM_PROCESSES=$(nproc) bindings
@@ -43,7 +43,7 @@ RUN pip3 install --upgrade native_client/ctcdecode/dist/*.whl
 # Prepare deps
 RUN pip3 install --upgrade pip==20.2.2 wheel==0.34.2 setuptools==49.6.0
 
-# Install DeepSpeech
+# Install STT
 #  - No need for the decoder since we did it earlier
 #  - There is already correct TensorFlow GPU installed on the base image,
 #    we don't want to break that
@@ -54,7 +54,7 @@ RUN python3 util/taskcluster.py --source tensorflow --branch r1.15 \
         --artifact convert_graphdef_memmapped_format  --target .
 
 # Build KenLM to generate new scorers
-WORKDIR /DeepSpeech/native_client
+WORKDIR /STT/native_client
 RUN rm -rf kenlm && \
 	git clone https://github.com/kpu/kenlm && \
 	cd kenlm && \
@@ -63,6 +63,6 @@ RUN rm -rf kenlm && \
 	cd build && \
 	cmake .. && \
 	make -j $(nproc)
-WORKDIR /DeepSpeech
+WORKDIR /STT
 
 RUN ./bin/run-ldc93s1.sh

GRAPH_VERSION

@@ -1 +1 @@
-training/deepspeech_training/GRAPH_VERSION
+training/coqui_stt_training/GRAPH_VERSION

Makefile

@@ -1,8 +1,8 @@
-DEEPSPEECH_REPO ?= https://github.com/mozilla/DeepSpeech.git
-DEEPSPEECH_SHA  ?= origin/master
+STT_REPO ?= https://github.com/coqui-ai/STT.git
+STT_SHA  ?= origin/main
 
 Dockerfile%: Dockerfile%.tmpl
 	sed \
-		-e "s|#DEEPSPEECH_REPO#|$(DEEPSPEECH_REPO)|g" \
-		-e "s|#DEEPSPEECH_SHA#|$(DEEPSPEECH_SHA)|g" \
+		-e "s|#STT_REPO#|$(STT_REPO)|g" \
+		-e "s|#STT_SHA#|$(STT_SHA)|g" \
 		< $< > $@

SUPPORT.rst

@@ -5,8 +5,8 @@ Contact/Getting Help
 
 There are several ways to contact us or to get help:
 
-#. `Discourse Forums <https://discourse.mozilla.org/c/deep-speech>`_ - The `Deep Speech category on Discourse <https://discourse.mozilla.org/c/deep-speech>`_ is the first place to look. Search for keywords related to your question or problem to see if someone else has run into it already. If you can't find anything relevant there, search on our `issue tracker <https://github.com/mozilla/deepspeech/issues>`_ to see if there is an existing issue about your problem.
+#. `GitHub Discussions <https://github.com/coqui-ai/STT/discussions>`_ - `GitHub Discussions <https://github.com/coqui-ai/STT/discussions>`_ is the first place to look. Search for keywords related to your question or problem to see if someone else has run into it already. If you can't find anything relevant there, search on our `issue tracker <https://github.com/coqui-ai/STT/issues>`_ to see if there is an existing issue about your problem.
 
-#. `Matrix chat <https://chat.mozilla.org/#/room/#machinelearning:mozilla.org>`_ - If your question is not addressed by either the `FAQ <https://github.com/mozilla/DeepSpeech/wiki#frequently-asked-questions>`_ or `Discourse Forums <https://discourse.mozilla.org/c/deep-speech>`_\ , you can contact us on the ``#machinelearning`` channel on `Mozilla Matrix <https://chat.mozilla.org/#/room/#machinelearning:mozilla.org>`_\ ; people there can try to answer/help
+#. `Matrix chat <https://matrix.to/#/+coqui:matrix.org>`_ - If your question is not addressed on `GitHub Discussions <https://github.com/coqui-ai/STT/discussions>`_\ , you can contact us on the ``#stt:matrix.org`` `channel on Matrix <https://matrix.to/#/#stt:matrix.org?via=matrix.org>`_.
 
-#. `Create a new issue <https://github.com/mozilla/deepspeech/issues>`_ - Finally, if you have a bug report or a feature request that isn't already covered by an existing issue, please open an issue in our repo and fill the appropriate information on your hardware and software setup.
+#. `Create a new issue <https://github.com/coqui-ai/STT/issues>`_ - Finally, if you have a bug report or a feature request that isn't already covered by an existing issue, please open an issue in our repo and fill the appropriate information on your hardware and software setup.

VERSION

@@ -1 +1 @@
-training/deepspeech_training/VERSION
+training/coqui_stt_training/VERSION

bin/compare_samples.py

@@ -6,8 +6,8 @@
 import argparse
 import numpy as np
 
-from deepspeech_training.util.audio import AUDIO_TYPE_NP, mean_dbfs
-from deepspeech_training.util.sample_collections import load_sample
+from coqui_stt_training.util.audio import AUDIO_TYPE_NP, mean_dbfs
+from coqui_stt_training.util.sample_collections import load_sample
 
 
 def fail(message):

bin/data_set_tool.py

@@ -8,20 +8,20 @@
 import progressbar
 from pathlib import Path
 
-from deepspeech_training.util.audio import (
+from coqui_stt_training.util.audio import (
     AUDIO_TYPE_PCM,
     AUDIO_TYPE_OPUS,
     AUDIO_TYPE_WAV,
     change_audio_types,
 )
-from deepspeech_training.util.downloader import SIMPLE_BAR
-from deepspeech_training.util.sample_collections import (
+from coqui_stt_training.util.downloader import SIMPLE_BAR
+from coqui_stt_training.util.sample_collections import (
     CSVWriter,
     DirectSDBWriter,
     TarWriter,
     samples_from_sources,
 )
-from deepspeech_training.util.augmentations import (
+from coqui_stt_training.util.augmentations import (
     parse_augmentations,
     apply_sample_augmentations,
     SampleAugmentation

bin/import_aidatatang.py

@@ -5,7 +5,7 @@
 
 import pandas
 
-from deepspeech_training.util.importers import get_importers_parser
+from coqui_stt_training.util.importers import get_importers_parser
 
 COLUMN_NAMES = ["wav_filename", "wav_filesize", "transcript"]
 

bin/import_aishell.py

@@ -5,7 +5,7 @@
 
 import pandas
 
-from deepspeech_training.util.importers import get_importers_parser
+from coqui_stt_training.util.importers import get_importers_parser
 
 COLUMNNAMES = ["wav_filename", "wav_filesize", "transcript"]
 

bin/import_ccpmf.py

@@ -30,9 +30,9 @@
 import requests
 import json
 
-from deepspeech_training.util.downloader import SIMPLE_BAR, maybe_download
-from deepspeech_training.util.helpers import secs_to_hours
-from deepspeech_training.util.importers import (
+from coqui_stt_training.util.downloader import SIMPLE_BAR, maybe_download
+from coqui_stt_training.util.helpers import secs_to_hours
+from coqui_stt_training.util.importers import (
     get_counter,
     get_importers_parser,
     get_imported_samples,