More rebranding, Python and JS packages verified

This commit is contained in:
Kelly Davis 2021-03-07 11:14:16 +01:00
parent 99fc28a6c7
commit f33f0b382d
21 changed files with 162 additions and 41 deletions

View File

@ -1,15 +1,132 @@
# Community Participation Guidelines # Contributor Covenant Code of Conduct
This repository is governed by Mozilla's code of conduct and etiquette guidelines. ## Our Pledge
For more details, please read the
[Mozilla Community Participation Guidelines](https://www.mozilla.org/about/governance/policies/participation/).
## How to Report We as members, contributors, and leaders pledge to make participation in our
For more information on how to report violations of the Community Participation Guidelines, please read our '[How to Report](https://www.mozilla.org/about/governance/policies/participation/reporting/)' page. community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual identity
and orientation.
<!-- We pledge to act and interact in ways that contribute to an open, welcoming,
## Project Specific Etiquette diverse, inclusive, and healthy community.
In some cases, there will be additional project etiquette i.e.: (https://bugzilla.mozilla.org/page.cgi?id=etiquette.html). ## Our Standards
Please update for your project.
--> Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement by emailing
[coc-report@coqui.ai](mailto:coc-report@coqui.ai).
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
at [https://www.contributor-covenant.org/translations][translations].
[homepage]: https://www.contributor-covenant.org
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

View File

@ -3,7 +3,7 @@ Contribution guidelines
Welcome to the 🐸STT 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/>`_. This repository is governed by the Contributor Covenant Code of Conduct. For more details, see the `CODE_OF_CONDUCT.md <CODE_OF_CONDUCT.md>`_.
How to Make a Good Pull Request How to Make a Good Pull Request
------------------------------- -------------------------------
@ -47,9 +47,9 @@ Before making a Pull Request for Python code changes, check your changes for bas
.. code-block:: bash .. code-block:: bash
pip install pylint cardboardlint pip install pylint cardboardlint
cardboardlinter --refspec master cardboardlinter --refspec main
This will compare the code against master and run the linter on all the changes. We plan to introduce more linter checks (e.g. for C++) in the future. To run it automatically as a git pre-commit hook, do the following: This will compare the code against the main branch and run the linter on all the changes. We plan to introduce more linter checks (e.g. for C++) in the future. To run it automatically as a git pre-commit hook, do the following:
.. code-block:: bash .. code-block:: bash

View File

@ -6,6 +6,8 @@
:target: https://stt.readthedocs.io/?badge=latest :target: https://stt.readthedocs.io/?badge=latest
:alt: Documentation :alt: Documentation
|Contributor Covenant|
**Coqui 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>`_. 🐸STT uses Google's `TensorFlow <https://www.tensorflow.org/>`_ to make the implementation easier. **Coqui 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>`_. 🐸STT uses Google's `TensorFlow <https://www.tensorflow.org/>`_ to make the implementation easier.
**Documentation** for installation, usage, and training models are available on `stt.readthedocs.io <https://stt.readthedocs.io/>`_. **Documentation** for installation, usage, and training models are available on `stt.readthedocs.io <https://stt.readthedocs.io/>`_.
@ -15,3 +17,5 @@ For the **latest release**, including pre-trained models and checkpoints, `see t
For contribution guidelines, see `CONTRIBUTING.rst <CONTRIBUTING.rst>`_. For contribution guidelines, see `CONTRIBUTING.rst <CONTRIBUTING.rst>`_.
For contact and support information, see `SUPPORT.rst <SUPPORT.rst>`_. For contact and support information, see `SUPPORT.rst <SUPPORT.rst>`_.
.. |Contributor Covenant| image:: https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg :target: CODE_OF_CONDUCT.md

View File

@ -144,4 +144,4 @@ Be patient, if you enabled AVX/AVX2 and CUDA it will take a long time. Finally y
Using the generated library Using the generated library
--------------------------- ---------------------------
As for now we can only use the generated ``libstt.so`` with the C# clients, go to `native_client/dotnet/ <https://github.com/coqui-ai/STT/tree/master/native_client/dotnet>`_ in your STT directory and open the Visual Studio solution, then we need to build in debug or release mode, finally we just need to copy ``libstt.so`` to the generated ``x64/Debug`` or ``x64/Release`` directory. As for now we can only use the generated ``libstt.so`` with the C# clients, go to `native_client/dotnet/ <https://github.com/coqui-ai/STT/tree/main/native_client/dotnet>`_ in your STT directory and open the Visual Studio solution, then we need to build in debug or release mode, finally we just need to copy ``libstt.so`` to the generated ``x64/Debug`` or ``x64/Release`` directory.

View File

@ -188,7 +188,7 @@ or if you're on macOS:
python3 util/taskcluster.py --arch osx --target . python3 util/taskcluster.py --arch osx --target .
also, if you need some binaries different than current master, like ``v0.2.0-alpha.6``\ , you can use ``--branch``\ : also, if you need some binaries different than current main branch, like ``v0.2.0-alpha.6``\ , you can use ``--branch``\ :
.. code-block:: bash .. code-block:: bash

View File

@ -99,7 +99,7 @@ templates_path = ['.templates']
# source_suffix = ['.rst', '.md'] # source_suffix = ['.rst', '.md']
source_suffix = '.rst' source_suffix = '.rst'
# The master toctree document. # The main toctree document.
master_doc = 'index' master_doc = 'index'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation

View File

@ -790,7 +790,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched. # Note: If this tag is empty the current directory is searched.
INPUT = native_client/java/libdeepspeech/src/main/java/org/deepspeech/libdeepspeech/ native_client/java/libdeepspeech/src/main/java/org/deepspeech/libdeepspeech_doc/ INPUT = native_client/java/libstt/src/main/java/ai/coqui/libstt/ native_client/java/libstt/src/main/java/ai/coqui/libstt_doc/
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

View File

@ -1,4 +1,4 @@
.. Coqui STT documentation master file, created by .. Coqui STT documentation main file, created by
sphinx-quickstart on Thu Feb 2 21:20:39 2017. sphinx-quickstart on Thu Feb 2 21:20:39 2017.
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.

View File

@ -10,7 +10,7 @@ import csv
import os import os
import sys import sys
from deepspeech import Model from stt import Model
from coqui_stt_training.util.evaluate_tools import calculate_and_print_report from coqui_stt_training.util.evaluate_tools import calculate_and_print_report
from coqui_stt_training.util.flags import create_flags from coqui_stt_training.util.flags import create_flags
from functools import partial from functools import partial

View File

@ -103,7 +103,7 @@ main(int argc, char** argv)
("package", po::value<string>(), "Path to save scorer package.") ("package", po::value<string>(), "Path to save scorer package.")
("default_alpha", po::value<float>(), "Default value of alpha hyperparameter (float).") ("default_alpha", po::value<float>(), "Default value of alpha hyperparameter (float).")
("default_beta", po::value<float>(), "Default value of beta hyperparameter (float).") ("default_beta", po::value<float>(), "Default value of beta hyperparameter (float).")
("force_bytes_output_mode", po::value<bool>(), "Boolean flag, force set or unset bytes output mode in the scorer package. If not set, infers from the vocabulary. See <https://deepspeech.readthedocs.io/en/master/Decoder.html#bytes-output-mode> for further explanation.") ("force_bytes_output_mode", po::value<bool>(), "Boolean flag, force set or unset bytes output mode in the scorer package. If not set, infers from the vocabulary. See <https://stt.readthedocs.io/en/latest/Decoder.html#bytes-output-mode> for further explanation.")
; ;
po::variables_map vm; po::variables_map vm;

View File

@ -26,12 +26,12 @@ add_library( deepspeech-lib
set_target_properties( deepspeech-lib set_target_properties( deepspeech-lib
PROPERTIES PROPERTIES
IMPORTED_LOCATION IMPORTED_LOCATION
${CMAKE_SOURCE_DIR}/libs/${ANDROID_ABI}/libdeepspeech.so ) ${CMAKE_SOURCE_DIR}/libs/${ANDROID_ABI}/libstt.so )
add_custom_command( TARGET deepspeech-jni POST_BUILD add_custom_command( TARGET deepspeech-jni POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy COMMAND ${CMAKE_COMMAND} -E copy
${CMAKE_SOURCE_DIR}/libs/${ANDROID_ABI}/libdeepspeech.so ${CMAKE_SOURCE_DIR}/libs/${ANDROID_ABI}/libstt.so
${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/libdeepspeech.so ) ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/libstt.so )
# Searches for a specified prebuilt library and stores the path as a # Searches for a specified prebuilt library and stores the path as a

View File

@ -44,7 +44,7 @@ android {
installOptions "-d","-t" installOptions "-d","-t"
} }
// Avoid scanning libdeepspeech_doc // Avoid scanning libstt_doc
sourceSets { sourceSets {
main.java.srcDirs = [ 'src/main/java/ai/coqui/libstt/' ] main.java.srcDirs = [ 'src/main/java/ai/coqui/libstt/' ]
} }

View File

@ -1,3 +1,3 @@
<resources> <resources>
<string name="app_name">libdeepspeech</string> <string name="app_name">libstt</string>
</resources> </resources>

View File

@ -1 +1 @@
include ':app', ':libdeepspeech' include ':app', ':libstt'

View File

@ -27,11 +27,11 @@ endif
default: build default: build
clean: clean:
rm -f deepspeech_wrap.cxx package.json package-lock.json rm -f stt_wrap.cxx package.json package-lock.json
rm -rf ./build/ rm -rf ./build/
clean-npm-pack: clean-npm-pack:
rm -fr ./deepspeech-*.tgz rm -fr ./stt-*.tgz
really-clean: clean clean-npm-pack really-clean: clean clean-npm-pack
rm -fr ./node_modules/ rm -fr ./node_modules/
@ -46,14 +46,14 @@ package.json: package.json.in
npm-dev: package.json npm-dev: package.json
$(NPM_TOOL) install --prefix=$(NPM_ROOT)/../ --ignore-scripts --force --verbose --production=false . $(NPM_TOOL) install --prefix=$(NPM_ROOT)/../ --ignore-scripts --force --verbose --production=false .
configure: deepspeech_wrap.cxx package.json npm-dev configure: stt_wrap.cxx package.json npm-dev
PATH="$(NODE_MODULES_BIN):${PATH}" $(NODE_BUILD_TOOL) configure $(NODE_BUILD_VERBOSE) PATH="$(NODE_MODULES_BIN):${PATH}" $(NODE_BUILD_TOOL) configure $(NODE_BUILD_VERBOSE)
build: configure deepspeech_wrap.cxx build: configure stt_wrap.cxx
PATH="$(NODE_MODULES_BIN):${PATH}" NODE_PRE_GYP_ABI_CROSSWALK=$(NODE_PRE_GYP_ABI_CROSSWALK_FILE) AS=$(AS) CC=$(CC) CXX=$(CXX) LD=$(LD) CFLAGS="$(CFLAGS)" CXXFLAGS="$(CXXFLAGS)" LDFLAGS="$(RPATH_NODEJS) $(LDFLAGS)" LIBS=$(LIBS) $(NODE_BUILD_TOOL) $(NODE_PLATFORM_TARGET) $(NODE_RUNTIME) $(NODE_ABI_TARGET) $(NODE_DEVDIR) $(NODE_DIST_URL) --no-color rebuild $(NODE_BUILD_VERBOSE) PATH="$(NODE_MODULES_BIN):${PATH}" NODE_PRE_GYP_ABI_CROSSWALK=$(NODE_PRE_GYP_ABI_CROSSWALK_FILE) AS=$(AS) CC=$(CC) CXX=$(CXX) LD=$(LD) CFLAGS="$(CFLAGS)" CXXFLAGS="$(CXXFLAGS)" LDFLAGS="$(RPATH_NODEJS) $(LDFLAGS)" LIBS=$(LIBS) $(NODE_BUILD_TOOL) $(NODE_PLATFORM_TARGET) $(NODE_RUNTIME) $(NODE_ABI_TARGET) $(NODE_DEVDIR) $(NODE_DIST_URL) --no-color rebuild $(NODE_BUILD_VERBOSE)
copy-deps: build copy-deps: build
$(call copy_missing_libs,lib/binding/*/*/*/deepspeech.node,lib/binding/*/*/) $(call copy_missing_libs,lib/binding/*/*/*/stt.node,lib/binding/*/*/)
node-wrapper: copy-deps build node-wrapper: copy-deps build
PATH="$(NODE_MODULES_BIN):${PATH}" NODE_PRE_GYP_ABI_CROSSWALK=$(NODE_PRE_GYP_ABI_CROSSWALK_FILE) $(NODE_BUILD_TOOL) $(NODE_PLATFORM_TARGET) $(NODE_RUNTIME) $(NODE_ABI_TARGET) $(NODE_DEVDIR) $(NODE_DIST_URL) --no-color package $(NODE_BUILD_VERBOSE) PATH="$(NODE_MODULES_BIN):${PATH}" NODE_PRE_GYP_ABI_CROSSWALK=$(NODE_PRE_GYP_ABI_CROSSWALK_FILE) $(NODE_BUILD_TOOL) $(NODE_PLATFORM_TARGET) $(NODE_RUNTIME) $(NODE_ABI_TARGET) $(NODE_DEVDIR) $(NODE_DIST_URL) --no-color package $(NODE_BUILD_VERBOSE)
@ -61,5 +61,5 @@ node-wrapper: copy-deps build
npm-pack: clean package.json index.ts npm-dev npm-pack: clean package.json index.ts npm-dev
PATH="$(NODE_MODULES_BIN):${PATH}" tsc && $(NPM_TOOL) pack $(NODE_BUILD_VERBOSE) PATH="$(NODE_MODULES_BIN):${PATH}" tsc && $(NPM_TOOL) pack $(NODE_BUILD_VERBOSE)
deepspeech_wrap.cxx: deepspeech.i ds-swig stt_wrap.cxx: stt.i ds-swig
$(DS_SWIG_ENV) swig -c++ -javascript -node deepspeech.i $(DS_SWIG_ENV) swig -c++ -javascript -node stt.i

View File

@ -1,8 +1,8 @@
{ {
"targets": [ "targets": [
{ {
"target_name": "deepspeech", "target_name": "stt",
"sources": [ "deepspeech_wrap.cxx" ], "sources": [ "stt_wrap.cxx" ],
"libraries": [ "libraries": [
"$(LIBS)" "$(LIBS)"
], ],

View File

@ -3,7 +3,7 @@
include ../definitions.mk include ../definitions.mk
bindings-clean: bindings-clean:
rm -rf dist temp_build deepspeech.egg-info MANIFEST.in temp_lib rm -rf dist temp_build stt.egg-info MANIFEST.in temp_lib
rm -f impl_wrap.cpp impl.py rm -f impl_wrap.cpp impl.py
# Enforce PATH here because swig calls from build_ext looses track of some # Enforce PATH here because swig calls from build_ext looses track of some
@ -14,7 +14,7 @@ bindings-build: ds-swig
MANIFEST.in: bindings-build MANIFEST.in: bindings-build
> $@ > $@
$(call copy_missing_libs,temp_build/deepspeech/*.so,temp_build/deepspeech/lib,$@) $(call copy_missing_libs,temp_build/stt/*.so,temp_build/stt/lib,$@)
# On Unix, _wrap.o gets generated # On Unix, _wrap.o gets generated
# On Windows, _wrap.obj it is # On Windows, _wrap.obj it is

View File

@ -4,7 +4,7 @@
#ifdef __ANDROID__ #ifdef __ANDROID__
#include <android/log.h> #include <android/log.h>
#define LOG_TAG "libdeepspeech" #define LOG_TAG "libstt"
#define LOGD(...) __android_log_print(ANDROID_LOG_DEBUG, LOG_TAG, __VA_ARGS__) #define LOGD(...) __android_log_print(ANDROID_LOG_DEBUG, LOG_TAG, __VA_ARGS__)
#define LOGE(...) __android_log_print(ANDROID_LOG_ERROR, LOG_TAG, __VA_ARGS__) #define LOGE(...) __android_log_print(ANDROID_LOG_ERROR, LOG_TAG, __VA_ARGS__)
#else #else

View File

@ -22,7 +22,7 @@ then:
DEEPSPEECH_AUDIO: "https://github.com/mozilla/DeepSpeech/releases/download/v0.4.1/audio-0.4.1.tar.gz" DEEPSPEECH_AUDIO: "https://github.com/mozilla/DeepSpeech/releases/download/v0.4.1/audio-0.4.1.tar.gz"
PIP_DEFAULT_TIMEOUT: "60" PIP_DEFAULT_TIMEOUT: "60"
EXAMPLES_CLONE_URL: "https://github.com/coqui-ai/STT-examples" EXAMPLES_CLONE_URL: "https://github.com/coqui-ai/STT-examples"
EXAMPLES_CHECKOUT_TARGET: "master" EXAMPLES_CHECKOUT_TARGET: "main"
command: command:
- "/bin/bash" - "/bin/bash"

View File

@ -30,7 +30,7 @@ payload:
MSYS: 'winsymlinks:nativestrict' MSYS: 'winsymlinks:nativestrict'
GIT_LFS_SKIP_SMUDGE: '1' GIT_LFS_SKIP_SMUDGE: '1'
EXAMPLES_CLONE_URL: "https://github.com/coqui-ai/STT-examples" EXAMPLES_CLONE_URL: "https://github.com/coqui-ai/STT-examples"
EXAMPLES_CHECKOUT_TARGET: "master" EXAMPLES_CHECKOUT_TARGET: "main"
command: command:
- >- - >-