From 116029aafef156812f96519d20938ed6eeb18efd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eren=20G=C3=B6lge?= Date: Sun, 21 Mar 2021 14:06:00 +0100 Subject: [PATCH] Update README.rst (#1796) * Update README.rst * Update README.rst * Update README.rst fixes --- README.rst | 58 ++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 45 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index ccaf9d261..089fd457f 100644 --- a/README.rst +++ b/README.rst @@ -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 `_ -**Documentation** for installation, usage, and training models are available on `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 `_. +🐸STT features +--------------- -For contribution guidelines, see `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 `_. +Where to Ask Questions +---------------------- -Help + Community ----------------- - -1. `Github Discussions `_ - find and join open-ended community discussions related to 🐸STT - -2. `Gitter Room `_ - the 🐸 Matrix channel where you can chat with folks about 🐸STT, get help, share ideas :) - -3. `Github 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 `_ + * - 🎁 **Feature Requests & Ideas** + - `Github Issue Tracker `_ + * - ❔ **Questions** + - `Github Discussions `_ + * - 💬 **General Discussion** + - `Github Discussions `_ or `Gitter Room `_ + + +Links & Resources +----------------- +.. list-table:: + :widths: 25 25 + :header-rows: 1 + + * - Type + - Link + * - 📰 **Documentation** + - `stt.readthedocs.io `_ + * - 🚀 **Latest release with pre-trained models** + - `see the latest release on GitHub `_ + * - 🤝 **Contribution Guidelines** + - `CONTRIBUTING.rst `_ +