Skip to content

Commit b5fb276

Browse files
zh794390558zh794390558
authored
Merge pull request #1825 from zh794390558/docr1
[r1.0][doc] fix readme
2 parents a36cfd3 + 4cb84ed commit b5fb276

File tree

2 files changed

+172
-67
lines changed

2 files changed

+172
-67
lines changed

‎README.md‎

Lines changed: 77 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,10 @@
11
([简体中文](./README_cn.md)|English)
22

3+
4+
35
<p align="center">
46
<img src="./docs/images/PaddleSpeech_logo.png" />
57
</p>
6-
<div align="center">
7-
8-
<h3>
9-
<a href="#quick-start"> Quick Start </a>
10-
| <a href="#quick-start-server"> Quick Start Server </a>
11-
| <a href="#documents"> Documents </a>
12-
| <a href="#model-list"> Models List </a>
13-
</div>
14-
15-
------------------------------------------------------------------------------------
16-
178

189
<p align="center">
1910
<a href="./LICENSE"><img src="https://img.shields.io/badge/license-Apache%202-red.svg"></a>
@@ -28,6 +19,18 @@
2819
<a href="=https://pypi.org/project/paddlespeech/"><img src="https://static.pepy.tech/badge/paddlespeech"></a>
2920
<a href="https://huggingface.co/spaces"><img src="https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue"></a>
3021
</p>
22+
<div align="center">
23+
<h3>
24+
<a href="#quick-start"> Quick Start </a>
25+
| <a href="#quick-start-server"> Quick Start Server </a>
26+
| <a href="#quick-start-streaming-server"> Quick Start Streaming Server</a>
27+
</br>
28+
<a href="#documents"> Documents </a>
29+
| <a href="#model-list"> Models List </a>
30+
</h3>
31+
</div>
32+
33+
3134

3235

