README.md 26.4 KB
Newer Older
1
# DeepSpeech2 on PaddlePaddle
2

3
*DeepSpeech2 on PaddlePaddle* is an open-source implementation of end-to-end Automatic Speech Recognition (ASR) engine, based on [Baidu's Deep Speech 2 paper](http://proceedings.mlr.press/v48/amodei16.pdf), with [PaddlePaddle](https://github.com/PaddlePaddle/Paddle) platform. Our vision is to empower both industrial application and academic research on speech recognition, via an easy-to-use, efficient and scalable implementation, including training, inference & testing module, distributed [PaddleCloud](https://github.com/PaddlePaddle/cloud) training, and demo deployment. Besides, several pre-trained models for both English and Mandarin are also released.
4 5 6 7 8 9

## Table of Contents
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Data Preparation](#data-preparation)
- [Training a Model](#training-a-model)
10
- [Data Augmentation Pipeline](#data-augmentation-pipeline)
11
- [Inference and Evaluation](#inference-and-evaluation)
12
- [Running in Docker Container](#running-in-docker-container)
13 14
- [Distributed Cloud Training](#distributed-cloud-training)
- [Hyper-parameters Tuning](#hyper-parameters-tuning)
15
- [Training for Mandarin Language](#training-for-mandarin-language)
16
- [Trying Live Demo with Your Own Voice](#trying-live-demo-with-your-own-voice)
17
- [Released Models](#released-models)
18
- [Experiments and Benchmarks](#experiments-and-benchmarks)
19 20
- [Questions and Help](#questions-and-help)

21

22

23
## Installation
24

25
To avoid the trouble of environment setup, [running in docker container](#running-in-docker-container) is highly recommended. Otherwise follow the guidelines below to install the dependencies manually.
26 27 28 29 30 31

### Prerequisites
- Python 2.7 only supported
- PaddlePaddle the latest version (please refer to the [Installation Guide](https://github.com/PaddlePaddle/Paddle#installation))

### Setup
32

33
```bash
34 35
git clone https://github.com/PaddlePaddle/models.git
cd models/deep_speech_2
Y
yangyaming 已提交
36
sh setup.sh
37
```
38

39
## Getting Started
40

41
Several shell scripts provided in `./examples` will help us to quickly give it a try, for most major modules, including data preparation, model training, case inference and model evaluation, with a few public dataset (e.g. [LibriSpeech](http://www.openslr.org/12/), [Aishell](http://www.openslr.org/33)). Reading these examples will also help you to understand how to make it work with your own data.
42

43
Some of the scripts in `./examples` are configured with 8 GPUs. If you don't have 8 GPUs available, please modify `CUDA_VISIBLE_DEVICES` and `--trainer_count`. If you don't have any GPU available, please set `--use_gpu` to False to use CPUs instead. Besides, if out-of-memory problem occurs, just reduce `--batch_size` to fit.
44 45 46 47 48

Let's take a tiny sampled subset of [LibriSpeech dataset](http://www.openslr.org/12/) for instance.

- Go to directory

49
    ```bash
50
    cd examples/tiny
51 52
    ```

53
    Notice that this is only a toy example with a tiny sampled subset of LibriSpeech. If you would like to try with the complete dataset (would take several days for training), please go to `examples/librispeech` instead.
54
- Prepare the data
55

56
    ```bash
57
    sh run_data.sh
58 59
    ```

60
    `run_data.sh` will download dataset, generate manifests, collect normalizer's statistics and build vocabulary. Once the data preparation is done, you will find the data (only part of LibriSpeech) downloaded in `~/.cache/paddle/dataset/speech/libri` and the corresponding manifest files generated in `./data/tiny` as well as a mean stddev file and a vocabulary file. It has to be run for the very first time you run this dataset and is reusable for all further experiments.
61 62
- Train your own ASR model

63
    ```bash
64 65 66
    sh run_train.sh
    ```

67
    `run_train.sh` will start a training job, with training logs printed to stdout and model checkpoint of every pass/epoch saved to `./checkpoints/tiny`. These checkpoints could be used for training resuming, inference, evaluation and deployment.
68 69
- Case inference with an existing model

70
    ```bash
71 72 73
    sh run_infer.sh
    ```

74
    `run_infer.sh` will show us some speech-to-text decoding results for several (default: 10) samples with the trained model. The performance might not be good now as the current model is only trained with a toy subset of LibriSpeech. To see the results with a better model, you can download a well-trained (trained for several days, with the complete LibriSpeech) model and do the inference:
75

76
    ```bash
77
    sh run_infer_golden.sh
78 79 80
    ```
- Evaluate an existing model

81
    ```bash
82 83 84
    sh run_test.sh
    ```

85
    `run_test.sh` will evaluate the model with Word Error Rate (or Character Error Rate) measurement. Similarly, you can also download a well-trained model and test its performance:
86

87
    ```bash
88
    sh run_test_golden.sh
89 90
    ```

X
Xinghai Sun 已提交
91
More detailed information are provided in the following sections. Wish you a happy journey with the *DeepSpeech2 on PaddlePaddle* ASR engine!
92

93

94
## Data Preparation
95

X
Xinghai Sun 已提交
96
### Generate Manifest
97

98
*DeepSpeech2 on PaddlePaddle* accepts a textual **manifest** file as its data set interface. A manifest file summarizes a set of speech data, with each line containing some meta data (e.g. filepath, transcription, duration) of one audio clip, in [JSON](http://www.json.org/) format, such as:
99

100
```
101 102
{"audio_filepath": "/home/work/.cache/paddle/Libri/134686/1089-134686-0001.flac", "duration": 3.275, "text": "stuff it into you his belly counselled him"}
{"audio_filepath": "/home/work/.cache/paddle/Libri/134686/1089-134686-0007.flac", "duration": 4.275, "text": "a cold lucid indifference reigned in his soul"}
103
```
104

105
To use your custom data, you only need to generate such manifest files to summarize the dataset. Given such summarized manifests, training, inference and all other modules can be aware of where to access the audio files, as well as their meta data including the transcription labels.
106

107
For how to generate such manifest files, please refer to `data/librispeech/librispeech.py`, which will download data and generate manifest files for LibriSpeech dataset.
X
Xinghai Sun 已提交
108

X
Xinghai Sun 已提交
109
### Compute Mean & Stddev for Normalizer
X
Xinghai Sun 已提交
110

111
To perform z-score normalization (zero-mean, unit stddev) upon audio features, we have to estimate in advance the mean and standard deviation of the features, with some training samples:
X
Xinghai Sun 已提交
112

113
```bash
114 115 116 117 118
python tools/compute_mean_std.py \
--num_samples 2000 \
--specgram_type linear \
--manifest_paths data/librispeech/manifest.train \
--output_path data/librispeech/mean_std.npz
X
Xinghai Sun 已提交
119 120
```

X
Xinghai Sun 已提交
121 122
It will compute the mean and standard deviation of power spectrum feature with 2000 random sampled audio clips listed in `data/librispeech/manifest.train` and save the results to `data/librispeech/mean_std.npz` for further usage.

123

X
Xinghai Sun 已提交
124
### Build Vocabulary
X
Xinghai Sun 已提交
125

X
Xinghai Sun 已提交
126
A vocabulary of possible characters is required to convert the transcription into a list of token indices for training, and in decoding, to convert from a list of indices back to text again. Such a character-based vocabulary can be built with `tools/build_vocab.py`.
Y
Yibing Liu 已提交
127

128
```bash
129 130 131 132
python tools/build_vocab.py \
--count_threshold 0 \
--vocab_path data/librispeech/eng_vocab.txt \
--manifest_paths data/librispeech/manifest.train
Y
Yibing Liu 已提交
133
```
134

135
It will write a vocabuary file `data/librispeeech/eng_vocab.txt` with all transcription text in `data/librispeech/manifest.train`, without vocabulary truncation (`--count_threshold 0`).
136

X
Xinghai Sun 已提交
137
### More Help
138

139
For more help on arguments:
140

141
```bash
142
python data/librispeech/librispeech.py --help
143
python tools/compute_mean_std.py --help
144
python tools/build_vocab.py --help
145 146
```

147
## Training a model
148

149
`train.py` is the main caller of the training module. Examples of usage are shown below.
150

151
- Start training from scratch with 8 GPUs:
152

153 154 155
    ```
    CUDA_VISIBLE_DEVICES=0,1,2,3,4,5,6,7 python train.py --trainer_count 8
    ```
156

157 158 159 160 161
- Start training from scratch with 16 CPUs:

    ```
    python train.py --use_gpu False --trainer_count 16
    ```
162
- Resume training from a checkpoint:
163 164

    ```
X
Xinghai Sun 已提交
165 166
    CUDA_VISIBLE_DEVICES=0,1,2,3,4,5,6,7 \
    python train.py \
167 168
    --init_model_path CHECKPOINT_PATH_TO_RESUME_FROM
    ```
169

170
For more help on arguments:
171

172
```bash
173 174
python train.py --help
```
175
or refer to `example/librispeech/run_train.sh`.
176

177
## Data Augmentation Pipeline
Y
Yibing Liu 已提交
178

179
Data augmentation has often been a highly effective technique to boost the deep learning performance. We augment our speech data by synthesizing new audios with small random perturbation (label-invariant transformation) added upon raw audios. You don't have to do the syntheses on your own, as it is already embedded into the data provider and is done on the fly, randomly for each epoch during training.
180

181
Six optional augmentation components are provided to be selected, configured and inserted into the processing pipeline.
182 183 184 185

  - Volume Perturbation
  - Speed Perturbation
  - Shifting Perturbation
X
Xinghai Sun 已提交
186
  - Online Bayesian normalization
187 188 189
  - Noise Perturbation (need background noise audio files)
  - Impulse Response (need impulse audio files)

190
In order to inform the trainer of what augmentation components are needed and what their processing orders are, it is required to prepare in advance a *augmentation configuration file* in [JSON](http://www.json.org/) format. For example:
Y
Yibing Liu 已提交
191 192

```
193 194 195 196 197 198 199 200 201 202 203 204
[{
    "type": "speed",
    "params": {"min_speed_rate": 0.95,
               "max_speed_rate": 1.05},
    "prob": 0.6
},
{
    "type": "shift",
    "params": {"min_shift_ms": -5,
               "max_shift_ms": 5},
    "prob": 0.8
}]
Y
Yibing Liu 已提交
205 206
```

207
When the `--augment_conf_file` argument of `trainer.py` is set to the path of the above example configuration file, every audio clip in every epoch will be processed: with 60% of chance, it will first be speed perturbed with a uniformly random sampled speed-rate between 0.95 and 1.05, and then with 80% of chance it will be shifted in time with a random sampled offset between -5 ms and 5 ms. Finally this newly synthesized audio clip will be feed into the feature extractor for further training.
208

209
For other configuration examples, please refer to `conf/augmenatation.config.example`.
Y
Yibing Liu 已提交
210

211
Be careful when utilizing the data augmentation technique, as improper augmentation will do harm to the training, due to the enlarged train-test gap.
212

213
## Inference and Evaluation
214

215
### Prepare Language Model
Y
Yibing Liu 已提交
216

217
A language model is required to improve the decoder's performance. We have prepared two language models (with lossy compression) for users to download and try. One is for English and the other is for Mandarin. Users can simply run this to download the preprared language models:
X
Xinghai Sun 已提交
218

219
```bash
X
Xinghai Sun 已提交
220 221 222 223
cd models/lm
sh download_lm_en.sh
sh download_lm_ch.sh
```
224

Y
yangyaming 已提交
225
If you wish to train your own better language model, please refer to [KenLM](https://github.com/kpu/kenlm) for tutorials. Here we provide some tips to show how we preparing our English and Mandarin language models. You can take it as a reference when you train your own.
Y
yangyaming 已提交
226 227 228

#### English LM

Y
yangyaming 已提交
229
The English corpus is from the [Common Crawl Repository](http://commoncrawl.org) and you can download it from [statmt](http://data.statmt.org/ngrams/deduped_en). We use part en.00 to train our English languge model. There are some preprocessing steps before training:
Y
yangyaming 已提交
230

Y
yangyaming 已提交
231
  * Characters not in \[A-Za-z0-9\s'\] (\s represents whitespace characters) are removed and Arabic numbers are converted to English numbers like 1000 to one thousand.
Y
yangyaming 已提交
232 233
  * Repeated whitespace characters are squeezed to one and the beginning whitespace characters are removed. Notice that all transcriptions are lowercase, so all characters are converted to lowercase.
  * Top 400,000 most frequent words are selected to build the vocabulary and the rest are replaced with 'UNKNOWNWORD'.
Y
yangyaming 已提交
234

Y
yangyaming 已提交
235
Now the preprocessing is done and we get a clean corpus to train the language model. Our released language model are trained with agruments '-o 5 --prune 0 1 1 1 1'. '-o 5' means the max order of language model is 5. '--prune 0 1 1 1 1' represents count thresholds for each order and more specifically it will prune singletons for orders two and higher. To save disk storage we convert the arpa file to 'trie' binary file with arguments '-a 22 -q 8 -b 8'. '-a' represents the maximum number of leading bits of pointers in 'trie' to chop. '-q -b' are quantization parameters for probability and backoff.
Y
yangyaming 已提交
236

Y
yangyaming 已提交
237 238
#### Mandarin LM

Y
yangyaming 已提交
239
Different from the English language model, Mandarin language model is character-based where each token is a Chinese character. We use internal corpus to train the released Mandarin language models. The corpus contain billions of tokens. The preprocessing has tiny difference from English language model and main steps include:
Y
yangyaming 已提交
240 241

  * The beginning and trailing whitespace characters are removed.
Y
yangyaming 已提交
242 243
  * English punctuations and Chinese punctuations are removed.
  * A whitespace character between two tokens is inserted.
Y
yangyaming 已提交
244

Y
yangyaming 已提交
245
Please notice that the released language models only contain Chinese simplified characters. After preprocessing done we can begin to train the language model. The key training arguments for small LM is '-o 5 --prune 0 1 2 4 4' and '-o 5' for large LM. Please refer above section for the meaning of each argument. We also convert the arpa file to binary file using default settings.
246

247
### Speech-to-text Inference
248

249
An inference module caller `infer.py` is provided to infer, decode and visualize speech-to-text results for several given audio clips. It might help to have an intuitive and qualitative evaluation of the ASR model's performance.
250 251 252

- Inference with GPU:

253
    ```bash
254 255
    CUDA_VISIBLE_DEVICES=0 python infer.py --trainer_count 1
    ```
Y
Yibing Liu 已提交
256

X
Xinghai Sun 已提交
257
- Inference with CPUs:
258

259
    ```bash
260
    python infer.py --use_gpu False --trainer_count 12
261 262
    ```

X
Xinghai Sun 已提交
263
We provide two types of CTC decoders: *CTC greedy decoder* and *CTC beam search decoder*. The *CTC greedy decoder* is an implementation of the simple best-path decoding algorithm, selecting at each timestep the most likely token, thus being greedy and locally optimal. The [*CTC beam search decoder*](https://arxiv.org/abs/1408.2873) otherwise utilizes a heuristic breadth-first graph search for reaching a near global optimality; it also requires a pre-trained KenLM language model for better scoring and ranking. The decoder type can be set with argument `--decoding_method`.
264 265

For more help on arguments:
266 267 268 269

```
python infer.py --help
```
270
or refer to `example/librispeech/run_infer.sh`.
Y
Yibing Liu 已提交
271

272
### Evaluate a Model
Y
Yibing Liu 已提交
273

274
To evaluate a model's performance quantitatively, please run:
275

X
Xinghai Sun 已提交
276
- Evaluation with GPUs:
277

278
    ```bash
279 280 281
    CUDA_VISIBLE_DEVICES=0,1,2,3,4,5,6,7 python test.py --trainer_count 8
    ```

X
Xinghai Sun 已提交
282
- Evaluation with CPUs:
Y
Yibing Liu 已提交
283

284
    ```bash
285
    python test.py --use_gpu False --trainer_count 12
286 287
    ```

288
The error rate (default: word error rate; can be set with `--error_rate_type`) will be printed.
289 290

For more help on arguments:
Y
Yibing Liu 已提交
291

292
```bash
293
python test.py --help
Y
Yibing Liu 已提交
294
```
295
or refer to `example/librispeech/run_test.sh`.
Y
Yibing Liu 已提交
296

297
## Hyper-parameters Tuning
Y
Yibing Liu 已提交
298

299
The hyper-parameters $\alpha$ (language model weight) and $\beta$ (word insertion weight) for the [*CTC beam search decoder*](https://arxiv.org/abs/1408.2873) often have a significant impact on the decoder's performance. It would be better to re-tune them on the validation set when the acoustic model is renewed.
Y
Yibing Liu 已提交
300

301
`tools/tune.py` performs a 2-D grid search over the hyper-parameter $\alpha$ and $\beta$. You must provide the range of $\alpha$ and $\beta$, as well as the number of their attempts.
Y
Yibing Liu 已提交
302

303
- Tuning with GPU:
Y
Yibing Liu 已提交
304

305
    ```bash
X
Xinghai Sun 已提交
306 307
    CUDA_VISIBLE_DEVICES=0,1,2,3,4,5,6,7 \
    python tools/tune.py \
308
    --trainer_count 8 \
309 310 311 312 313 314
    --alpha_from 1.0 \
    --alpha_to 3.2 \
    --num_alphas 45 \
    --beta_from 0.1 \
    --beta_to 0.45 \
    --num_betas 8
315
    ```
Y
Yibing Liu 已提交
316

317
- Tuning with CPU:
Y
Yibing Liu 已提交
318

319
    ```bash
320 321
    python tools/tune.py --use_gpu False
    ```
Y
yangyaming 已提交
322
 The grid search will print the WER (word error rate) or CER (character error rate) at each point in the hyper-parameters space, and draw the error surface optionally. A proper hyper-parameters range should include the global minima of the error surface for WER/CER, as illustrated in the following figure.
323

324
<p align="center">
Y
Yibing Liu 已提交
325
<img src="docs/images/tuning_error_surface.png" width=550>
326 327 328
<br/>An example error surface for tuning on the dev-clean set of LibriSpeech
</p>

Y
Yibing Liu 已提交
329
Usually, as the figure shows, the variation of language model weight ($\alpha$) significantly affect the performance of CTC beam search decoder. And a better procedure is to first tune on serveral data batches (the number can be specified) to find out the proper range of hyper-parameters, then change to the whole validation set to carray out an accurate tuning.
330 331

After tuning, you can reset $\alpha$ and $\beta$ in the inference and evaluation modules to see if they really help improve the ASR performance. For more help
Y
Yibing Liu 已提交
332

333
```bash
Y
Yibing Liu 已提交
334 335
python tune.py --help
```
336
or refer to `example/librispeech/run_tune.sh`.
Y
Yibing Liu 已提交
337

338 339
## Running in Docker Container

340
Docker is an open source tool to build, ship, and run distributed applications in an isolated environment. A Docker image for this project has been provided in [hub.docker.com](https://hub.docker.com) with all the dependencies installed, including the pre-built PaddlePaddle, CTC decoders, and other necessary Python and third-party packages. This Docker image requires the support of NVIDIA GPU, so please make sure its availiability and the [nvidia-docker](https://github.com/NVIDIA/nvidia-docker) has been installed.
341 342

Take several steps to launch the Docker image:
343

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
- Download the Docker image

```bash
nvidia-docker pull paddlepaddle/models:deep-speech-2
```

- Clone this repository

```
git clone https://github.com/PaddlePaddle/models.git
```

- Run the Docker image

```bash
sudo nvidia-docker run -it -v $(pwd)/models:/models paddlepaddle/models:deep-speech-2 /bin/bash
```
361
Now go back and start from the [Getting Started](#getting-started) section, you can execute training, inference and hyper-parameters tuning similarly in the Docker container.
362

363 364
## Distributed Cloud Training

365
We also provide a cloud training module for users to do the distributed cluster training on [PaddleCloud](https://github.com/PaddlePaddle/cloud), to achieve a much faster training speed with multiple machines. To start with this, please first install PaddleCloud client and register a PaddleCloud account, as described in [PaddleCloud Usage](https://github.com/PaddlePaddle/cloud/blob/develop/doc/usage_cn.md#%E4%B8%8B%E8%BD%BD%E5%B9%B6%E9%85%8D%E7%BD%AEpaddlecloud).
X
Xinghai Sun 已提交
366

367
Please take the following steps to submit a training job:
X
Xinghai Sun 已提交
368

X
Xinghai Sun 已提交
369
- Go to directory:
X
Xinghai Sun 已提交
370

371
    ```bash
X
Xinghai Sun 已提交
372 373 374 375
    cd cloud
    ```
- Upload data:

X
Xinghai Sun 已提交
376
    Data must be uploaded to PaddleCloud filesystem to be accessed within a cloud job. `pcloud_upload_data.sh` helps do the data packing and uploading:
X
Xinghai Sun 已提交
377

378
    ```bash
X
Xinghai Sun 已提交
379 380 381 382 383 384 385 386 387 388
    sh pcloud_upload_data.sh
    ```

    Given input manifests, `pcloud_upload_data.sh` will:

    - Extract the audio files listed in the input manifests.
    - Pack them into a specified number of tar files.
    - Upload these tar files to PaddleCloud filesystem.
    - Create cloud manifests by replacing local filesystem paths with PaddleCloud filesystem paths. New manifests will be used to inform the cloud jobs of audio files' location and their meta information.

389
    It should be done only once for the very first time to do the cloud training. Later, the data is kept persisitent on the cloud filesystem and reusable for further job submissions.
X
Xinghai Sun 已提交
390 391 392 393 394 395 396 397 398 399 400 401 402

    For argument details please refer to [Train DeepSpeech2 on PaddleCloud](https://github.com/PaddlePaddle/models/tree/develop/deep_speech_2/cloud).

 - Configure training arguments:

    Configure the cloud job parameters in `pcloud_submit.sh` (e.g. `NUM_NODES`, `NUM_GPUS`, `CLOUD_TRAIN_DIR`, `JOB_NAME` etc.) and then configure other hyper-parameters for training in `pcloud_train.sh` (just as what you do for local training).

    For argument details please refer to [Train DeepSpeech2 on PaddleCloud](https://github.com/PaddlePaddle/models/tree/develop/deep_speech_2/cloud).

 - Submit the job:

    By running:

403
    ```bash
X
Xinghai Sun 已提交
404 405
    sh pcloud_submit.sh
    ```
406
    a training job has been submitted to PaddleCloud, with the job name printed to the console.
X
Xinghai Sun 已提交
407 408 409 410 411

  - Get training logs

    Run this to list all the jobs you have submitted, as well as their running status:

412
    ```bash
X
Xinghai Sun 已提交
413 414 415 416
    paddlecloud get jobs
    ```

    Run this, the corresponding job's logs will be printed.
417
    ```bash
X
Xinghai Sun 已提交
418 419 420 421 422 423
    paddlecloud logs -n 10000 $REPLACED_WITH_YOUR_ACTUAL_JOB_NAME
    ```

For more information about the usage of PaddleCloud, please refer to [PaddleCloud Usage](https://github.com/PaddlePaddle/cloud/blob/develop/doc/usage_cn.md#提交任务).

For more information about the DeepSpeech2 training on PaddleCloud, please refer to
424 425
[Train DeepSpeech2 on PaddleCloud](https://github.com/PaddlePaddle/models/tree/develop/deep_speech_2/cloud).

426 427
## Training for Mandarin Language

Y
yangyaming 已提交
428
The key steps of training for Mandarin language are same to that of English language and we have also provided an example for Mandarin training with Aishell in ```examples/aishell```. As mentioned above, please execute ```sh run_data.sh```, ```sh run_train.sh```, ```sh run_test.sh``` and ```sh run_infer.sh``` to do data preparation, training, testing and inference correspondingly. We have also prepared a pre-trained model (downloaded by ./models/aishell/download_model.sh) for users to try with ```sh run_infer_golden.sh``` and ```sh run_test_golden.sh```. Notice that, different from English LM, the Mandarin LM is character-based and please run ```tools/tune.py``` to find an optimal setting.
X
Xinghai Sun 已提交
429

430
## Trying Live Demo with Your Own Voice
431

432
Until now, an ASR model is trained and tested qualitatively (`infer.py`) and quantitatively (`test.py`) with existing audio files. But it is not yet tested with your own speech. `deploy/demo_server.py` and `deploy/demo_client.py` helps quickly build up a real-time demo ASR engine with the trained model, enabling you to test and play around with the demo, with your own voice.
X
Xinghai Sun 已提交
433

434
To start the demo's server, please run this in one console:
X
Xinghai Sun 已提交
435

436
```bash
X
Xinghai Sun 已提交
437 438 439 440 441 442 443
CUDA_VISIBLE_DEVICES=0 \
python deploy/demo_server.py \
--trainer_count 1 \
--host_ip localhost \
--host_port 8086
```

444
For the machine (might not be the same machine) to run the demo's client, please do the following installation before moving on.
445 446 447

For example, on MAC OS X:

448
```bash
449 450 451 452
brew install portaudio
pip install pyaudio
pip install pynput
```
X
Xinghai Sun 已提交
453

454
Then to start the client, please run this in another console:
455

456
```bash
X
Xinghai Sun 已提交
457 458 459
CUDA_VISIBLE_DEVICES=0 \
python -u deploy/demo_client.py \
--host_ip 'localhost' \
X
Xinghai Sun 已提交
460
--host_port 8086
461
```
X
Xinghai Sun 已提交
462

463
Now, in the client console, press the `whitespace` key, hold, and start speaking. Until finishing your utterance, release the key to let the speech-to-text results shown in the console. To quit the client, just press `ESC` key.
X
Xinghai Sun 已提交
464

465
Notice that `deploy/demo_client.py` must be run on a machine with a microphone device, while `deploy/demo_server.py` could be run on one without any audio recording hardware, e.g. any remote server machine. Just be careful to set the `host_ip` and `host_port` argument with the actual accessible IP address and port, if the server and client are running with two separate machines. Nothing should be done if they are running on one single machine.
X
Xinghai Sun 已提交
466

467
Please also refer to `examples/mandarin/run_demo_server.sh`, which will first download a pre-trained Mandarin model (trained with 3000 hours of internal speech data) and then start the demo server with the model. With running `examples/mandarin/run_demo_client.sh`, you can speak Mandarin to test it. If you would like to try some other models, just update `--model_path` argument in the script.  
X
Xinghai Sun 已提交
468 469

For more help on arguments:
470

471
```bash
X
Xinghai Sun 已提交
472 473
python deploy/demo_server.py --help
python deploy/demo_client.py --help
474
```
475

476 477 478 479
## Released Models

#### Speech Model Released

X
Xinghai Sun 已提交
480
Language  | Model Name | Training Data | Hours of Speech
481 482
:-----------: | :------------: | :----------: |  -------:
English  | [LibriSpeech Model](http://cloud.dlnel.org/filepub/?uuid=17404caf-cf19-492f-9707-1fad07c19aae) | [LibriSpeech Dataset](http://www.openslr.org/12/) | 960 h
X
Xinghai Sun 已提交
483
English  | [BaiduEN8k Model](to-be-added) | Baidu Internal English Dataset | 8628 h
484
Mandarin | [Aishell Model](http://cloud.dlnel.org/filepub/?uuid=6c83b9d8-3255-4adf-9726-0fe0be3d0274) | [Aishell Dataset](http://www.openslr.org/33/) | 151 h
X
Xinghai Sun 已提交
485
Mandarin | [BaiduCN1.2k Model](to-be-added) | Baidu Internal Mandarin Dataset | 1204 h
486 487 488

#### Language Model Released

Y
yangyaming 已提交
489 490 491 492 493
Language Model | Training Data | Token-based | Size | Descriptions
:-------------:| :------------:| :-----: | -----: | :-----------------
[English LM](http://paddlepaddle.bj.bcebos.com/model_zoo/speech/common_crawl_00.prune01111.trie.klm) |  [CommonCrawl(en.00)](http://web-language-models.s3-website-us-east-1.amazonaws.com/ngrams/en/deduped/en.00.deduped.xz) | Word-based | 8.3 GB | Pruned with 0 1 1 1 1; <br/> About 1.85 billion n-grams; <br/> 'trie'  binary with '-a 22 -q 8 -b 8'
[Mandarin LM Small](http://cloud.dlnel.org/filepub/?uuid=d21861e4-4ed6-45bb-ad8e-ae417a43195e) | Baidu Internal Corpus | Char-based | 2.8 GB | Pruned with 0 1 2 4 4; <br/> About 0.13 billion n-grams; <br/> 'probing' binary with default settings
[Mandarin LM Large](http://cloud.dlnel.org/filepub/?uuid=245d02bb-cd01-4ebe-b079-b97be864ec37) | Baidu Internal Corpus | Char-based | 70.4 GB | No Pruning; <br/> About 3.7 billion n-grams; <br/> 'probing' binary with default settings
494

495
## Experiments and Benchmarks
496

X
Xinghai Sun 已提交
497
#### Benchmark Results for English Models (Word Error Rate)
X
Xinghai Sun 已提交
498

X
Xinghai Sun 已提交
499
Test Set                | LibriSpeech Model | BaiduEN8K Model
X
Xinghai Sun 已提交
500
:---------------------  | ---------------:  | -------------------:
501 502 503 504 505 506 507
LibriSpeech Test-Clean  |   7.77            |   6.63
LibriSpeech Test-Other  |   23.25           |   16.59
VoxForge American-Canadian | 12.52          |   7.46
VoxForge Commonwealth   |   21.08           |   16.23
VoxForge European       |   31.21           |   20.47
VoxForge Indian         |   56.79           |   28.15
Baidu Internal Testset  |   47.73           |   8.92
508

X
Xinghai Sun 已提交
509
#### Benchmark Results for Mandarin Model (Character Error Rate)
510

X
Xinghai Sun 已提交
511
Test Set                | Aishell Model     | BaiduCN1.2k Model
X
Xinghai Sun 已提交
512 513
:---------------------  | ---------------:  | -------------------:
Baidu Internal Testset  |   -               |   15.49
514

515 516
#### Acceleration with Multi-GPUs

517
We compare the training time with 1, 2, 4, 8, 16 Tesla K40m GPUs (with a subset of LibriSpeech samples whose audio durations are between 6.0 and 7.0 seconds).  And it shows that a **near-linear** acceleration with multiple GPUs has been achieved. In the following figure, the time (in seconds) cost for training is printed on the blue bars.
518 519 520 521 522 523 524 525 526 527

<img src="docs/images/multi_gpu_speedup.png" width=450><br/>

| # of GPU  | Acceleration Rate |
| --------  | --------------:   |
| 1         | 1.00 X |
| 2         | 1.97 X |
| 4         | 3.74 X |
| 8         | 6.21 X |
|16         | 10.70 X |
528

529
`tools/profile.sh` provides such a profiling tool.
X
Xinghai Sun 已提交
530

531
## Questions and Help
X
Xinghai Sun 已提交
532 533

You are welcome to submit questions and bug reports in [Github Issues](https://github.com/PaddlePaddle/models/issues). You are also welcome to contribute to this project.