Here place an icon/image as the logo at the beginning like PaddleOCR/PaddleNLP.
Is there any idea to add Parakeet logo(https://github.com/PaddlePaddle/Parakeet/blob/develop/docs/images/logo.png) into this .md document?
-->
> Notes: 1.Here place an icon/image as the logo at the beginning like PaddleOCR or PaddleNLP; 2. Is there any idea to add [Parakeet logo](https://github.com/PaddlePaddle/Parakeet/blob/develop/docs/images/logo.png) into this .md document?
<!---
README.me should include:
why they should use your module,
how they can install it,
how they can use it
@ -19,23 +16,23 @@ how they can use it
**PaddleSpeech** is an open-source toolkit on [PaddlePaddle](https://github.com/PaddlePaddle/Paddle) platform for two critical tasks in Speech - Automatic Speech Recognition (ASR) and Text-To-Speech Synthesis (TTS), with modules involving state-of-art and influential models.
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Guidelines of DeepSpeech Pipeline](#guidelines-of-deepspeech-pipeline)
- [Example Overview](#example-overview)
- [Guidelines of Pipeline](#guidelines-of-pipeline)
- [FAQ and Contributing](#faq-and-contributing)
- [Acknowledgement](#acknowledgement)
- [License](#license)
- [Acknowledgement](#acknowledgement)
## 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 module, and deployment.
<!---
1.The following features are summarized from docs/source/asr/feature_list.md, please add the features of Parakeet @yt605155624 :-)
2.Better add hyperlinks for code path/dir
-->
> Note: 1.Better add hyperlinks for code path; 2.The current `Features` is a bit long. Is there any idea to shorten this section?
The features of **ASR** are summarized as follows:
- **Used datasets**
@ -58,21 +55,43 @@ The features of **ASR** are summarized as follows:
The features of **TTS** are summarized as follows:
For more detailed description, please refer to [ASR released models](docs/source/asr/released_model.md) and [TTS released models](docs/source/tts/released_models.md)
## Guidelines of Pipeline
@ -98,4 +117,6 @@ DeepSpeech is provided under the [Apache-2.0 License](./LICENSE).
DeepSpeech depends on many open source repos. See [References](docs/source/asr/reference.md) for more information.
<code>**Updates on 2021/10/20**: This [README.md](README.md) outline is not completed, especially for TTS module *from section **Features***. </code>
<code>**Updates on 2021/10/20**: This [README.md](README.md) outline is not completed, especially *from section **Getting Started***. </code>