diff --git a/README.md b/README.md index 9a049df8d47de543b9dcb78f04ff7983ceb5388a..76d29bacb1cf19fddff0737b124ac3d978839501 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,12 @@ -English | [简体中文](README_ch.md) - -# PaddleSpeech - - -

- +

Quick Start | Tutorials - | Models List + | Models List

------------------------------------------------------------------------------------ @@ -21,62 +15,111 @@ English | [简体中文](README_ch.md) ![support os](https://img.shields.io/badge/os-linux-yellow.svg) -**PaddleSpeech** is an open-source toolkit on [PaddlePaddle](https://github.com/PaddlePaddle/Paddle) platform for a variety of critical tasks in speech, with state-of-art and influential models. +**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 + +
+ + + + + + + + + + + + + + + + + +
Input Audio Recognition Result
+ +
+ 		I knocked at the door on the ancient side of the building.
+ +
+ 		我认为跑步最重要的就是给我带来了身体健康。
+ +
+ +##### Text-To-Speech +
+ + + + + + + + + + + + + + + + + +
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). 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 (TN) and Grapheme-to-Phoneme (G2P, including Polyphone and Tone Sandhi). Moreover, we use self-defined linguistic rules to adapt Chinese context. +- **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 (ST), Automatic Speech Recognition (ASR), Text-To-Speech Synthesis (TTS), Voice Cloning(VC), Punctuation Restoration, etc. + - *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. - - *Cross-domain application*: as an extension of the application of traditional audio tasks, we combine the aforementioned tasks with other fields like NLP. + - *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. -Let's install PaddleSpeech with only a few lines of code! +# Community ->Note: The official name is still deepspeech. 2021/10/26 +You are warmly welcome to submit questions in [discussions](https://github.com/PaddlePaddle/DeepSpeech/discussions) and bug reports in [issues](https://github.com/PaddlePaddle/DeepSpeech/issues)! Also, we highly appreciate if you would like to contribute to this project! -If you are using Ubuntu, PaddleSpeech can be set up with pip installation (with root privilege). -```shell -git clone https://github.com/PaddlePaddle/DeepSpeech.git -cd DeepSpeech -pip install -e . -``` +If you are from China, we strongly recommend you join our PaddleSpeech WeChat group. Scan the following WeChat QR code and get in touch with the other developers in this community! -## Table of Contents +
+ -The contents of this README is as follow: -- [Alternative Installation](#alternative-installation) -- [Quick Start](#quick-start) -- [Models List](#models-list) -- [Tutorials](#tutorials) -- [FAQ and Contributing](#faq-and-contributing) -- [License](#license) -- [Acknowledgement](#acknowledgement) +
-## Alternative Installation +# Alternative Installation The base environment in this page is - Ubuntu 16.04 - python>=3.7 - paddlepaddle==2.1.2 -If you want to set up PaddleSpeech in other environment, please see the [ASR installation](docs/source/asr/install.md) and [TTS installation](docs/source/tts/install.md) documents for all the alternatives. +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 -> Note: the current links to `English ASR` and `English TTS` are not valid. - -Just a quick test of our functions: [English ASR](link/hubdetail?name=deepspeech2_aishell&en_category=AutomaticSpeechRecognition) and [English TTS](link/hubdetail?name=fastspeech2_baker&en_category=TextToSpeech) by typing message or upload your own audio file. +# Quick Start Developers can have a try of our model with only a few lines of code. -A tiny **ASR** DeepSpeech2 model training on toy set of LibriSpeech: +A tiny DeepSpeech2 **Speech-To-Text** model training on toy set of LibriSpeech: -```bash +```shell cd examples/tiny/s0/ # source the environment source path.sh @@ -86,9 +129,8 @@ bash local/data.sh bash local/test.sh conf/deepspeech2.yaml ckptfile offline ``` -For **TTS**, try pretrained FastSpeech2 + Parallel WaveGAN on CSMSC: - -```bash +For **Text-To-Speech**, try pretrained FastSpeech2 + Parallel WaveGAN on CSMSC: +```shell cd examples/csmsc/tts3 # download the pretrained models and unaip them wget https://paddlespeech.bj.bcebos.com/Parakeet/pwg_baker_ckpt_0.4.zip @@ -112,28 +154,24 @@ python3 ${BIN_DIR}/synthesize_e2e.py \ --inference-dir=exp/default/inference \ --device="gpu" \ --phones-dict=fastspeech2_nosil_baker_ckpt_0.4/phone_id_map.txt - ``` -If you want to try more functions like training and tuning, please see [ASR getting started](docs/source/asr/getting_started.md) and [TTS Basic Use](/docs/source/tts/basic_usage.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 +# Models List -PaddleSpeech supports a series of most popular models, summarized in [released models](./docs/source/released_model.md) with available pretrained models. +PaddleSpeech supports a series of most popular models, summarized in [released models](./docs/source/released_models.md) with available pretrained models. -ASR 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: -> Note: The `Link` should be code path rather than download links. - - - +
- + @@ -141,76 +179,61 @@ The current hyperlinks redirect to [Previous Parakeet](https://github.com/Paddle - - - - - - - + + + - + - - - - - - - - - - + + - - - - - - - - - + + + + + + + + + - + +
ASR Module TypeSpeech-To-Text Module Type Dataset Model Type Link
Acoustic ModelAishell2 Conv + 5 LSTM layers with only forward direction - Ds2 Online Aishell Model -
2 Conv + 3 bidirectional GRU layersAcoustic ModelAishellDeepSpeech2 RNN + Conv based Models - Ds2 Offline Aishell Model + deepspeech2-aishell
Encoder:Conformer, Decoder:Transformer, Decoding method: Attention + CTCTransformer based Attention Models - Conformer Offline Aishell Model -
Encoder:Conformer, Decoder:Transformer, Decoding method: Attention - Conformer Librispeech Model + u2.transformer.conformer-aishell
LibrispeechEncoder:Conformer, Decoder:Transformer, Decoding method: Attention Conformer Librispeech Model
Encoder:Transformer, Decoder:Transformer, Decoding method: Attention LibrispeechTransformer based Attention Models - Transformer Librispeech Model + deepspeech2-librispeech / transformer.conformer.u2-librispeech / transformer.conformer.u2-kaldi-librispeech
Language ModelCommonCrawl(en.00)English Language Model - English Language Model
Baidu Internal CorpusMandarin Language Model Small
AlignmentTHCHS30MFA + mfa-thchs30 +
Language ModelNgram Language Model - Mandarin Language Model Small + kenlm
Mandarin Language Model LargeTIMITUnified Streaming & Non-streaming Two-pass - Mandarin Language Model Large + u2-timit
- -PaddleSpeech TTS 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: - - - - + + + + @@ -218,15 +241,15 @@ PaddleSpeech TTS mainly contains three modules: *Text Frontend*, *Acoustic Model - + @@ -243,28 +266,14 @@ PaddleSpeech TTS mainly contains three modules: *Text Frontend*, *Acoustic Model - - - - - - - - - - - - - - + + - + - - - - - - - - - - + + @@ -309,30 +306,44 @@ PaddleSpeech TTS mainly contains three modules: *Text Frontend*, *Acoustic Model
TTS Module TypeModel TypeDatasetLink Text-To-Speech Module Type Model Type Dataset Link
Text Frontend   - chinese-fronted + tn / g2p
Acoustic ModelAcoustic Model Tacotron2 LJSpeech - tacotron2-vctk + tacotron2-ljspeech
FastSpeech2AISHELL-3 - fastspeech2-aishell3 -
VCTK fastspeech2-vctk
LJSpeech fastspeech2-ljspeech
CSMSCFastSpeech2AISHELL-3 / VCTK / LJSpeech / CSMSC - fastspeech2-csmsc + fastspeech2-aishell3 / fastspeech2-vctk / fastspeech2-ljspeech / fastspeech2-csmsc
VocoderVocoder WaveFlow LJSpeech @@ -272,22 +281,10 @@ PaddleSpeech TTS mainly contains three modules: *Text Frontend*, *Acoustic Model
Parallel WaveGANLJSpeech - PWGAN-ljspeech -
VCTK - PWGAN-vctk -
CSMSCParallel WaveGANLJSpeech / VCTK / CSMSC - PWGAN-csmsc + PWGAN-ljspeech / PWGAN-vctk / PWGAN-csmsc
- -## Tutorials - -Normally, [Speech SoTA](https://paperswithcode.com/area/speech) gives you an overview of the hot academic topics in speech. If you want to focus on the two tasks in PaddleSpeech, you will find the following guidelines are helpful to grasp the core ideas. - -The original ASR module is based on [Baidu's DeepSpeech](https://arxiv.org/abs/1412.5567) which is an independent product named [DeepSpeech](https://deepspeech.readthedocs.io). However, the toolkit aligns almost all the SoTA modules in the pipeline. Specifically, these modules are - -* [Data Prepration](docs/source/asr/data_preparation.md) -* [Data Augmentation](docs/source/asr/augmentation.md) -* [Ngram LM](docs/source/asr/ngram_lm.md) -* [Benchmark](docs/source/asr/benchmark.md) -* [Relased Model](docs/source/asr/released_model.md) +# Tutorials + +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 + - [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 + - [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) +- [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/DeepSpeech/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 - +# FAQ and Contributing You are warmly welcome to submit questions in [discussions](https://github.com/PaddlePaddle/DeepSpeech/discussions) and bug reports in [issues](https://github.com/PaddlePaddle/DeepSpeech/issues)! Also, we highly appreciate if you would like to contribute to this project! -## License - +# License and Acknowledgement PaddleSpeech is provided under the [Apache-2.0 License](./LICENSE). -## Acknowledgement - -PaddleSpeech depends on a lot of open source repos. See [references](docs/source/reference.md) for more information. +PaddleSpeech depends on a lot of open source repositories. See [references](./docs/source/reference.md) for more information. + +# Citation +To cite PaddleSpeech for research, please use the following format. +```tex +@misc{ppspeech2021, +title={PaddleSpeech, a toolkit for audio processing based on PaddlePaddle.}, +author={PaddlePaddle Authors}, +howpublished = {\url{https://github.com/PaddlePaddle/DeepSpeech}}, +year={2021} +} +``` diff --git a/docs/images/PaddleSpeech_log.png b/docs/images/PaddleSpeech_logo.png similarity index 100% rename from docs/images/PaddleSpeech_log.png rename to docs/images/PaddleSpeech_logo.png diff --git a/docs/images/wechat-code-speech.png b/docs/images/wechat-code-speech.png new file mode 100644 index 0000000000000000000000000000000000000000..472515195bc369c8457c111626fc9504899baf6e Binary files /dev/null and b/docs/images/wechat-code-speech.png differ