Skip to content

Commit ae0cf8d

Browse files
committed
Revert "Merge branch 'rename-real'"
This reverts commit ae9fdb1, reversing changes made to 2eb75b6.
1 parent 386935e commit ae0cf8d

File tree

183 files changed

+1497
-1330
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

183 files changed

+1497
-1330
lines changed

BIBLIOGRAPHY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
This file contains a list of papers in chronological order that have been published
2-
using Mozilla Voice STT.
2+
using Mozilla's DeepSpeech.
33

44
To appear
55
==========

Dockerfile.build.tmpl

+3-3
Original file line numberDiff line numberDiff line change
@@ -149,20 +149,20 @@ RUN bazel build \
149149
--copt=-msse4.2 \
150150
--copt=-mavx \
151151
--copt=-fvisibility=hidden \
152-
//native_client:libmozilla_voice_stt.so \
152+
//native_client:libdeepspeech.so \
153153
--verbose_failures \
154154
--action_env=LD_LIBRARY_PATH=${LD_LIBRARY_PATH}
155155

156156
# Copy built libs to /DeepSpeech/native_client
157-
RUN cp bazel-bin/native_client/libmozilla_voice_stt.so /DeepSpeech/native_client/
157+
RUN cp bazel-bin/native_client/libdeepspeech.so /DeepSpeech/native_client/
158158

159159
# Build client.cc and install Python client and decoder bindings
160160
ENV TFDIR /DeepSpeech/tensorflow
161161

162162
RUN nproc
163163

164164
WORKDIR /DeepSpeech/native_client
165-
RUN make NUM_PROCESSES=$(nproc) mozilla_voice_stt
165+
RUN make NUM_PROCESSES=$(nproc) deepspeech
166166

167167
WORKDIR /DeepSpeech
168168
RUN cd native_client/python && make NUM_PROCESSES=$(nproc) bindings

README.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Mozilla Voice STT
2-
=================
1+
Project DeepSpeech
2+
==================
33

44

55
.. image:: https://readthedocs.org/projects/deepspeech/badge/?version=latest
@@ -12,7 +12,7 @@ Mozilla Voice STT
1212
:alt: Task Status
1313

1414

15-
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.
15+
DeepSpeech 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>`_. Project DeepSpeech uses Google's `TensorFlow <https://www.tensorflow.org/>`_ to make the implementation easier.
1616

1717
Documentation for installation, usage, and training models are available on `deepspeech.readthedocs.io <http://deepspeech.readthedocs.io/?badge=latest>`_.
1818

doc/BUILDING.rst

+45-45
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
.. _build-native-client:
22

3-
Building Mozilla Voice STT Binaries
4-
===================================
3+
Building DeepSpeech Binaries
4+
============================
55

66
This section describes how to rebuild binaries. We have already several prebuilt binaries for all the supported platform,
77
it is highly advised to use them except if you know what you are doing.
88

9-
If you'd like to build the Mozilla Voice STT binaries yourself, you'll need the following pre-requisites downloaded and installed:
9+
If you'd like to build the DeepSpeech binaries yourself, you'll need the following pre-requisites downloaded and installed:
1010

1111
* `Bazel 3.1.0 <https://github.com/bazelbuild/bazel/releases/tag/3.1.0>`_
1212
* `General TensorFlow r2.3 requirements <https://www.tensorflow.org/install/source#tested_build_configurations>`_
@@ -26,14 +26,14 @@ If you'd like to build the language bindings or the decoder package, you'll also
2626
Dependencies
2727
------------
2828

29-
If you follow these instructions, you should compile your own binaries of Mozilla Voice STT (built on TensorFlow using Bazel).
29+
If you follow these instructions, you should compile your own binaries of DeepSpeech (built on TensorFlow using Bazel).
3030

3131
For more information on configuring TensorFlow, read the docs up to the end of `"Configure the Build" <https://www.tensorflow.org/install/source#configure_the_build>`_.
3232

3333
Checkout source code
3434
^^^^^^^^^^^^^^^^^^^^
3535

36-
Clone Mozilla Voice STT source code (TensorFlow will come as a submdule):
36+
Clone DeepSpeech source code (TensorFlow will come as a submdule):
3737

