Skip to content

Commit

Permalink
Update README.rst (#1796)
Browse files Browse the repository at this point in the history
* Update README.rst

* Update README.rst

* Update README.rst

fixes
  • Loading branch information
erogol authored Mar 21, 2021
1 parent 6c9f3a5 commit 116029a
Showing 1 changed file with 45 additions and 13 deletions.
58 changes: 45 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,53 @@

|doc-img| |covenant-img| |gitter-img| |doi|

**Coqui STT** (🐸STT) is an open-source deep-learning toolkit for training and deploying speech-to-text models. 🐸STT is battle tested in both production and research 🚀
`👉 Subscribe to 🐸Coqui's Newsletter <https://coqui.ai/?subscription=true>`_

**Documentation** for installation, usage, and training models are available on `stt.readthedocs.io <https://stt.readthedocs.io/>`_.
**Coqui STT** (🐸STT) is a fast, open-source, multi-platform, deep-learning toolkit for training and deploying speech-to-text models. 🐸STT is battle tested in both production and research 🚀

For the **latest release**, including pre-trained models and checkpoints, `see the latest release on GitHub <https://github.com/coqui-ai/STT/releases/latest>`_.
🐸STT features
---------------

For contribution guidelines, see `CONTRIBUTING.rst <CONTRIBUTING.rst>`_.
* High-quality pre-trained STT model.
* Efficient training pipeline with Multi-GPU support.
* Streaming inference.
* Confidence score for each word.
* Multiple possible transcripts, each with an associated confidence score.
* Real-time inference.
* Small-footprint acoustic model.
* Bindings for various programming languages.

For contact and support information, see `SUPPORT.rst <SUPPORT.rst>`_.
Where to Ask Questions
----------------------

Help + Community
----------------

1. `Github Discussions <https://github.com/coqui-ai/stt/discussions/>`_ - find and join open-ended community discussions related to 🐸STT

2. `Gitter Room <https://gitter.im/coqui-ai/STT?utm_source=share-link&utm_medium=link&utm_campaign=share-link>`_ - the 🐸 Matrix channel where you can chat with folks about 🐸STT, get help, share ideas :)

3. `Github Issues <https://github.com/coqui-ai/stt/issues>`_ - If you ran into a specific error/problem, feel free to open an issue in the repo.
.. list-table::
:widths: 25 25
:header-rows: 1

* - Type
- Link
* - 🚨 **Bug Reports**
- `Github Issue Tracker <https://github.com/coqui-ai/STT/issues/>`_
* - 🎁 **Feature Requests & Ideas**
- `Github Issue Tracker <https://github.com/coqui-ai/STT/issues/>`_
* - ❔ **Questions**
- `Github Discussions <https://github.com/coqui-ai/stt/discussions/>`_
* - 💬 **General Discussion**
- `Github Discussions <https://github.com/coqui-ai/stt/discussions/>`_ or `Gitter Room <https://gitter.im/coqui-ai/STT?utm_source=share-link&utm_medium=link&utm_campaign=share-link>`_


Links & Resources
-----------------
.. list-table::
:widths: 25 25
:header-rows: 1

* - Type
- Link
* - 📰 **Documentation**
- `stt.readthedocs.io <https://stt.readthedocs.io/>`_
* - 🚀 **Latest release with pre-trained models**
- `see the latest release on GitHub <https://github.com/coqui-ai/STT/releases/latest>`_
* - 🤝 **Contribution Guidelines**
- `CONTRIBUTING.rst <CONTRIBUTING.rst>`_

0 comments on commit 116029a

Please sign in to comment.