Rename DeepSpeech -> STT

ISSUE_TEMPLATE.md

@@ -1,4 +1,4 @@
-For support and discussions, please use our [Discourse forums](https://discourse.mozilla.org/c/deep-speech).
+For support and discussions, please use our [Discourse forums](https://discourse.mozilla.org/c/mozilla-voice-stt).
 
 If you've found a bug, or have a feature request, then please create an issue with the following information:
 

Makefile

@@ -1,4 +1,4 @@
-MOZILLA_VOICE_STT_REPO ?= https://github.com/mozilla/DeepSpeech.git
+MOZILLA_VOICE_STT_REPO ?= https://github.com/mozilla/STT.git
 MOZILLA_VOICE_STT_SHA  ?= origin/master
 
 Dockerfile%: Dockerfile%.tmpl

README.rst

@@ -7,16 +7,16 @@ Mozilla Voice STT
    :alt: Documentation
 
 
-.. image:: https://community-tc.services.mozilla.com/api/github/v1/repository/mozilla/DeepSpeech/master/badge.svg
-   :target: https://community-tc.services.mozilla.com/api/github/v1/repository/mozilla/DeepSpeech/master/latest
+.. image:: https://community-tc.services.mozilla.com/api/github/v1/repository/mozilla/STT/master/badge.svg
+   :target: https://community-tc.services.mozilla.com/api/github/v1/repository/mozilla/STT/master/latest
    :alt: Task Status
 
 
 Mozilla Voice STT is an open source Speech-To-Text engine, using a model trained by machine learning techniques based on `Baidu's Deep Speech research paper <https://arxiv.org/abs/1412.5567>`_. Mozilla Voice STT uses Google's `TensorFlow <https://www.tensorflow.org/>`_ to make the implementation easier.
 
 Documentation for installation, usage, and training models are available on `deepspeech.readthedocs.io <http://deepspeech.readthedocs.io/?badge=latest>`_.
 
-For the latest release, including pre-trained models and checkpoints, `see the latest release on GitHub <https://github.com/mozilla/DeepSpeech/releases/latest>`_.
+For the latest release, including pre-trained models and checkpoints, `see the latest release on GitHub <https://github.com/mozilla/STT/releases/latest>`_.
 
 For contribution guidelines, see `CONTRIBUTING.rst <CONTRIBUTING.rst>`_.
 

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.
+#. `Discourse Forums <https://discourse.mozilla.org/c/mozilla-voice-stt>`_ - The `Deep Speech category on Discourse <https://discourse.mozilla.org/c/mozilla-voice-stt>`_ 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/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://chat.mozilla.org/#/room/#machinelearning:mozilla.org>`_ - If your question is not addressed by either the `FAQ <https://github.com/mozilla/STT/wiki#frequently-asked-questions>`_ or `Discourse Forums <https://discourse.mozilla.org/c/mozilla-voice-stt>`_\ , 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
 
-#. `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/mozilla/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.

doc/BUILDING.rst

@@ -37,7 +37,7 @@ Clone Mozilla Voice STT source code (TensorFlow will come as a submdule):
 
 .. code-block::
 
-   git clone https://github.com/mozilla/DeepSpeech.git
+   git clone https://github.com/mozilla/STT.git
    git submodule sync tensorflow/
    git submodule update --init tensorflow/
 

doc/Decoder.rst

@@ -22,7 +22,7 @@ The use of an external scorer is fully optional. When an external scorer is not
 
 Currently, the Mozilla Voice STT external scorer is implemented with `KenLM <https://kheafield.com/code/kenlm/>`_, plus some tooling to package the necessary files and metadata into a single ``.scorer`` package. The tooling lives in ``data/lm/``. The scripts included in ``data/lm/`` can be used and modified to build your own language model based on your particular use case or language. See :ref:`scorer-scripts` for more details on how to reproduce our scorer file as well as create your own.
 
-The scripts are geared towards replicating the language model files we release as part of `Mozilla Voice STT model releases <https://github.com/mozilla/DeepSpeech/releases/latest>`_, but modifying them to use different datasets or language model construction parameters should be simple.
+The scripts are geared towards replicating the language model files we release as part of `Mozilla Voice STT model releases <https://github.com/mozilla/STT/releases/latest>`_, but modifying them to use different datasets or language model construction parameters should be simple.
 
 
 Decoding modes

doc/Scorer.rst

@@ -7,7 +7,7 @@ Mozilla Voice STT pre-trained models include an external scorer. This document e
 
 The scorer is composed of two sub-components, a KenLM language model and a trie data structure containing all words in the vocabulary. In order to create the scorer package, first we must create a KenLM language model (using ``data/lm/generate_lm.py``, and then use ``generate_scorer_package`` to create the final package file including the trie data structure.
 
-The ``generate_scorer_package`` binary is part of the native client package that is included with official releases. You can find the appropriate archive for your platform in the `GitHub release downloads <https://github.com/mozilla/DeepSpeech/releases/latest>`_. The native client package is named ``native_client.{arch}.{config}.{plat}.tar.xz``, where ``{arch}`` is the architecture the binary was built for, for example ``amd64`` or ``arm64``, ``config`` is the build configuration, which for building decoder packages does not matter, and ``{plat}`` is the platform the binary was built-for, for example ``linux`` or ``osx``. If you wanted to run the ``generate_scorer_package`` binary on a Linux desktop, you would download ``native_client.amd64.cpu.linux.tar.xz``.
+The ``generate_scorer_package`` binary is part of the native client package that is included with official releases. You can find the appropriate archive for your platform in the `GitHub release downloads <https://github.com/mozilla/STT/releases/latest>`_. The native client package is named ``native_client.{arch}.{config}.{plat}.tar.xz``, where ``{arch}`` is the architecture the binary was built for, for example ``amd64`` or ``arm64``, ``config`` is the build configuration, which for building decoder packages does not matter, and ``{plat}`` is the platform the binary was built-for, for example ``linux`` or ``osx``. If you wanted to run the ``generate_scorer_package`` binary on a Linux desktop, you would download ``native_client.amd64.cpu.linux.tar.xz``.
 
 Reproducing our external scorer
 -------------------------------
@@ -44,7 +44,7 @@ Afterwards you can use ``generate_scorer_package`` to generate the scorer packag
 
     cd data/lm
     # Download and extract appropriate native_client package:
-    curl -LO http://github.com/mozilla/DeepSpeech/releases/...
+    curl -LO http://github.com/mozilla/STT/releases/...
     tar xvf native_client.*.tar.xz
     ./generate_scorer_package --alphabet ../alphabet.txt --lm lm.binary --vocab vocab-500000.txt \
       --package kenlm.scorer --default_alpha 0.931289039105002 --default_beta 1.1834137581510284

doc/TRAINING.rst

@@ -16,7 +16,7 @@ Clone the Mozilla Voice STT repository:
 
 .. code-block:: bash
 
-   git clone https://github.com/mozilla/DeepSpeech
+   git clone https://github.com/mozilla/STT
 
 Creating a virtual environment
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

doc/USING.rst

@@ -33,12 +33,12 @@ The CUDA capable builds (Python, NodeJS, C++, etc) depend on CUDA 10.1 and CuDNN
 Getting the pre-trained model
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-If you want to use the pre-trained English model for performing speech-to-text, you can download it (along with other important inference material) from the Mozilla Voice STT `releases page <https://github.com/mozilla/DeepSpeech/releases>`_. Alternatively, you can run the following command to download the model files in your current directory:
+If you want to use the pre-trained English model for performing speech-to-text, you can download it (along with other important inference material) from the Mozilla Voice STT `releases page <https://github.com/mozilla/STT/releases>`_. Alternatively, you can run the following command to download the model files in your current directory:
 
 .. code-block:: bash
 
-   wget https://github.com/mozilla/DeepSpeech/releases/download/v0.7.4/deepspeech-0.7.4-models.pbmm
-   wget https://github.com/mozilla/DeepSpeech/releases/download/v0.7.4/deepspeech-0.7.4-models.scorer
+   wget https://github.com/mozilla/STT/releases/download/v0.8.1/deepspeech-0.8.1-models.pbmm
+   wget https://github.com/mozilla/STT/releases/download/v0.8.1/deepspeech-0.8.1-models.scorer
 
 There are several pre-trained model files available in official releases. Files ending in ``.pbmm`` are compatible with clients and language bindings built against the standard TensorFlow runtime. Usually these packages are simply called ``mozilla_voice_stt``. These files are also compatible with CUDA enabled clients and language bindings. These packages are usually called ``mozilla_voice_stt_cuda``. Files ending in ``.tflite`` are compatible with clients and language bindings built against the `TensorFlow Lite runtime <https://www.tensorflow.org/lite/>`_. These models are optimized for size and performance in low power devices. On desktop platforms, the compatible packages are called ``mozilla_voice_stt_tflite``. On Android and Raspberry Pi, we only publish TensorFlow Lite enabled packages, and they are simply called ``mozilla_voice_stt``. You can see a full list of supported platforms and which TensorFlow runtime is supported at :ref:`supported-platforms-inference`.
 
@@ -122,7 +122,7 @@ Alternatively, if you have a supported NVIDIA GPU on Linux, you can install the
 
    $ pip3 install mozilla_voice_stt_cuda
 
-See the `release notes <https://github.com/mozilla/DeepSpeech/releases>`_ to find which GPUs are supported. Please ensure you have the required `CUDA dependency <#cuda-dependency>`_.
+See the `release notes <https://github.com/mozilla/STT/releases>`_ to find which GPUs are supported. Please ensure you have the required `CUDA dependency <#cuda-dependency>`_.
 
 You can update ``mozilla_voice_stt_cuda`` as follows:
 
@@ -136,7 +136,7 @@ Note: the following command assumes you `downloaded the pre-trained model <#gett
 
 .. code-block:: bash
 
-   mozilla_voice_stt --model deepspeech-0.7.4-models.pbmm --scorer deepspeech-0.7.4-models.scorer --audio my_audio_file.wav
+   mozilla_voice_stt --model deepspeech-0.8.1-models.pbmm --scorer deepspeech-0.8.1-models.scorer --audio my_audio_file.wav
 
 The ``--scorer`` argument is optional, and represents an external language model to be used when transcribing the audio.
 
@@ -165,7 +165,7 @@ Alternatively, if you're using Linux and have a supported NVIDIA GPU, you can in
 
    npm install @mozilla-voice/stt-cuda
 
-See the `release notes <https://github.com/mozilla/DeepSpeech/releases>`_ to find which GPUs are supported. Please ensure you have the required `CUDA dependency <#cuda-dependency>`_.
+See the `release notes <https://github.com/mozilla/STT/releases>`_ to find which GPUs are supported. Please ensure you have the required `CUDA dependency <#cuda-dependency>`_.
 
 See the :ref:`TypeScript client <js-api-example>` for an example of how to use the bindings programatically.
 
@@ -194,13 +194,13 @@ also, if you need some binaries different than current master, like ``v0.2.0-alp
 
 The script ``taskcluster.py`` will download ``native_client.tar.xz`` (which includes the ``mozilla_voice_stt`` binary and associated libraries) and extract it into the current folder. Also, ``taskcluster.py`` will download binaries for Linux/x86_64 by default, but you can override that behavior with the ``--arch`` parameter. See the help info with ``python util/taskcluster.py -h`` for more details. Specific branches of Mozilla Voice STT or TensorFlow can be specified as well.
 
-Alternatively you may manually download the ``native_client.tar.xz`` from the [releases](https://github.com/mozilla/DeepSpeech/releases).
+Alternatively you may manually download the ``native_client.tar.xz`` from the [releases](https://github.com/mozilla/STT/releases).
 
 Note: the following command assumes you `downloaded the pre-trained model <#getting-the-pre-trained-model>`_.
 
 .. code-block:: bash
 
-   ./mozilla_voice_stt --model deepspeech-0.7.4-models.pbmm --scorer deepspeech-0.7.4-models.scorer --audio audio_input.wav
+   ./mozilla_voice_stt --model deepspeech-0.8.1-models.pbmm --scorer deepspeech-0.8.1-models.scorer --audio audio_input.wav
 
 See the help output with ``./mozilla_voice_stt -h`` for more details.
 

doc/conf.py

@@ -202,5 +202,5 @@
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'https://docs.python.org/': None}
 
-extlinks = {'github': ('https://github.com/mozilla/DeepSpeech/blob/v{}/%s'.format(release),
+extlinks = {'github': ('https://github.com/mozilla/STT/blob/v{}/%s'.format(release),
                       '%s')}

doc/index.rst

@@ -20,19 +20,19 @@ To install and use Mozilla Voice STT all you have to do is:
    pip3 install mozilla_voice_stt
 
    # Download pre-trained English model files
-   curl -LO https://github.com/mozilla/DeepSpeech/releases/download/v0.7.4/deepspeech-0.7.4-models.pbmm
-   curl -LO https://github.com/mozilla/DeepSpeech/releases/download/v0.7.4/deepspeech-0.7.4-models.scorer
+   curl -LO https://github.com/mozilla/STT/releases/download/v0.8.1/deepspeech-0.8.1-models.pbmm
+   curl -LO https://github.com/mozilla/STT/releases/download/v0.8.1/deepspeech-0.8.1-models.scorer
 
    # Download example audio files
-   curl -LO https://github.com/mozilla/DeepSpeech/releases/download/v0.7.4/audio-0.7.4.tar.gz
-   tar xvf audio-0.7.4.tar.gz
+   curl -LO https://github.com/mozilla/STT/releases/download/v0.8.1/audio-0.8.1.tar.gz
+   tar xvf audio-0.8.1.tar.gz
 
    # Transcribe an audio file
-   mozilla_voice_stt --model deepspeech-0.7.4-models.pbmm --scorer deepspeech-0.7.4-models.scorer --audio audio/2830-3980-0043.wav
+   mozilla_voice_stt --model deepspeech-0.8.1-models.pbmm --scorer deepspeech-0.8.1-models.scorer --audio audio/2830-3980-0043.wav
 
-A pre-trained English model is available for use and can be downloaded following the instructions in :ref:`the usage docs <usage-docs>`. For the latest release, including pre-trained models and checkpoints, `see the GitHub releases page <https://github.com/mozilla/DeepSpeech/releases/latest>`_.
+A pre-trained English model is available for use and can be downloaded following the instructions in :ref:`the usage docs <usage-docs>`. For the latest release, including pre-trained models and checkpoints, `see the GitHub releases page <https://github.com/mozilla/STT/releases/latest>`_.
 
-Quicker inference can be performed using a supported NVIDIA GPU on Linux. See the `release notes <https://github.com/mozilla/DeepSpeech/releases/latest>`_ to find which GPUs are supported. To run ``mozilla_voice_stt`` on a GPU, install the GPU specific package:
+Quicker inference can be performed using a supported NVIDIA GPU on Linux. See the `release notes <https://github.com/mozilla/STT/releases/latest>`_ to find which GPUs are supported. To run ``mozilla_voice_stt`` on a GPU, install the GPU specific package:
 
 .. code-block:: bash
 
@@ -44,7 +44,7 @@ Quicker inference can be performed using a supported NVIDIA GPU on Linux. See th
    pip3 install mozilla_voice_stt_cuda
 
    # Transcribe an audio file.
-   mozilla_voice_stt --model deepspeech-0.7.4-models.pbmm --scorer deepspeech-0.7.4-models.scorer --audio audio/2830-3980-0043.wav
+   mozilla_voice_stt --model deepspeech-0.8.1-models.pbmm --scorer deepspeech-0.8.1-models.scorer --audio audio/2830-3980-0043.wav
 
 Please ensure you have the required :ref:`CUDA dependencies <cuda-deps>`.
 

native_client/dotnet/README.rst

@@ -42,11 +42,11 @@ We highly recommend sticking to the recommended versions of CUDA/cuDNN in order
 Getting the code
 ----------------
 
-We need to clone ``mozilla/DeepSpeech``.
+We need to clone ``mozilla/STT``.
 
 .. code-block:: bash
 
-   git clone https://github.com/mozilla/DeepSpeech
+   git clone https://github.com/mozilla/STT
    git submodule sync tensorflow/
    git submodule update --init tensorflow/
 
@@ -142,4 +142,4 @@ Be patient, if you enabled AVX/AVX2 and CUDA it will take a long time. Finally y
 Using the generated library
 ---------------------------
 
-As for now we can only use the generated ``libmozilla_voice_stt.so`` with the C# clients, go to `native_client/dotnet/ <https://github.com/mozilla/DeepSpeech/tree/master/native_client/dotnet>`_ in your Mozilla Voice STT directory and open the Visual Studio solution, then we need to build in debug or release mode, finally we just need to copy ``libmozilla_voice_stt.so`` to the generated ``x64/Debug`` or ``x64/Release`` directory.
+As for now we can only use the generated ``libmozilla_voice_stt.so`` with the C# clients, go to `native_client/dotnet/ <https://github.com/mozilla/STT/tree/master/native_client/dotnet>`_ in your Mozilla Voice STT directory and open the Visual Studio solution, then we need to build in debug or release mode, finally we just need to copy ``libmozilla_voice_stt.so`` to the generated ``x64/Debug`` or ``x64/Release`` directory.

native_client/dotnet/nupkg/deepspeech.nuspec.in

@@ -7,7 +7,7 @@
     <authors>Mozilla</authors>
     <owners>Mozilla</owners>
     <license type="expression">MPL-2.0</license>
-    <projectUrl>http://github.com/mozilla/DeepSpeech</projectUrl>
+    <projectUrl>http://github.com/mozilla/STT</projectUrl>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <description>A library for running inference with a Mozilla Voice STT model</description>
     <copyright>Copyright (c) 2019 Mozilla Corporation</copyright>

native_client/java/README.md

@@ -1 +1 @@
-Full project description and documentation on GitHub: [https://github.com/mozilla/DeepSpeech](https://github.com/mozilla/DeepSpeech).
+Full project description and documentation on GitHub: [https://github.com/mozilla/STT](https://github.com/mozilla/STT).

native_client/java/libmozillavoicestt/build.gradle

@@ -83,7 +83,7 @@ uploadArchives {
 
             pom.project {
                 description 'Speech recognition library'
-                url 'https://github.com/mozilla/DeepSpeech'
+                url 'https://github.com/mozilla/STT'
 
                 licenses {
                     license {
@@ -102,9 +102,9 @@ uploadArchives {
                 }
 
                 scm {
-                    connection 'https://github.com/mozilla/DeepSpeech.git'
-                    developerConnection 'https://github.com/mozilla/DeepSpeech.git'
-                    url 'https://github.com/mozilla/DeepSpeech'
+                    connection 'https://github.com/mozilla/STT.git'
+                    developerConnection 'https://github.com/mozilla/STT.git'
+                    url 'https://github.com/mozilla/STT'
                 }
             }