3838
.. code-block::
3939
@@ -56,24 +56,24 @@ After you have installed the correct version of Bazel, configure TensorFlow:
5656
cd tensorflow
5757
./configure
5858
59-
Compile Mozilla Voice STT
60-
-------------------------
59+
Compile DeepSpeech
60+
------------------
6161

62-
Compile ``libmozilla_voice_stt.so``
62+
Compile ``libdeepspeech.so``
6363
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6464

65-
Within your TensorFlow directory, there should be a symbolic link to the Mozilla Voice STT ``native_client`` directory. If it is not present, create it with the follow command:
65+
Within your TensorFlow directory, there should be a symbolic link to the DeepSpeech ``native_client`` directory. If it is not present, create it with the follow command:
6666

6767
.. code-block::
6868
6969
cd tensorflow
7070
ln -s ../native_client
7171
72-
You can now use Bazel to build the main Mozilla Voice STT library, ``libmozilla_voice_stt.so``. Add ``--config=cuda`` if you want a CUDA build.
72+
You can now use Bazel to build the main DeepSpeech library, ``libdeepspeech.so``. Add ``--config=cuda`` if you want a CUDA build.
7373

7474
.. code-block::
7575
76-
bazel build --workspace_status_command="bash native_client/bazel_workspace_status_cmd.sh" --config=monolithic -c opt --copt=-O3 --copt="-D_GLIBCXX_USE_CXX11_ABI=0" --copt=-fvisibility=hidden //native_client:libmozilla_voice_stt.so
76+
bazel build --workspace_status_command="bash native_client/bazel_workspace_status_cmd.sh" --config=monolithic -c opt --copt=-O3 --copt="-D_GLIBCXX_USE_CXX11_ABI=0" --copt=-fvisibility=hidden //native_client:libdeepspeech.so
7777
7878
The generated binaries will be saved to ``bazel-bin/native_client/``.
7979

@@ -82,12 +82,12 @@ The generated binaries will be saved to ``bazel-bin/native_client/``.
8282
Compile ``generate_scorer_package``
8383
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8484

85-
Following the same setup as for ``libmozilla_voice_stt.so`` above, you can rebuild the ``generate_scorer_package`` binary by adding its target to the command line: ``//native_client:generate_scorer_package``.
85+
Following the same setup as for ``libdeepspeech.so`` above, you can rebuild the ``generate_scorer_package`` binary by adding its target to the command line: ``//native_client:generate_scorer_package``.
8686
Using the example from above you can build the library and that binary at the same time:
8787

8888
.. code-block::
8989
90-
bazel build --workspace_status_command="bash native_client/bazel_workspace_status_cmd.sh" --config=monolithic -c opt --copt=-O3 --copt="-D_GLIBCXX_USE_CXX11_ABI=0" --copt=-fvisibility=hidden //native_client:libmozilla_voice_stt.so //native_client:generate_scorer_package
90+
bazel build --workspace_status_command="bash native_client/bazel_workspace_status_cmd.sh" --config=monolithic -c opt --copt=-O3 --copt="-D_GLIBCXX_USE_CXX11_ABI=0" --copt=-fvisibility=hidden //native_client:libdeepspeech.so //native_client:generate_scorer_package
9191
9292
The generated binaries will be saved to ``bazel-bin/native_client/``.
9393

@@ -99,7 +99,7 @@ Now, ``cd`` into the ``DeepSpeech/native_client`` directory and use the ``Makefi
9999
.. code-block::
100100
101101
cd ../DeepSpeech/native_client
102-
make mozilla_voice_stt
102+
make deepspeech
103103
104104
Installing your own Binaries
105105
----------------------------
@@ -121,9 +121,9 @@ Included are a set of generated Python bindings. After following the above build
121121
122122
cd native_client/python
123123
make bindings
124-
pip install dist/mozilla_voice_stt*
124+
pip install dist/deepspeech*
125125
126-
The API mirrors the C++ API and is demonstrated in `client.py <python/client.py>`_. Refer to the `C API <c-usage>` for documentation.
126+
The API mirrors the C++ API and is demonstrated in `client.py <python/client.py>`_. Refer to `deepspeech.h <deepspeech.h>`_ for documentation.
127127

128128
Install NodeJS / ElectronJS bindings
129129
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -136,7 +136,7 @@ After following the above build and installation instructions, the Node.JS bindi
136136
make build
137137
make npm-pack
138138
139-
This will create the package ``mozilla_voice_stt-VERSION.tgz`` in ``native_client/javascript``.
139+
This will create the package ``deepspeech-VERSION.tgz`` in ``native_client/javascript``.
140140

