@@ -24,7 +25,7 @@ from https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readme
**PaddleSpeech** is an open-source toolkit on [PaddlePaddle](https://github.com/PaddlePaddle/Paddle) platform for a variety of critical tasks in speech, with the state-of-art and influential models.
##### Speech-To-Text
##### Speech-to-Text
<divalign = "center">
<tablestyle="width:100%">
...
...
@@ -54,7 +55,7 @@ from https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readme
</div>
##### Text-To-Speech
##### Text-to-Speech
<divalign = "center">
<tablestyle="width:100%">
<thead>
...
...
@@ -83,30 +84,30 @@ from https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readme
</div>
For more synthesized audios, please refer to [PaddleSpeech Text-To-Speech samples](https://paddlespeech.readthedocs.io/en/latest/tts/demo.html).
For more synthesized audios, please refer to [PaddleSpeech Text-to-Speech samples](https://paddlespeech.readthedocs.io/en/latest/tts/demo.html).
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:
-**Fast and Light-weight**: we provide high-speed and ultra-lightweight models that are convenient for industrial deployment.
-**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 Speech Translation, Automatic Speech Recognition, Text-To-Speech Synthesis, Voice Cloning, 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 lists](#models-list) for more details.
-*Implementation of critical audio tasks*: this toolkit contains audio functions like Speech Translation, Automatic Speech Recognition, Text-to-Speech Synthesis, Voice Cloning, 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 application of traditional audio tasks, we combine the workflows of aforementioned tasks with other fields like Natural language processing (NLP), like Punctuation Restoration.
# Alternative Installation
## Installation
The base environment in this page is
- Ubuntu 16.04
- python>=3.7
- paddlepaddle>=2.2.0-rc
- paddlepaddle>=2.2.0
If you want to set up PaddleSpeech in other environment, please see the [installation](./docs/source/install.md) documents for all the alternatives.
# Quick Start
## Quick Start
Developers can have a try of our model with only a few lines of code.
A tiny DeepSpeech2 **Speech-To-Text** model training on toy set of LibriSpeech:
A tiny DeepSpeech2 **Speech-to-Text** model training on toy set of LibriSpeech:
If you want to try more functions like training and tuning, please see [Speech-To-Text Quick Start](./docs/source/asr/quick_start.md) and [Text-To-Speech Quick Start](./docs/source/tts/quick_start.md).
If you want to try more functions like training and tuning, please see [Speech-to-Text Quick Start](./docs/source/asr/quick_start.md) and [Text-To-Speech Quick Start](./docs/source/tts/quick_start.md).
# Models List
## Model List
PaddleSpeech supports a series of most popular models, summarized in [released models](./docs/source/released_models.md) with available pretrained models.
Speech-To-Text module contains *Acoustic Model* and *Language Model*, with the following details:
Speech-to-Text module contains *Acoustic Model* and *Language Model*, with the following details:
<!---
The current hyperlinks redirect to [Previous Parakeet](https://github.com/PaddlePaddle/Parakeet/tree/develop/examples).
...
...
@@ -164,7 +165,7 @@ The current hyperlinks redirect to [Previous Parakeet](https://github.com/Paddle
<tablestyle="width:100%">
<thead>
<tr>
<th>Speech-To-Text Module Type</th>
<th>Speech-to-Text Module Type</th>
<th>Dataset</th>
<th>Model Type</th>
<th>Link</th>
...
...
@@ -218,12 +219,12 @@ The current hyperlinks redirect to [Previous Parakeet](https://github.com/Paddle
</tbody>
</table>
PaddleSpeech Text-To-Speech mainly contains three modules: *Text Frontend*, *Acoustic Model* and *Vocoder*. Acoustic Model and Vocoder models are listed as follow:
PaddleSpeech Text-to-Speech mainly contains three modules: *Text Frontend*, *Acoustic Model* and *Vocoder*. Acoustic Model and Vocoder models are listed as follow:
<table>
<thead>
<tr>
<th> Text-To-Speech Module Type <imgwidth="110"height="1"></th>
<th> Text-to-Speech Module Type <imgwidth="110"height="1"></th>
Normally, [Speech SoTA](https://paperswithcode.com/area/speech) gives you an overview of the hot academic topics in speech. 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)
- Quick Start
-[Dependencies](./docs/source/dependencies.md) and [Installation](./docs/source/install.md)
-[Quick Start of Speech-To-Text](./docs/source/asr/quick_start.md)
-[Quick Start of Text-To-Speech](./docs/source/tts/quick_start.md)
- Speech-To-Text
-[Quick Start of Speech-to-Text](./docs/source/asr/quick_start.md)
-[Quick Start of Text-to-Speech](./docs/source/tts/quick_start.md)
-[Chinese Rule Based Text Frontend](./docs/source/tts/zh_text_frontend.md)
...
...
@@ -322,15 +324,12 @@ Normally, [Speech SoTA](https://paperswithcode.com/area/speech) gives you an ove
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://paddleparakeet.readthedocs.io/en/latest/released_models.html) 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!
## FAQ and Contributing
# License and Acknowledgement
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 would like to contribute to this project!
PaddleSpeech depends on a lot of open source repositories. See [references](./docs/source/reference.md) for more information.
## Citation
# Citation
To cite PaddleSpeech for research, please use the following format.
This example contains code used to train a [Speedyspeech](http://arxiv.org/abs/2008.03802) model with [Chinese Standard Mandarin Speech Copus](https://www.data-baker.com/open_source.html). NOTE that we only implement the student part of the Speedyspeech model. The ground truth alignment used to train the model is extracted from the dataset using [MFA](https://github.com/MontrealCorpusTools/Montreal-Forced-Aligner).
# SpeedySpeech with CSMSC
This example contains code used to train a [SpeedySpeech](http://arxiv.org/abs/2008.03802) model with [Chinese Standard Mandarin Speech Copus](https://www.data-baker.com/open_source.html). NOTE that we only implement the student part of the Speedyspeech model. The ground truth alignment used to train the model is extracted from the dataset using [MFA](https://github.com/MontrealCorpusTools/Montreal-Forced-Aligner).
