README.md 24.5 KB
Newer Older
G
grasswolfs 已提交
1 2
([简体中文](./README_cn.md)|English)

M
Mingxue-Xu 已提交
3
<p align="center">
M
Mingxue-Xu 已提交
4
  <img src="./docs/images/PaddleSpeech_logo.png" />
M
Mingxue-Xu 已提交
5 6 7 8 9
</p>
<div align="center">  

  <h3>
  <a href="#quick-start"> Quick Start </a>
M
Mingxue-Xu 已提交
10
  | <a href="#documents"> Documents </a>
Z
Zeyu Chen 已提交
11
  | <a href="#model-list"> Models List </a>
M
Mingxue-Xu 已提交
12 13 14
</div>

------------------------------------------------------------------------------------
Z
Zeyu Chen 已提交
15

G
grasswolfs 已提交
16 17

<p align="center">
小湉湉's avatar
小湉湉 已提交
18
    <a href="./LICENSE"><img src="https://img.shields.io/badge/license-Apache%202-red.svg"></a>
H
Hui Zhang 已提交
19 20
    <a href="https://github.com/PaddlePaddle/PaddleSpeech/releases"><img src="https://img.shields.io/github/v/release/PaddlePaddle/PaddleSpeech?color=ffa"></a>
    <a href="support os"><img src="https://img.shields.io/badge/os-linux%2C%20win%2C%20mac-pink.svg"></a>
小湉湉's avatar
小湉湉 已提交
21 22 23
    <a href=""><img src="https://img.shields.io/badge/python-3.7+-aff.svg"></a>
    <a href="https://github.com/PaddlePaddle/PaddleSpeech/graphs/contributors"><img src="https://img.shields.io/github/contributors/PaddlePaddle/PaddleSpeech?color=9ea"></a>
    <a href="https://github.com/PaddlePaddle/PaddleSpeech/commits"><img src="https://img.shields.io/github/commit-activity/m/PaddlePaddle/PaddleSpeech?color=3af"></a>
G
grasswolfs 已提交
24 25
    <a href="https://github.com/PaddlePaddle/PaddleSpeech/issues"><img src="https://img.shields.io/github/issues/PaddlePaddle/PaddleSpeech?color=9cc"></a>
    <a href="https://github.com/PaddlePaddle/PaddleSpeech/stargazers"><img src="https://img.shields.io/github/stars/PaddlePaddle/PaddleSpeech?color=ccf"></a>
H
Hui Zhang 已提交
26 27
    <a href="=https://pypi.org/project/paddlespeech/"><img src="https://img.shields.io/pypi/dm/PaddleSpeech"></a>
    <a href="=https://pypi.org/project/paddlespeech/"><img src="https://static.pepy.tech/badge/paddlespeech"></a>
D
DanielYang 已提交
28
    <a href="https://huggingface.co/spaces"><img src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue"></a>
G
grasswolfs 已提交
29
</p>
L
lfchener 已提交
30

M
Mingxue-Xu 已提交
31

32
**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.
M
Mingxue-Xu 已提交
33

H
Hui Zhang 已提交
34
##### Speech Recognition
M
Mingxue-Xu 已提交
35 36 37 38 39 40

<div align = "center">
<table style="width:100%">
  <thead>
    <tr>
      <th> Input Audio  </th>
M
Mingxue-Xu 已提交
41
      <th width="550"> Recognition Result  </th>
M
Mingxue-Xu 已提交
42 43 44 45 46
    </tr>
  </thead>
  <tbody>
   <tr>
      <td align = "center">
M
Mingxue-Xu 已提交
47
      <a href="https://paddlespeech.bj.bcebos.com/PaddleAudio/en.wav" rel="nofollow">
M
Mingxue-Xu 已提交
48
            <img align="center" src="./docs/images/audio_icon.png" width="200 style="max-width: 100%;"></a><br>
M
Mingxue-Xu 已提交
49
      </td>
M
Mingxue-Xu 已提交
50
      <td >I knocked at the door on the ancient side of the building.</td>
M
Mingxue-Xu 已提交
51 52 53
    </tr>
    <tr>
      <td align = "center">
M
Mingxue-Xu 已提交
54
      <a href="https://paddlespeech.bj.bcebos.com/PaddleAudio/zh.wav" rel="nofollow">