141141
Install the CTC decoder package
142142
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -165,23 +165,23 @@ So your command line for ``RPi3`` and ``ARMv7`` should look like:
165165

166166
.. code-block::
167167
168-
bazel build --workspace_status_command="bash native_client/bazel_workspace_status_cmd.sh" --config=monolithic --config=rpi3 --config=rpi3_opt -c opt --copt=-O3 --copt=-fvisibility=hidden //native_client:libmozilla_voice_stt.so
168+
bazel build --workspace_status_command="bash native_client/bazel_workspace_status_cmd.sh" --config=monolithic --config=rpi3 --config=rpi3_opt -c opt --copt=-O3 --copt=-fvisibility=hidden //native_client:libdeepspeech.so
169169
170170
And your command line for ``LePotato`` and ``ARM64`` should look like:
171171

172172
.. code-block::
173173
174-
bazel build --workspace_status_command="bash native_client/bazel_workspace_status_cmd.sh" --config=monolithic --config=rpi3-armv8 --config=rpi3-armv8_opt -c opt --copt=-O3 --copt=-fvisibility=hidden //native_client:libmozilla_voice_stt.so
174+
bazel build --workspace_status_command="bash native_client/bazel_workspace_status_cmd.sh" --config=monolithic --config=rpi3-armv8 --config=rpi3-armv8_opt -c opt --copt=-O3 --copt=-fvisibility=hidden //native_client:libdeepspeech.so
175175
176176
While we test only on RPi3 Raspbian Buster and LePotato ARMBian Buster, anything compatible with ``armv7-a cortex-a53`` or ``armv8-a cortex-a53`` should be fine.
177177

178-
The ``mozilla_voice_stt`` binary can also be cross-built, with ``TARGET=rpi3`` or ``TARGET=rpi3-armv8``. This might require you to setup a system tree using the tool ``multistrap`` and the multitrap configuration files: ``native_client/multistrap_armbian64_buster.conf`` and ``native_client/multistrap_raspbian_buster.conf``.
178+
The ``deepspeech`` binary can also be cross-built, with ``TARGET=rpi3`` or ``TARGET=rpi3-armv8``. This might require you to setup a system tree using the tool ``multistrap`` and the multitrap configuration files: ``native_client/multistrap_armbian64_buster.conf`` and ``native_client/multistrap_raspbian_buster.conf``.
179179
The path of the system tree can be overridden from the default values defined in ``definitions.mk`` through the ``RASPBIAN`` ``make`` variable.
180180

181181
.. code-block::
182182
183183
cd ../DeepSpeech/native_client
184-
make TARGET=<system> mozilla_voice_stt
184+
make TARGET=<system> deepspeech
185185
186186
Android devices support
187187
-----------------------
@@ -193,53 +193,53 @@ Please refer to TensorFlow documentation on how to setup the environment to buil
193193
Using the library from Android project
194194
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
195195

196-
We provide up-to-date and tested STT usable as an ``AAR`` package,
196+
We provide uptodate and tested ``libdeepspeech`` usable as an ``AAR`` package,
197197
for Android versions starting with 7.0 to 11.0. The package is published on
198-
`JCenter <https://bintray.com/alissy/org.mozilla.voice/stt>`_,
198+
`JCenter <https://bintray.com/alissy/org.mozilla.deepspeech/libdeepspeech>`_,
199199
and the ``JCenter`` repository should be available by default in any Android
200200
project. Please make sure your project is setup to pull from this repository.
201201
You can then include the library by just adding this line to your
202202
``gradle.build``, adjusting ``VERSION`` to the version you need:
203203

204204
.. code-block::
205205
206-
implementation 'voice.mozilla.org:stt:VERSION@aar'
206+
implementation 'deepspeech.mozilla.org:libdeepspeech:VERSION@aar'
207207
208-
Building ``libmozilla_voice_stt.so``
208+
Building ``libdeepspeech.so``
209209
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
210210

211-
You can build the ``libmozilla_voice_stt.so`` using (ARMv7):
211+
You can build the ``libdeepspeech.so`` using (ARMv7):
212212