3336
**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.
@@ -142,26 +145,6 @@ For more synthesized audios, please refer to [PaddleSpeech Text-to-Speech sample
142145

143146
</div>
144147

145-
### ⭐ Examples
146-
- **[PaddleBoBo](https://github.com/JiehangXie/PaddleBoBo): Use PaddleSpeech TTS to generate virtual human voice.**
147-
148-
<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>
149-
150-
- [PaddleSpeech Demo Video](https://paddlespeech.readthedocs.io/en/latest/demo_video.html)
151-
152-
- **[VTuberTalk](https://github.com/jerryuhoo/VTuberTalk): Use PaddleSpeech TTS and ASR to clone voice from videos.**
153-
154-
<div align="center">
155-
<img src="https://raw.githubusercontent.com/jerryuhoo/VTuberTalk/main/gui/gui.png" width = "500px" />
156-
</div>
157-
158-
### 🔥 Hot Activities
159-
160-
- 2021.12.21~12.24
161-
162-
4 Days Live Courses: Depth interpretation of PaddleSpeech!
163-
164-
**Courses videos and related materials: https://aistudio.baidu.com/aistudio/education/group/info/25130**
165148

166149
### Features
167150

@@ -174,11 +157,22 @@ Via the easy-to-use, efficient, flexible and scalable implementation, our vision
174157
- 🔬 *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.
175158
- 🧩 *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).
176159

177-
### Recent Update
160+
### 🔥 Hot Activities
178161

179162
<!---
180163
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).
181164
--->
165+
166+
- 2021.12.21~12.24
167+
168+
4 Days Live Courses: Depth interpretation of PaddleSpeech!
169+
170+
**Courses videos and related materials: https://aistudio.baidu.com/aistudio/education/group/info/25130**
171+
172+
173+
### Recent Update
174+
175+
- 👏🏻 2022.04.28: PaddleSpeech Streaming Server is available for Automatic Speech Recognition and Text-to-Speech.
182176
- 👏🏻 2022.03.28: PaddleSpeech Server is available for Audio Classification, Automatic Speech Recognition and Text-to-Speech.
183177
- 👏🏻 2022.03.28: PaddleSpeech CLI is available for Speaker Verification.
184178
- 🤗 2021.12.14: Our PaddleSpeech [ASR](https://huggingface.co/spaces/KPatrick/PaddleSpeechASR) and [TTS](https://huggingface.co/spaces/KPatrick/PaddleSpeechTTS) Demos on Hugging Face Spaces are available!
@@ -196,6 +190,7 @@ Via the easy-to-use, efficient, flexible and scalable implementation, our vision
196190
We strongly recommend our users to install PaddleSpeech in **Linux** with *python>=3.7*.
197191
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).
198192

193+
199194
<a name="quickstart"></a>
200195
## Quick Start
201196

@@ -238,7 +233,7 @@ paddlespeech tts --input "你好，欢迎使用飞桨深度学习框架！" --ou
238233
**Batch Process**
239234
```
240235
echo -e "1 欢迎光临。\n2 谢谢惠顾。" | paddlespeech tts
241-
```
236+
```
242237

243238
**Shell Pipeline**
244239
- ASR + Punctuation Restoration
@@ -257,16 +252,19 @@ If you want to try more functions like training and tuning, please have a look a
257252
Developers can have a try of our speech server with [PaddleSpeech Server Command Line](./paddlespeech/server/README.md).
258253

259254
**Start server**
255+
260256
```shell
261257
paddlespeech_server start --config_file ./paddlespeech/server/conf/application.yaml
262258
```
263259

264260
**Access Speech Recognition Services**
261+
265262
```shell
266263
paddlespeech_client asr --server_ip 127.0.0.1 --port 8090 --input input_16k.wav
267264
```
268265

269266
**Access Text to Speech Services**
267+
270268
```shell
271269
paddlespeech_client tts --server_ip 127.0.0.1 --port 8090 --input "您好，欢迎使用百度飞桨语音合成服务。" --output output.wav
272270
```
@@ -280,6 +278,37 @@ paddlespeech_client cls --server_ip 127.0.0.1 --port 8090 --input input.wav
280278
For more information about server command lines, please see: [speech server demos](https://github.com/PaddlePaddle/PaddleSpeech/tree/develop/demos/speech_server)
281279

282280

281+
<a name="quickstartstreamingserver"></a>
282+
## Quick Start Streaming Server
283+
284+
Developers can have a try of [streaming asr](./demos/streaming_asr_server/README.md) and [streaming tts](./demos/streaming_tts_server/README.md) server.
285+
286+
**Start Streaming Speech Recognition Server**
287+
288+
```
289+
paddlespeech_server start --config_file ./demos/streaming_asr_server/conf/application.yaml
290+
```
291+
292+
**Access Streaming Speech Recognition Services**
293+
294+
```
295+
paddlespeech_client asr_online --server_ip 127.0.0.1 --port 8090 --input input_16k.wav
296+
```
297+
298+
**Start Streaming Text to Speech Server**
299+
300+
```
301+
paddlespeech_server start --config_file ./demos/streaming_tts_server/conf/tts_online_application.yaml
302+
```
303+
304+
**Access Streaming Text to Speech Services**
305+
306+
```
307+
paddlespeech_client tts_online --server_ip 127.0.0.1 --port 8092 --protocol http --input "您好，欢迎使用百度飞桨语音合成服务。" --output output.wav
308+
```
309+
310+
For more information please see: [streaming asr](./demos/streaming_asr_server/README.md) and [streaming tts](./demos/streaming_tts_server/README.md)
311+
283312
<a name="ModelList"></a>
284313

285314
## Model List
@@ -589,6 +618,21 @@ Normally, [Speech SoTA](https://paperswithcode.com/area/speech), [Audio SoTA](ht
589618

590619
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.
591620

621+
622+
## ⭐ Examples
623+
- **[PaddleBoBo](https://github.com/JiehangXie/PaddleBoBo): Use PaddleSpeech TTS to generate virtual human voice.**
624+
625+
<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>
626+
627+
- [PaddleSpeech Demo Video](https://paddlespeech.readthedocs.io/en/latest/demo_video.html)
628+
629+
- **[VTuberTalk](https://github.com/jerryuhoo/VTuberTalk): Use PaddleSpeech TTS and ASR to clone voice from videos.**
630+
631+
<div align="center">
632+
<img src="https://raw.githubusercontent.com/jerryuhoo/VTuberTalk/main/gui/gui.png" width = "500px" />
633+
</div>
634+
635+
592636
## Citation
593637

594638
To cite PaddleSpeech for research, please use the following format.
@@ -655,7 +699,6 @@ You are warmly welcome to submit questions in [discussions](https://github.com/P
655699

656700
## Acknowledgement
657701

658-
659702
- 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.
660703
- 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.
661704
- 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.

0 commit comments

Comments
 (0)