M
Mingxue-Xu 已提交
55
            <img align="center" src="./docs/images/audio_icon.png" width="200" style="max-width: 100%;"></a><br>
M
Mingxue-Xu 已提交
56
      </td>
M
Mingxue-Xu 已提交
57
      <td>我认为跑步最重要的就是给我带来了身体健康。</td>
M
Mingxue-Xu 已提交
58
    </tr>
M
Mingxue-Xu 已提交
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
  </tbody>
</table>

</div>

##### Speech Translation (English to Chinese)

<div align = "center">
<table style="width:100%">
  <thead>
    <tr>
      <th> Input Audio  </th>
      <th width="550"> Translations Result  </th>
    </tr>
  </thead>
  <tbody>
   <tr>
      <td align = "center">
      <a href="https://paddlespeech.bj.bcebos.com/PaddleAudio/en.wav" rel="nofollow">
            <img align="center" src="./docs/images/audio_icon.png" width="200 style="max-width: 100%;"></a><br>
      </td>
      <td >我 在 这栋 建筑 的 古老 门上 敲门。</td>
    </tr>
M
Mingxue-Xu 已提交
82 83 84 85
  </tbody>
</table>

</div>
86

Z
Zeyu Chen 已提交
87
##### Text-to-Speech
M
Mingxue-Xu 已提交
88 89 90 91
<div align = "center">
<table style="width:100%">
  <thead>
    <tr>
小湉湉's avatar
小湉湉 已提交
92
      <th width="550" > Input Text</th>
M
Mingxue-Xu 已提交
93 94 95 96 97 98 99
      <th>Synthetic Audio</th>
    </tr>
  </thead>
  <tbody>
   <tr>
      <td >Life was like a box of chocolates, you never know what you're gonna get.</td>
      <td align = "center">
小湉湉's avatar
小湉湉 已提交
100
      <a href="https://paddlespeech.bj.bcebos.com/Parakeet/docs/demos/tacotron2_ljspeech_waveflow_samples_0.2/sentence_1.wav" rel="nofollow">
M
Mingxue-Xu 已提交
101 102 103 104 105 106 107 108 109 110
            <img align="center" src="./docs/images/audio_icon.png" width="200" style="max-width: 100%;"></a><br>
      </td>
    </tr>
    <tr>
      <td >早上好,今天是2020/10/29,最低温度是-3°C。</td>
      <td align = "center">
      <a href="https://paddlespeech.bj.bcebos.com/Parakeet/docs/demos/parakeet_espnet_fs2_pwg_demo/tn_g2p/parakeet/001.wav" rel="nofollow">
            <img align="center" src="./docs/images/audio_icon.png" width="200" style="max-width: 100%;"></a><br>
      </td>
    </tr>
小湉湉's avatar
小湉湉 已提交
111 112 113 114 115 116 117
    <tr>
      <td >季姬寂,集鸡,鸡即棘鸡。棘鸡饥叽,季姬及箕稷济鸡。鸡既济,跻姬笈,季姬忌,急咭鸡,鸡急,继圾几,季姬急,即籍箕击鸡,箕疾击几伎,伎即齑,鸡叽集几基,季姬急极屐击鸡,鸡既殛,季姬激,即记《季姬击鸡记》。</td>
      <td align = "center">
      <a href="https://paddlespeech.bj.bcebos.com/Parakeet/docs/demos/jijiji.wav" rel="nofollow">
            <img align="center" src="./docs/images/audio_icon.png" width="200" style="max-width: 100%;"></a><br>
      </td>
    </tr>
M
Mingxue-Xu 已提交
118 119 120 121 122
  </tbody>
</table>

</div>