213213
.. code-block::
214214
215-
bazel build --workspace_status_command="bash native_client/bazel_workspace_status_cmd.sh" --config=monolithic --config=android --config=android_arm --define=runtime=tflite --action_env ANDROID_NDK_API_LEVEL=21 --cxxopt=-std=c++14 --copt=-D_GLIBCXX_USE_C99 //native_client:libmozilla_voice_stt.so
215+
bazel build --workspace_status_command="bash native_client/bazel_workspace_status_cmd.sh" --config=monolithic --config=android --config=android_arm --define=runtime=tflite --action_env ANDROID_NDK_API_LEVEL=21 --cxxopt=-std=c++14 --copt=-D_GLIBCXX_USE_C99 //native_client:libdeepspeech.so
216216
217217
Or (ARM64):
218218

219219
.. code-block::
220220
221-
bazel build --workspace_status_command="bash native_client/bazel_workspace_status_cmd.sh" --config=monolithic --config=android --config=android_arm64 --define=runtime=tflite --action_env ANDROID_NDK_API_LEVEL=21 --cxxopt=-std=c++14 --copt=-D_GLIBCXX_USE_C99 //native_client:libmozilla_voice_stt.so
221+
bazel build --workspace_status_command="bash native_client/bazel_workspace_status_cmd.sh" --config=monolithic --config=android --config=android_arm64 --define=runtime=tflite --action_env ANDROID_NDK_API_LEVEL=21 --cxxopt=-std=c++14 --copt=-D_GLIBCXX_USE_C99 //native_client:libdeepspeech.so
222222
223-
Building ``libmozillavoicestt.aar``
223+
Building ``libdeepspeech.aar``
224224
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
225225

226226
In the unlikely event you have to rebuild the JNI bindings, source code is
227-
available under the ``libmozillavoicestt`` subdirectory. Building depends on shared
228-
object: please ensure to place ``libmozilla_voice_stt.so`` into the
229-
``libmozillavoicestt/libs/{arm64-v8a,armeabi-v7a,x86_64}/`` matching subdirectories.
227+
available under the ``libdeepspeech`` subdirectory. Building depends on shared
228+
object: please ensure to place ``libdeepspeech.so`` into the
229+
``libdeepspeech/libs/{arm64-v8a,armeabi-v7a,x86_64}/`` matching subdirectories.
230230

231231
Building the bindings is managed by ``gradle`` and should be limited to issuing
232-
``./gradlew libmozillavoicestt:build``, producing an ``AAR`` package in
233-
``./libmozillavoicestt/build/outputs/aar/``.
232+
``./gradlew libdeepspeech:build``, producing an ``AAR`` package in
233+
``./libdeepspeech/build/outputs/aar/``.
234234

235235
Please note that you might have to copy the file to a local Maven repository
236236
and adapt file naming (when missing, the error message should states what
237237
filename it expects and where).
238238

239-
Building C++ ``mozilla_voice_stt`` binary
240-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
239+
Building C++ ``deepspeech`` binary
240+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
241241

242-
Building the ``mozilla_voice_stt`` binary will happen through ``ndk-build`` (ARMv7):
242+
Building the ``deepspeech`` binary will happen through ``ndk-build`` (ARMv7):
243243

244244
.. code-block::
245245
@@ -272,32 +272,32 @@ demo of one usage of the application. For example, it's only able to read PCM
272272
mono 16kHz 16-bits file and it might fail on some WAVE file that are not
273273
following exactly the specification.
274274

275-
Running ``mozilla_voice_stt`` via adb
276-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
275+
Running ``deepspeech`` via adb
276+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
277277

278278
You should use ``adb push`` to send data to device, please refer to Android
279279
documentation on how to use that.
280280

281-
Please push Mozilla Voice STT data to ``/sdcard/mozilla_voice_stt/``\ , including:
281+
Please push DeepSpeech data to ``/sdcard/deepspeech/``\ , including:
282282

283283

284284
* ``output_graph.tflite`` which is the TF Lite model
285285
* External scorer file (available from one of our releases), if you want to use
286286
the scorer; please be aware that too big scorer will make the device run out
287287
of memory
288288

289-
Then, push binaries from ``native_client.tar.xz`` to ``/data/local/tmp/stt``\ :
289+
Then, push binaries from ``native_client.tar.xz`` to ``/data/local/tmp/ds``\ :
290290

