forked from coqui-ai/TTS
-
Notifications
You must be signed in to change notification settings - Fork 106
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(server): clean up README (#272)
* docs: clean up server README * docs: formatting --------- Co-authored-by: Enno Hermann <[email protected]>
- Loading branch information
Showing
1 changed file
with
27 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,36 @@ | ||
# :frog: TTS demo server | ||
# :frog: TTS Demo Server | ||
Before you use the server, make sure you | ||
[install](https://github.com/idiap/coqui-ai-TTS/tree/dev#install-tts)) :frog: TTS | ||
[install](https://github.com/idiap/coqui-ai-TTS/tree/dev#install-tts) :frog: TTS | ||
properly and install the additional dependencies with `pip install | ||
coqui-tts[server]`. Then, you can follow the steps below. | ||
|
||
**Note:** If you install :frog:TTS using ```pip```, you can also use the ```tts-server``` end point on the terminal. | ||
**Note:** If you install :frog:TTS using ```pip```, you can also use the ```tts-server``` endpoint on the terminal instead of the `python TTS/server/server.py` arguments. | ||
|
||
Examples runs: | ||
## Example commands | ||
|
||
List officially released models. | ||
```python TTS/server/server.py --list_models ``` | ||
List officially released models: | ||
```bash | ||
python TTS/server/server.py --list_models # or | ||
tts-server --list_models | ||
``` | ||
|
||
Run the server with the official models. | ||
```python TTS/server/server.py --model_name tts_models/en/ljspeech/tacotron2-DCA --vocoder_name vocoder_models/en/ljspeech/multiband-melgan``` | ||
Run the server with the official models: | ||
```bash | ||
python TTS/server/server.py --model_name tts_models/en/ljspeech/tacotron2-DCA \ | ||
--vocoder_name vocoder_models/en/ljspeech/multiband-melgan | ||
``` | ||
|
||
Run the server with the official models on a GPU. | ||
```CUDA_VISIBLE_DEVICES="0" python TTS/server/server.py --model_name tts_models/en/ljspeech/tacotron2-DCA --vocoder_name vocoder_models/en/ljspeech/multiband-melgan --use_cuda``` | ||
Run the server with the official models on a GPU: | ||
```bash | ||
CUDA_VISIBLE_DEVICES="0" python TTS/server/server.py \ | ||
--model_name tts_models/en/ljspeech/tacotron2-DCA | ||
--vocoder_name vocoder_models/en/ljspeech/multiband-melgan --use_cuda | ||
``` | ||
|
||
Run the server with a custom models. | ||
```python TTS/server/server.py --tts_checkpoint /path/to/tts/model.pth --tts_config /path/to/tts/config.json --vocoder_checkpoint /path/to/vocoder/model.pth --vocoder_config /path/to/vocoder/config.json``` | ||
Run the server with a custom models: | ||
```bash | ||
python TTS/server/server.py --tts_checkpoint /path/to/tts/model.pth \ | ||
--tts_config /path/to/tts/config.json \ | ||
--vocoder_checkpoint /path/to/vocoder/model.pth \ | ||
--vocoder_config /path/to/vocoder/config.json | ||
``` |