Z
Zeyu Chen 已提交
123
For more synthesized audios, please refer to [PaddleSpeech Text-to-Speech samples](https://paddlespeech.readthedocs.io/en/latest/tts/demo.html).
小湉湉's avatar
小湉湉 已提交
124

小湉湉's avatar
小湉湉 已提交
125
##### Punctuation Restoration
K
KP 已提交
126 127 128 129
<div align = "center">
<table style="width:100%">
  <thead>
    <tr>
小湉湉's avatar
小湉湉 已提交
130 131
      <th width="390"> Input Text </th>
      <th width="390"> Output Text </th>
K
KP 已提交
132 133 134 135 136 137 138 139 140 141 142 143
    </tr>
  </thead>
  <tbody>
   <tr>
      <td>今天的天气真不错啊你下午有空吗我想约你一起去吃饭</td>
      <td>今天的天气真不错啊!你下午有空吗?我想约你一起去吃饭。</td>
    </tr>
  </tbody>
</table>

</div>

144 145 146 147 148
### ⭐ Examples
- **[PaddleBoBo](https://github.com/JiehangXie/PaddleBoBo): Use PaddleSpeech TTS to generate virtual human voice.**
  
<div align="center"><a href="https://www.bilibili.com/video/BV1cL411V71o?share_source=copy_web"><img src="https://ai-studio-static-online.cdn.bcebos.com/06fd746ab32042f398fb6f33f873e6869e846fe63c214596ae37860fe8103720" / width="500px"></a></div>

小湉湉's avatar
小湉湉 已提交
149
- [PaddleSpeech Demo Video](https://paddlespeech.readthedocs.io/en/latest/demo_video.html)
150

151 152 153 154 155 156 157 158 159
### 🔥 Hot Activities

- 2021.12.21~12.24

  4 Days Live Courses: Depth interpretation of PaddleSpeech!

  **Courses videos and related materials: https://aistudio.baidu.com/aistudio/education/group/info/25130**

### Features
160

M
Mingxue-Xu 已提交
161
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:
小湉湉's avatar
小湉湉 已提交
162 163 164
- 📦  **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.
M
Mingxue-Xu 已提交
165
- **Varieties of Functions that Vitalize both Industrial and Academia**:
小湉湉's avatar
小湉湉 已提交
166 167 168
  - 🛎️  *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).
M
Mingxue-Xu 已提交
169

170
### Recent Update
M
Mingxue-Xu 已提交
171 172 173 174

<!---
2021.12.14: We would like to have an online courses to introduce basics and research of speech, as well as code practice with `paddlespeech`. Please pay attention to our [Calendar](https://www.paddlepaddle.org.cn/live).
--->
小湉湉's avatar
小湉湉 已提交
175 176
- 🤗  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.
M
Mingxue-Xu 已提交
177

G
grasswolfs 已提交
178
### Community
小湉湉's avatar
小湉湉 已提交
179
- Scan the QR code below with your Wechat (reply【语音】after your friend's application is approved), you can access to official technical exchange group. Look forward to your participation.
M
Mingxue-Xu 已提交
180 181

<div align="center">
小湉湉's avatar
小湉湉 已提交
182
<img src="https://raw.githubusercontent.com/yt605155624/lanceTest/main/images/wechat_4.jpg"  width = "300"  />
M
Mingxue-Xu 已提交
183 184
</div>

Z
Zeyu Chen 已提交
185
## Installation
M
Mingxue-Xu 已提交
186

J
Jackwaterveg 已提交
187 188
We strongly recommend our users to install PaddleSpeech in **Linux** with *python>=3.7*.
Up to now, **Linux** supports CLI for the all our tasks, **Mac OSX** and **Windows** only supports PaddleSpeech CLI for Audio Classification, Speech-to-Text and Text-to-Speech. To install `PaddleSpeech`, please see [installation](./docs/source/install.md).
M
Mingxue-Xu 已提交
189

G
grasswolfs 已提交
190
<a name="quickstart"></a>
Z
Zeyu Chen 已提交
191
## Quick Start
M
Mingxue-Xu 已提交
192

M
Mingxue-Xu 已提交
193
Developers can have a try of our models with [PaddleSpeech Command Line](./paddlespeech/cli/README.md). Change `--input` to test your own audio/text.
M
Mingxue-Xu 已提交
194

M
Mingxue-Xu 已提交
195
**Audio Classification**     
M
Mingxue-Xu 已提交
196
```shell
小湉湉's avatar
小湉湉 已提交
197
paddlespeech cls --input input.wav
M
Mingxue-Xu 已提交
198
```
M
Mingxue-Xu 已提交
199 200
**Automatic Speech Recognition**
```shell
小湉湉's avatar
小湉湉 已提交
201
paddlespeech asr --lang zh --input input_16k.wav
M
Mingxue-Xu 已提交
202 203
```
**Speech Translation** (English to Chinese)
小湉湉's avatar
小湉湉 已提交
204

H
huangyuxin 已提交
205
(not support for Mac and Windows now)
M
Mingxue-Xu 已提交
206
```shell
小湉湉's avatar
小湉湉 已提交
207
paddlespeech st --input input_16k.wav
M
Mingxue-Xu 已提交
208 209
```
**Text-to-Speech** 
M
Mingxue-Xu 已提交
210
```shell
G
grasswolfs 已提交
211
paddlespeech tts --input "你好,欢迎使用飞桨深度学习框架!" --output output.wav
M
Mingxue-Xu 已提交
212
```
小湉湉's avatar
小湉湉 已提交
213
- web demo for Text to Speech is integrated to [Huggingface Spaces](https://huggingface.co/spaces) with [Gradio](https://github.com/gradio-app/gradio). See Demo: [TTS Demo](https://huggingface.co/spaces/akhaliq/paddlespeech)
K
KP 已提交
214 215 216 217 218 219 220

**Text Postprocessing** 
- Punctuation Restoration
  ```bash
  paddlespeech text --task punc --input 今天的天气真不错啊你下午有空吗我想约你一起去吃饭
  ```

A
AK391 已提交
221
  
小湉湉's avatar
小湉湉 已提交
222 223 224

For more command lines, please see: [demos](https://github.com/PaddlePaddle/PaddleSpeech/tree/develop/demos)

225
If you want to try more functions like training and tuning, please have a look at [Speech-to-Text Quick Start](./docs/source/asr/quick_start.md) and [Text-to-Speech Quick Start](./docs/source/tts/quick_start.md).
Z
Zeyu Chen 已提交
226

Z
Zeyu Chen 已提交
227
## Model List
228

229
PaddleSpeech supports a series of most popular models. They are summarized in [released models](./docs/source/released_model.md) and attached with available pretrained models.
Z
Zeyu Chen 已提交
230

小湉湉's avatar
小湉湉 已提交
231
**Speech-to-Text** contains *Acoustic Model*, *Language Model*, and *Speech Translation*, with the following details:
L
lfchener 已提交
232

M
Mingxue-Xu 已提交
233 234 235
<table style="width:100%">
  <thead>
    <tr>
Z
Zeyu Chen 已提交
236
      <th>Speech-to-Text Module Type</th>
M
Mingxue-Xu 已提交
237 238 239 240 241 242 243
      <th>Dataset</th>
      <th>Model Type</th>
      <th>Link</th>
    </tr>
  </thead>
  <tbody>
    <tr>
小湉湉's avatar
小湉湉 已提交
244
      <td rowspan="4">Speech Recogination</td>
M
Mingxue-Xu 已提交
245 246 247
      <td rowspan="2" >Aishell</td>
      <td >DeepSpeech2 RNN + Conv based Models</td>
      <td>
H
Hui Zhang 已提交
248
      <a href = "./examples/aishell/asr0">deepspeech2-aishell</a>
M
Mingxue-Xu 已提交
249 250 251 252 253
      </td>
    </tr>
    <tr>
      <td>Transformer based Attention Models </td>
      <td>
H
Hui Zhang 已提交
254
      <a href = "./examples/aishell/asr1">u2.transformer.conformer-aishell</a>
M
Mingxue-Xu 已提交
255 256
      </td>
    </tr>
小湉湉's avatar
小湉湉 已提交
257
    <tr>
M
Mingxue-Xu 已提交
258 259 260
      <td> Librispeech</td>
      <td>Transformer based Attention Models </td>
      <td>
H
Hui Zhang 已提交
261
      <a href = "./examples/librispeech/asr0">deepspeech2-librispeech</a> / <a href = "./examples/librispeech/asr1">transformer.conformer.u2-librispeech</a>  / <a href = "./examples/librispeech/asr2">transformer.conformer.u2-kaldi-librispeech</a>
M
Mingxue-Xu 已提交
262 263 264
      </td>
      </td>
    </tr>
小湉湉's avatar
小湉湉 已提交
265 266 267 268 269 270 271
  <tr>
      <td>TIMIT</td>
      <td>Unified Streaming & Non-streaming Two-pass</td>
      <td>
    <a href = "./examples/timit/asr1"> u2-timit</a>
      </td>
  </tr>
M
Mingxue-Xu 已提交
272 273 274 275 276
  <tr>
  <td>Alignment</td>
  <td>THCHS30</td>
  <td>MFA</td>
  <td>
H
Hui Zhang 已提交
277
  <a href = ".examples/thchs30/align0">mfa-thchs30</a>
M
Mingxue-Xu 已提交
278 279
  </td>
  </tr>
M
Mingxue-Xu 已提交
280
   <tr>
小湉湉's avatar
小湉湉 已提交
281
      <td rowspan="1">Language Model</td>
M
Mingxue-Xu 已提交
282
      <td colspan = "2">Ngram Language Model</td>
M
Mingxue-Xu 已提交
283
      <td>
M
Mingxue-Xu 已提交
284
      <a href = "./examples/other/ngram_lm">kenlm</a>
M
Mingxue-Xu 已提交
285 286
      </td>
    </tr>
小湉湉's avatar
小湉湉 已提交
287
  <tr>
M
Mingxue-Xu 已提交
288 289 290 291 292 293 294 295 296 297 298 299 300
      <td rowspan="2">Speech Translation (English to Chinese)</td> 
      <td rowspan="2">TED En-Zh</td>
      <td>Transformer + ASR MTL</td>
      <td>
      <a href = "./examples/ted_en_zh/st0">transformer-ted</a>
      </td>
  </tr>
  <tr>
      <td>FAT + Transformer + ASR MTL</td>
      <td>
      <a href = "./examples/ted_en_zh/st1">fat-st-ted</a>
      </td>
  </tr>
M
Mingxue-Xu 已提交
301 302
  </tbody>
</table>
H
Hui Zhang 已提交
303

304
**Text-to-Speech** in PaddleSpeech mainly contains three modules: *Text Frontend*, *Acoustic Model* and *Vocoder*. Acoustic Model and Vocoder models are listed as follow:
H
Hui Zhang 已提交
305

M
Mingxue-Xu 已提交
306 307 308
<table>
  <thead>
    <tr>
小湉湉's avatar
小湉湉 已提交
309 310 311 312
      <th> Text-to-Speech Module Type </th>
      <th> Model Type </th>
      <th> Dataset </th>
      <th> Link </th>
M
Mingxue-Xu 已提交
313 314 315 316
    </tr>
  </thead>
  <tbody>
    <tr>
小湉湉's avatar
小湉湉 已提交
317
    <td> Text Frontend </td>
M
Mingxue-Xu 已提交
318 319
    <td colspan="2"> &emsp; </td>
    <td>
320
    <a href = "./examples/other/tn">tn</a> / <a href = "./examples/other/g2p">g2p</a>
M
Mingxue-Xu 已提交
321 322 323 324
    </td>
    </tr>
    <tr>
      <td rowspan="4">Acoustic Model</td>
小湉湉's avatar
小湉湉 已提交
325 326
      <td>Tacotron2</td>
      <td>LJSpeech / CSMSC</td>
M
Mingxue-Xu 已提交
327
      <td>
小湉湉's avatar
小湉湉 已提交
328
      <a href = "./examples/ljspeech/tts0">tacotron2-ljspeech</a> / <a href = "./examples/csmsc/tts0">tacotron2-csmsc</a>
M
Mingxue-Xu 已提交
329 330 331
      </td>
    </tr>
    <tr>
小湉湉's avatar
小湉湉 已提交
332
      <td>Transformer TTS</td>
小湉湉's avatar
小湉湉 已提交
333
      <td>LJSpeech</td>
M
Mingxue-Xu 已提交
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
      <td>
      <a href = "./examples/ljspeech/tts1">transformer-ljspeech</a>
      </td>
    </tr>
    <tr>
      <td>SpeedySpeech</td>
      <td>CSMSC</td>
      <td >
      <a href = "./examples/csmsc/tts2">speedyspeech-csmsc</a>
      </td>
    </tr>
    <tr>
      <td>FastSpeech2</td>
      <td>AISHELL-3 / VCTK / LJSpeech / CSMSC</td>
      <td>
      <a href = "./examples/aishell3/tts3">fastspeech2-aishell3</a> / <a href = "./examples/vctk/tts3">fastspeech2-vctk</a> / <a href = "./examples/ljspeech/tts3">fastspeech2-ljspeech</a> / <a href = "./examples/csmsc/tts3">fastspeech2-csmsc</a>
      </td>
    </tr>
   <tr>
小湉湉's avatar
小湉湉 已提交
353
      <td rowspan="6">Vocoder</td>
M
Mingxue-Xu 已提交
354 355 356 357 358 359 360 361 362 363
      <td >WaveFlow</td>
      <td >LJSpeech</td>
      <td>
      <a href = "./examples/ljspeech/voc0">waveflow-ljspeech</a>
      </td>
    </tr>
    <tr>
      <td >Parallel WaveGAN</td>
      <td >LJSpeech / VCTK / CSMSC</td>
      <td>
364
      <a href = "./examples/ljspeech/voc1">PWGAN-ljspeech</a> / <a href = "./examples/vctk/voc1">PWGAN-vctk</a> / <a href = "./examples/csmsc/voc1">PWGAN-csmsc</a>
M
Mingxue-Xu 已提交
365 366
      </td>
    </tr>
小湉湉's avatar
小湉湉 已提交
367 368 369 370 371 372
    <tr>
      <td >Multi Band MelGAN</td>
      <td >CSMSC</td>
      <td>
      <a href = "./examples/csmsc/voc3">Multi Band MelGAN-csmsc</a> 
      </td>
小湉湉's avatar
小湉湉 已提交
373 374 375 376 377 378 379 380 381 382 383 384 385 386
    </tr> 
    <tr>
      <td >Style MelGAN</td>
      <td >CSMSC</td>
      <td>
      <a href = "./examples/csmsc/voc4">Style MelGAN-csmsc</a> 
      </td>
    </tr>
    <tr>
      <td >HiFiGAN</td>
      <td >CSMSC</td>
      <td>
      <a href = "./examples/csmsc/voc5">HiFiGAN-csmsc</a> 
      </td>
小湉湉's avatar
小湉湉 已提交
387 388 389 390 391 392 393 394
    </tr>
    <tr>
      <td >WaveRNN</td>
      <td >CSMSC</td>
      <td>
      <a href = "./examples/csmsc/voc6">WaveRNN-csmsc</a>
      </td>
    </tr>
M
Mingxue-Xu 已提交
395
    <tr>
小湉湉's avatar
小湉湉 已提交
396 397
      <td rowspan="3">Voice Cloning</td>
      <td>GE2E</td>
小湉湉's avatar
小湉湉 已提交
398
      <td >Librispeech, etc.</td>
小湉湉's avatar
小湉湉 已提交
399 400 401
      <td>
      <a href = "./examples/other/ge2e">ge2e</a>
      </td>
M
Mingxue-Xu 已提交
402 403
    </tr>
    <tr>
小湉湉's avatar
小湉湉 已提交
404 405 406 407 408 409 410 411 412 413 414 415
      <td>GE2E + Tactron2</td>
      <td>AISHELL-3</td>
      <td>
      <a href = "./examples/aishell3/vc0">ge2e-tactron2-aishell3</a>
      </td>
    </tr>
    <tr>
      <td>GE2E + FastSpeech2</td>
      <td>AISHELL-3</td>
      <td>
      <a href = "./examples/aishell3/vc1">ge2e-fastspeech2-aishell3</a>
      </td>
M
Mingxue-Xu 已提交
416 417 418
    </tr>
  </tbody>
</table>
H
Hui Zhang 已提交
419

M
Mingxue-Xu 已提交
420
**Audio Classification**
421 422 423 424

<table style="width:100%">
  <thead>
    <tr>
小湉湉's avatar
小湉湉 已提交
425 426 427 428
      <th> Task </th>
      <th> Dataset </th>
      <th> Model Type </th>
      <th> Link </th>
429 430 431 432 433 434 435 436 437 438 439 440 441 442
    </tr>
  </thead>
  <tbody>
  <tr>
      <td>Audio Classification</td>
      <td>ESC-50</td>
      <td>PANN</td>
      <td>
      <a href = "./examples/esc50/cls0">pann-esc50</a>
      </td>
    </tr>
  </tbody>
</table>

小湉湉's avatar
小湉湉 已提交
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
**Punctuation Restoration**

<table style="width:100%">
  <thead>
    <tr>
      <th> Task </th>
      <th> Dataset </th>
      <th> Model Type </th>
      <th> Link </th>
    </tr>
  </thead>
  <tbody>
  <tr>
      <td>Punctuation Restoration</td>
      <td>IWLST2012_zh</td>
      <td>Ernie Linear</td>
      <td>
      <a href = "./examples/iwslt2012/punc0">iwslt2012-punc0</a>
      </td>
    </tr>
  </tbody>
</table>

M
Mingxue-Xu 已提交
466
## Documents
Z
Zeyu Chen 已提交
467

M
Mingxue-Xu 已提交
468
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.
Z
Zeyu Chen 已提交
469

470
- [Installation](./docs/source/install.md)
G
grasswolfs 已提交
471 472
- [Quick Start](#quickstart)
- [Some Demos](./demos/README.md)
M
Mingxue-Xu 已提交
473 474 475 476 477 478 479 480 481 482
- 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)
    - [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)
G
grasswolfs 已提交
483 484
  - [Audio Classification](./demos/audio_tagging/README.md)
  - [Speech Translation](./demos/speech_translation/README.md)
M
Mingxue-Xu 已提交
485
- [Released Models](./docs/source/released_model.md)
G
grasswolfs 已提交
486 487
- [Community](#Community)
- [Welcome to contribute](#contribution)
G
grasswolfs 已提交
488
- [License](#License)
Z
Zeyu Chen 已提交
489

M
Mingxue-Xu 已提交
490
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.
Z
Zeyu Chen 已提交
491

Z
Zeyu Chen 已提交
492
## Citation
493

M
Mingxue-Xu 已提交
494 495 496 497 498
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},
Z
Zeyu Chen 已提交
499
howpublished = {\url{https://github.com/PaddlePaddle/PaddleSpeech}},
M
Mingxue-Xu 已提交
500 501 502
year={2021}
}
```
G
grasswolfs 已提交
503
<a name="contribution"></a>
M
Mingxue-Xu 已提交
504
## Contribute to PaddleSpeech
Z
Zeyu Chen 已提交
505

M
Mingxue-Xu 已提交
506
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!
Z
Zeyu Chen 已提交
507

M
Mingxue-Xu 已提交
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
### Contributors
<p align="center">
<a href="https://github.com/zh794390558"><img src="https://avatars.githubusercontent.com/u/3038472?v=4" width=75 height=75></a>
<a href="https://github.com/Jackwaterveg"><img src="https://avatars.githubusercontent.com/u/87408988?v=4" width=75 height=75></a>
<a href="https://github.com/yt605155624"><img src="https://avatars.githubusercontent.com/u/24568452?v=4" width=75 height=75></a>
<a href="https://github.com/kuke"><img src="https://avatars.githubusercontent.com/u/3064195?v=4" width=75 height=75></a>
<a href="https://github.com/xinghai-sun"><img src="https://avatars.githubusercontent.com/u/7038341?v=4" width=75 height=75></a>
<a href="https://github.com/pkuyym"><img src="https://avatars.githubusercontent.com/u/5782283?v=4" width=75 height=75></a>
<a href="https://github.com/KPatr1ck"><img src="https://avatars.githubusercontent.com/u/22954146?v=4" width=75 height=75></a>
<a href="https://github.com/LittleChenCc"><img src="https://avatars.githubusercontent.com/u/10339970?v=4" width=75 height=75></a>
<a href="https://github.com/745165806"><img src="https://avatars.githubusercontent.com/u/20623194?v=4" width=75 height=75></a>
<a href="https://github.com/Mingxue-Xu"><img src="https://avatars.githubusercontent.com/u/92848346?v=4" width=75 height=75></a>
<a href="https://github.com/chrisxu2016"><img src="https://avatars.githubusercontent.com/u/18379485?v=4" width=75 height=75></a>
<a href="https://github.com/lfchener"><img src="https://avatars.githubusercontent.com/u/6771821?v=4" width=75 height=75></a>
<a href="https://github.com/luotao1"><img src="https://avatars.githubusercontent.com/u/6836917?v=4" width=75 height=75></a>
<a href="https://github.com/wanghaoshuang"><img src="https://avatars.githubusercontent.com/u/7534971?v=4" width=75 height=75></a>
<a href="https://github.com/gongel"><img src="https://avatars.githubusercontent.com/u/24390500?v=4" width=75 height=75></a>
<a href="https://github.com/mmglove"><img src="https://avatars.githubusercontent.com/u/38800877?v=4" width=75 height=75></a>
<a href="https://github.com/iclementine"><img src="https://avatars.githubusercontent.com/u/16222986?v=4" width=75 height=75></a>
<a href="https://github.com/ZeyuChen"><img src="https://avatars.githubusercontent.com/u/1371212?v=4" width=75 height=75></a>
<a href="https://github.com/AK391"><img src="https://avatars.githubusercontent.com/u/81195143?v=4" width=75 height=75></a>
<a href="https://github.com/qingqing01"><img src="https://avatars.githubusercontent.com/u/7845005?v=4" width=75 height=75></a>
<a href="https://github.com/ericxk"><img src="https://avatars.githubusercontent.com/u/4719594?v=4" width=75 height=75></a>
<a href="https://github.com/kvinwang"><img src="https://avatars.githubusercontent.com/u/6442159?v=4" width=75 height=75></a>
<a href="https://github.com/jiqiren11"><img src="https://avatars.githubusercontent.com/u/82639260?v=4" width=75 height=75></a>
<a href="https://github.com/AshishKarel"><img src="https://avatars.githubusercontent.com/u/58069375?v=4" width=75 height=75></a>
<a href="https://github.com/chesterkuo"><img src="https://avatars.githubusercontent.com/u/6285069?v=4" width=75 height=75></a>
<a href="https://github.com/tensor-tang"><img src="https://avatars.githubusercontent.com/u/21351065?v=4" width=75 height=75></a>
<a href="https://github.com/hysunflower"><img src="https://avatars.githubusercontent.com/u/52739577?v=4" width=75 height=75></a>  
<a href="https://github.com/wwhu"><img src="https://avatars.githubusercontent.com/u/6081200?v=4" width=75 height=75></a>
<a href="https://github.com/lispc"><img src="https://avatars.githubusercontent.com/u/2833376?v=4" width=75 height=75></a>
<a href="https://github.com/jerryuhoo"><img src="https://avatars.githubusercontent.com/u/24245709?v=4" width=75 height=75></a>
<a href="https://github.com/harisankarh"><img src="https://avatars.githubusercontent.com/u/1307053?v=4" width=75 height=75></a>
<a href="https://github.com/Jackiexiao"><img src="https://avatars.githubusercontent.com/u/18050469?v=4" width=75 height=75></a>
<a href="https://github.com/limpidezza"><img src="https://avatars.githubusercontent.com/u/71760778?v=4" width=75 height=75></a>
</p>

## Acknowledgement

H
Hui Zhang 已提交
547

548
- Many thanks to [yeyupiaoling](https://github.com/yeyupiaoling)/[PPASR](https://github.com/yeyupiaoling/PPASR)/[PaddlePaddle-DeepSpeech](https://github.com/yeyupiaoling/PaddlePaddle-DeepSpeech)/[VoiceprintRecognition-PaddlePaddle](https://github.com/yeyupiaoling/VoiceprintRecognition-PaddlePaddle)/[AudioClassification-PaddlePaddle](https://github.com/yeyupiaoling/AudioClassification-PaddlePaddle) for years of attention, constructive advice and great help.
M
Mingxue-Xu 已提交
549
- Many thanks to [AK391](https://github.com/AK391) for TTS web demo on Huggingface Spaces using Gradio.
550
- Many thanks to [mymagicpower](https://github.com/mymagicpower) for the Java implementation of ASR upon [short](https://github.com/mymagicpower/AIAS/tree/main/3_audio_sdks/asr_sdk) and [long](https://github.com/mymagicpower/AIAS/tree/main/3_audio_sdks/asr_long_audio_sdk) audio files.
H
Hui Zhang 已提交
551 552
- Many thanks to [JiehangXie](https://github.com/JiehangXie)/[PaddleBoBo](https://github.com/JiehangXie/PaddleBoBo) for developing Virtual Uploader(VUP)/Virtual YouTuber(VTuber) with PaddleSpeech TTS function.
- Many thanks to [745165806](https://github.com/745165806)/[PaddleSpeechTask](https://github.com/745165806/PaddleSpeechTask) for contributing Punctuation Restoration model.
L
lizi 已提交
553
- Many thanks to [kslz](https://github.com/745165806) for supplementary Chinese documents.
M
Mingxue-Xu 已提交
554 555 556

Besides, PaddleSpeech depends on a lot of open source repositories. See [references](./docs/source/reference.md) for more information.

G
grasswolfs 已提交
557
<a name="License"></a>
M
Mingxue-Xu 已提交
558 559 560
## License

PaddleSpeech is provided under the [Apache-2.0 License](./LICENSE).