291-
* ``mozilla_voice_stt``
292-
* ``libmozilla_voice_stt.so``
291+
* ``deepspeech``
292+
* ``libdeepspeech.so``
293293
* ``libc++_shared.so``
294294

295295
You should then be able to run as usual, using a shell from ``adb shell``\ :
296296

297297
.. code-block::
298298
299-
user@device$ cd /data/local/tmp/stt/
300-
user@device$ LD_LIBRARY_PATH=$(pwd)/ ./mozilla_voice_stt [...]
299+
user@device$ cd /data/local/tmp/ds/
300+
user@device$ LD_LIBRARY_PATH=$(pwd)/ ./deepspeech [...]
301301
302302
Please note that Android linker does not support ``rpath`` so you have to set
303303
``LD_LIBRARY_PATH``. Properly wrapped / packaged bindings does embed the library

doc/C-API.rst

+18-21
Original file line numberDiff line numberDiff line change
@@ -10,59 +10,56 @@ C API
1010

1111
See also the list of error codes including descriptions for each error in :ref:`error-codes`.
1212

13-
.. doxygenfunction:: STT_CreateModel
13+
.. doxygenfunction:: DS_CreateModel
1414
:project: deepspeech-c
1515

16-
.. doxygenfunction:: STT_FreeModel
16+
.. doxygenfunction:: DS_FreeModel
1717
:project: deepspeech-c
1818

19-
.. doxygenfunction:: STT_EnableExternalScorer
19+
.. doxygenfunction:: DS_EnableExternalScorer
2020
:project: deepspeech-c
2121

22-
.. doxygenfunction:: STT_DisableExternalScorer
22+
.. doxygenfunction:: DS_DisableExternalScorer
2323
:project: deepspeech-c
2424

25-
.. doxygenfunction:: STT_SetScorerAlphaBeta
25+
.. doxygenfunction:: DS_SetScorerAlphaBeta
2626
:project: deepspeech-c
2727

28-
.. doxygenfunction:: STT_GetModelSampleRate
28+
.. doxygenfunction:: DS_GetModelSampleRate
2929
:project: deepspeech-c
3030

31-
.. doxygenfunction:: STT_SpeechToText
31+
.. doxygenfunction:: DS_SpeechToText
3232
:project: deepspeech-c
3333

34-
.. doxygenfunction:: STT_SpeechToTextWithMetadata
34+
.. doxygenfunction:: DS_SpeechToTextWithMetadata
3535
:project: deepspeech-c
3636

37-
.. doxygenfunction:: STT_CreateStream
37+
.. doxygenfunction:: DS_CreateStream
3838
:project: deepspeech-c
3939

40-
.. doxygenfunction:: STT_FeedAudioContent
40+
.. doxygenfunction:: DS_FeedAudioContent
4141
:project: deepspeech-c
4242

43-
.. doxygenfunction:: STT_IntermediateDecode
43+
.. doxygenfunction:: DS_IntermediateDecode
4444
:project: deepspeech-c
4545

46-
.. doxygenfunction:: STT_IntermediateDecodeWithMetadata
46+
.. doxygenfunction:: DS_IntermediateDecodeWithMetadata
4747
:project: deepspeech-c
4848

49-
.. doxygenfunction:: STT_FinishStream
49+
.. doxygenfunction:: DS_FinishStream
5050
:project: deepspeech-c
5151

52-
.. doxygenfunction:: STT_FinishStreamWithMetadata
52+
.. doxygenfunction:: DS_FinishStreamWithMetadata
5353
:project: deepspeech-c
5454

55-
.. doxygenfunction:: STT_FreeStream
55+
.. doxygenfunction:: DS_FreeStream
5656
:project: deepspeech-c
5757

58-
.. doxygenfunction:: STT_FreeMetadata
58+
.. doxygenfunction:: DS_FreeMetadata
5959
:project: deepspeech-c
6060

61-
.. doxygenfunction:: STT_FreeString
61+
.. doxygenfunction:: DS_FreeString
6262
:project: deepspeech-c
6363

64-
.. doxygenfunction:: STT_Version
65-
:project: deepspeech-c
66-
67-
.. doxygenfunction:: STT_ErrorCodeToErrorMessage
64+
.. doxygenfunction:: DS_Version
6865
:project: deepspeech-c

0 commit comments

Comments
 (0)