diff --git a/README.md b/README.md
index 48a49085..6c46c028 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,7 @@ from https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readme
4.What is the goal of this project?
-->
+
**PaddleSpeech** is an open-source toolkit on [PaddlePaddle](https://github.com/PaddlePaddle/Paddle) platform for a variety of critical tasks in speech and audio, with the state-of-art and influential models.
##### Speech-to-Text
@@ -51,81 +52,101 @@ from https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readme
| 我认为跑步最重要的就是给我带来了身体健康。 |
+
-##### Text-to-Speech
+##### Speech Translation (English to Chinese)
+
- ![]() Input Text ![]() |
- Synthetic Audio |
+ Input Audio |
+ Translations Result |
- | Life was like a box of chocolates, you never know what you're gonna get. |
-
-
- 
- |
-
-
- | 早上好，今天是2020/10/29，最低温度是-3°C。 |
-
-
+
+
|
+ 我 在 这栋 建筑 的 古老 门上 敲门。 |
-For more synthesized audios, please refer to [PaddleSpeech Text-to-Speech samples](https://paddlespeech.readthedocs.io/en/latest/tts/demo.html).
-
-##### Speech Translation
-
+##### Text-to-Speech
- | Input Audio |
- Translations Result |
+ ![]() Input Text ![]() |
+ Synthetic Audio |
+ | Life was like a box of chocolates, you never know what you're gonna get. |
-
-
+
+
+ |
+
+
+ | 早上好，今天是2020/10/29，最低温度是-3°C。 |
+
+
+
|
- 我 在 这栋 建筑 的 古老 门上 敲门。 |
+For more synthesized audios, please refer to [PaddleSpeech Text-to-Speech samples](https://paddlespeech.readthedocs.io/en/latest/tts/demo.html).
+
+### Features:
+
Via the easy-to-use, efficient, flexible and scalable implementation, our vision is to empower both industrial application and academic research, including training, inference & testing modules, and deployment process. To be more specific, this toolkit features at:
-- **Ease of Use**: low barries to install, and [CLI](#quick-start) is available to quick-start your journey.
-- **Align to the State-of-the-Art**: we provide high-speed and ultra-lightweight models, and also cutting edge technology.
-- **Rule-based Chinese frontend**: our frontend contains Text Normalization and Grapheme-to-Phoneme (G2P, including Polyphone and Tone Sandhi). Moreover, we use self-defined linguistic rules to adapt Chinese context.
+- 📦 **Ease of Use**: low barriers to install, and [CLI](#quick-start) is available to quick-start your journey.
+- 🏆 **Align to the State-of-the-Art**: we provide high-speed and ultra-lightweight models, and also cutting-edge technology.
+- 💯 **Rule-based Chinese frontend**: our frontend contains Text Normalization and Grapheme-to-Phoneme (G2P, including Polyphone and Tone Sandhi). Moreover, we use self-defined linguistic rules to adapt Chinese context.
- **Varieties of Functions that Vitalize both Industrial and Academia**:
- - *Implementation of critical audio tasks*: this toolkit contains audio functions like Audio Classification, Speech Translation, Automatic Speech Recognition, Text-to-Speech Synthesis, etc.
- - *Integration of mainstream models and datasets*: the toolkit implements modules that participate in the whole pipeline of the speech tasks, and uses mainstream datasets like LibriSpeech, LJSpeech, AIShell, CSMSC, etc. See also [model list](#model-list) for more details.
- - *Cascaded models application*: as an extension of the typical traditional audio tasks, we combine the workflows of the aforementioned tasks with other fields like Natural language processing (NLP) and Computer Vision (CV).
+ - 🛎️ *Implementation of critical audio tasks*: this toolkit contains audio functions like Audio Classification, Speech Translation, Automatic Speech Recognition, Text-to-Speech Synthesis, etc.
+ - 🔬 *Integration of mainstream models and datasets*: the toolkit implements modules that participate in the whole pipeline of the speech tasks, and uses mainstream datasets like LibriSpeech, LJSpeech, AIShell, CSMSC, etc. See also [model list](#model-list) for more details.
+ - 🧩 *Cascaded models application*: as an extension of the typical traditional audio tasks, we combine the workflows of the aforementioned tasks with other fields like Natural language processing (NLP) and Computer Vision (CV).
+
+
+### Recent Update:
+
+
+- 🤗 2021.12.14: Our PaddleSpeech [ASR](https://huggingface.co/spaces/KPatrick/PaddleSpeechASR) and [TTS](https://huggingface.co/spaces/akhaliq/paddlespeech) Demos on Hugging Face Spaces are available!
+- 👏🏻 2021.12.10: PaddleSpeech CLI is available for Audio Classification, Automatic Speech Recognition, Speech Translation (English to Chinese) and Text-to-Speech.
+
+### Communication
+If you are in China, we recommend you to join our WeChat group to contact directly with our team members!
+
+
+
+
+
- | Acoustic Model |
+ Speech Recogination |
Aishell |
DeepSpeech2 RNN + Conv based Models |
@@ -219,6 +239,20 @@ The current hyperlinks redirect to [Previous Parakeet](https://github.com/Paddle
u2-timit
|
+
+ | Speech Translation (English to Chinese) |
+ TED En-Zh |
+ Transformer + ASR MTL |
+
+ transformer-ted
+ |
+
+
+ | FAT + Transformer + ASR MTL |
+
+ fat-st-ted
+ |
+
@@ -316,7 +350,7 @@ The current hyperlinks redirect to [Previous Parakeet](https://github.com/Paddle
-**Others**
+**Audio Classification**
@@ -328,6 +362,7 @@ The current hyperlinks redirect to [Previous Parakeet](https://github.com/Paddle
+
| Audio Classification |
ESC-50 |
@@ -336,52 +371,30 @@ The current hyperlinks redirect to [Previous Parakeet](https://github.com/Paddle
pann-esc50
-
- | Speech Translation (English to Chinese) |
- TED En-Zh |
- Transformer + ASR MTL |
-
- transformer-ted
- |
-
-
- | FAT + Transformer + ASR MTL |
-
- fat-st-ted
- |
-
-
-## Tutorials
+## Documents
Normally, [Speech SoTA](https://paperswithcode.com/area/speech), [Audio SoTA](https://paperswithcode.com/area/audio) and [Music SoTA](https://paperswithcode.com/area/music) give you an overview of the hot academic topics in the related area. To focus on the tasks in PaddleSpeech, you will find the following guidelines are helpful to grasp the core ideas.
-- [Overview](./docs/source/introduction.md)
- [Installation](./docs/source/install.md)
-- Speech-to-Text
- - [Quick Start of Speech-to-Text](./docs/source/asr/quick_start.md)
- - [Models Introduction](./docs/source/asr/models_introduction.md)
- - [Data Preparation](./docs/source/asr/data_preparation.md)
- - [Data Augmentation Pipeline](./docs/source/asr/augmentation.md)
- - [Features](./docs/source/asr/feature_list.md)
- - [Ngram LM](./docs/source/asr/ngram_lm.md)
-- Text-to-Speech
- - [Quick Start of Text-to-Speech](./docs/source/tts/quick_start.md)
- - [Introduction](./docs/source/tts/models_introduction.md)
- - [Advanced Usage](./docs/source/tts/advanced_usage.md)
- - [Chinese Rule Based Text Frontend](./docs/source/tts/zh_text_frontend.md)
- - [Test Audio Samples](https://paddlespeech.readthedocs.io/en/latest/tts/demo.html) and [PaddleSpeech VS. Espnet](https://paddlespeech.readthedocs.io/en/latest/tts/demo_2.html)
-- Audio Classification
-- Speech Translation
+- Tutorials
+ - [Automatic Speech Recognition](./docs/source/asr/quick_start.md)
+ - [Introduction](./docs/source/asr/models_introduction.md)
+ - [Data Preparation](./docs/source/asr/data_preparation.md)
+ - [Data Augmentation](./docs/source/asr/augmentation.md)
+ - [Ngram LM](./docs/source/asr/ngram_lm.md)
+ - [Text-to-Speech](./docs/source/tts/quick_start.md)
+ - [Introduction](./docs/source/tts/models_introduction.md)
+ - [Advanced Usage](./docs/source/tts/advanced_usage.md)
+ - [Chinese Rule Based Text Frontend](./docs/source/tts/zh_text_frontend.md)
+ - [Test Audio Samples](https://paddlespeech.readthedocs.io/en/latest/tts/demo.html)
+ - Audio Classification
+ - Speech Translation
- [Released Models](./docs/source/released_model.md)
-The TTS module is originally called [Parakeet](https://github.com/PaddlePaddle/Parakeet), and now merged with DeepSpeech. If you are interested in academic research about this function, please see [TTS research overview](https://github.com/PaddlePaddle/PaddleSpeech/tree/develop/docs/source/tts#overview). Also, [this document](https://github.com/PaddlePaddle/PaddleSpeech/blob/develop/docs/source/tts/models_introduction.md) is a good guideline for the pipeline components.
-
-## FAQ and Contributing
-
-You are warmly welcome to submit questions in [discussions](https://github.com/PaddlePaddle/PaddleSpeech/discussions) and bug reports in [issues](https://github.com/PaddlePaddle/PaddleSpeech/issues)! Also, we highly appreciate if you would like to contribute to this project!
+The Text-to-Speech module is originally called [Parakeet](https://github.com/PaddlePaddle/Parakeet), and now merged with this repository. If you are interested in academic research about this task, please see [TTS research overview](https://github.com/PaddlePaddle/PaddleSpeech/tree/develop/docs/source/tts#overview). Also, [this document](https://github.com/PaddlePaddle/PaddleSpeech/blob/develop/docs/source/tts/models_introduction.md) is a good guideline for the pipeline components.
## Citation
@@ -395,8 +408,54 @@ year={2021}
}
```
-## License and Acknowledge
+## Contribute to PaddleSpeech
-PaddleSpeech is provided under the [Apache-2.0 License](./LICENSE).
+You are warmly welcome to submit questions in [discussions](https://github.com/PaddlePaddle/PaddleSpeech/discussions) and bug reports in [issues](https://github.com/PaddlePaddle/PaddleSpeech/issues)! Also, we highly appreciate if you are willing to contribute to this project!
+
+### Contributors
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-PaddleSpeech depends on a lot of open source repositories. See [references](./docs/source/reference.md) for more information.
+## Acknowledgement
+
+- Many thanks to [yeyupiaoling](https://github.com/yeyupiaoling) for years of attention, constructive advice and great help.
+- Many thanks to [AK391](https://github.com/AK391) for TTS web demo on Huggingface Spaces using Gradio.
+
+Besides, PaddleSpeech depends on a lot of open source repositories. See [references](./docs/source/reference.md) for more information.
+
+## License
+
+PaddleSpeech is provided under the [Apache-2.0 License](./LICENSE).
diff --git a/docs/images/wechat_group.png b/docs/images/wechat_group.png
new file mode 100644
index 00000000..fe448398
Binary files /dev/null and b/docs/images/wechat_group.png differ