Skip to content

Commit 79663bc

Browse files
committed
update the readme
1 parent af2955f commit 79663bc

File tree

3 files changed

+49
-1
lines changed

3 files changed

+49
-1
lines changed

README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ Please use our dedicated channels for questions and discussion. Help is much mor
4848
| 💻 **Docker Image** | [Repository by @synesthesiam](https://github.com/synesthesiam/docker-coqui-aitts)|
4949
| 🖥️ **Demo Server** | [TTS/server](https://github.com/coqui-ai/TTS/tree/master/TTS/server)|
5050
| 🤖 **Synthesize speech** | [TTS/README.md](https://github.com/coqui-ai/TTS#example-synthesizing-speech-on-terminal-using-the-released-models)|
51+
| 🛠️ **Implementing a New Model** | [TTS/Wiki][https://github.com/coqui-ai/TTS/wiki/Implementing-a-New-Model-in-%F0%9F%90%B8TTS]|
5152

5253
## 🥇 TTS Performance
5354
<p align="center"><img src="https://raw.githubusercontent.com/coqui-ai/TTS/main/images/TTS-performance.png" width="800" /></p>
@@ -176,6 +177,7 @@ Some of the public datasets that we successfully applied 🐸TTS:
176177
- [Spanish](https://drive.google.com/file/d/1Sm_zyBo67XHkiFhcRSQ4YaHPYM0slO_e/view?usp=sharing) - thx! @carlfm01
177178

178179
## Example: Synthesizing Speech on Terminal Using the Released Models.
180+
<img src="images/tts_cli.gif"/>
179181

180182
After the installation, 🐸TTS provides a CLI interface for synthesizing speech using pre-trained models. You can either use your own model or the release models under 🐸TTS.
181183

@@ -185,7 +187,15 @@ Listing released 🐸TTS models.
185187
tts --list_models
186188
```
187189

188-
Run a tts and a vocoder model from the released model list. (Simply copy and paste the full model names from the list as arguments for the command below.)
190+
Run a TTS model, from the release models list, with its default vocoder. (Simply copy and paste the full model names from the list as arguments for the command below.)
191+
192+
```bash
193+
tts --text "Text for TTS" \
194+
--model_name "<type>/<language>/<dataset>/<model_name>" \
195+
--out_path folder/to/save/output.wav
196+
```
197+
198+
Run a tts and a vocoder model from the released model list. Note that not every vocoder is compatible with every TTS model.
189199

190200
```bash
191201
tts --text "Text for TTS" \
@@ -214,8 +224,46 @@ tts --text "Text for TTS" \
214224
--vocoder_config_path path/to/vocoder_config.json
215225
```
216226

227+
Run a multi-speaker TTS model from the released models list.
228+
229+
```bash
230+
tts --model_name "<type>/<language>/<dataset>/<model_name>" --list_speaker_idxs # list the possible speaker IDs.
231+
tts --text "Text for TTS." --out_path output/path/speech.wav --model_name "<language>/<dataset>/<model_name>" --speaker_idx "<speaker_id>"
232+
```
233+
217234
**Note:** You can use ```./TTS/bin/synthesize.py``` if you prefer running ```tts``` from the TTS project folder.
218235

236+
## Example: Using the Demo Server for Synthesizing Speech
237+
238+
<!-- <img src="https://raw.githubusercontent.com/coqui-ai/TTS/main/images/demo_server.gif" height="56"/> -->
239+
<img src="images/demo_server.gif"/>
240+
241+
You can boot up a demo 🐸TTS server to run inference with your models. Note that the server is not optimized for performance
242+
but gives you an easy way to interact with the models.
243+
244+
The demo server provides pretty much the same interface as the CLI command.
245+
246+
```bash
247+
tts-server -h # see the help
248+
tts-server --list_models # list the available models.
249+
```
250+
251+
Run a TTS model, from the release models list, with its default vocoder.
252+
If the model you choose is a multi-speaker TTS model, you can select different speakers on the Web interface and synthesize
253+
speech.
254+
255+
```bash
256+
tts-server --model_name "<type>/<language>/<dataset>/<model_name>"
257+
```
258+
259+
Run a TTS and a vocoder model from the released model list. Note that not every vocoder is compatible with every TTS model.
260+
261+
```bash
262+
tts-server --model_name "<type>/<language>/<dataset>/<model_name>" \
263+
--vocoder_name "<type>/<language>/<dataset>/<model_name>"
264+
```
265+
266+
219267
## Example: Training and Fine-tuning LJ-Speech Dataset
220268
Here you can find a [CoLab](https://gist.github.com/erogol/97516ad65b44dbddb8cd694953187c5b) notebook for a hands-on example, training LJSpeech. Or you can manually follow the guideline below.
221269

images/demo_server.gif

94.1 KB
Loading

images/tts_cli.gif

166 KB
Loading

0 commit comments

Comments
 (0)