Medix-AI/coqui-tts
Medix-AI
/
coqui-tts
mirror of https://github.com/coqui-ai/TTS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docs (#2919)

This commit is contained in:
Eren Gölge 2023-09-04 12:28:36 +02:00 committed by GitHub
parent 32b8ebb633
commit d1d95707bd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 6 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/requirements.txt
View File

@ -1,6 +1,6 @@
furo furo
myst-parser == 2.0.0 myst-parser == 2.0.0
sphinx == 7.0.1 sphinx == 7.2.5
sphinx_inline_tabs sphinx_inline_tabs
sphinx_copybutton sphinx_copybutton
linkify-it-py linkify-it-py

2
docs/source/docker_images.md
View File

@ -43,7 +43,7 @@ Start the container and get a shell inside it.
```bash ```bash
docker run --rm -it -p 5002:5002 --entrypoint /bin/bash ghcr.io/coqui-ai/tts-cpu docker run --rm -it -p 5002:5002 --entrypoint /bin/bash ghcr.io/coqui-ai/tts-cpu
python3 TTS/server/server.py --list_models #To get the list of available models python3 TTS/server/server.py --list_models #To get the list of available models
python3 TTS/server/server.py --model_name tts_models/en/vctk/vits python3 TTS/server/server.py --model_name tts_models/en/vctk/vits
``` ```
### GPU version ### GPU version

4
docs/source/implementing_a_new_model.md
View File

@ -36,7 +36,7 @@
There is also the `callback` interface by which you can manipulate both the model and the `Trainer` states. Callbacks give you There is also the `callback` interface by which you can manipulate both the model and the `Trainer` states. Callbacks give you
an infinite flexibility to add custom behaviours for your model and training routines. an infinite flexibility to add custom behaviours for your model and training routines.
For more details, see {ref}`BaseTTS <Base TTS Model>` and :obj:`TTS.utils.callbacks`. For more details, see {ref}`BaseTTS <Base tts Model>` and :obj:`TTS.utils.callbacks`.
6. Optionally, define `MyModelArgs`. 6. Optionally, define `MyModelArgs`.
@ -204,5 +204,3 @@ class MyModel(BaseTTS):
pass pass
``` ```

6
docs/source/main_classes/model_api.md
View File

@ -5,18 +5,18 @@ Model API provides you a set of functions that easily make your model compatible
## Base TTS Model ## Base TTS Model
```{eval-rst} ```{eval-rst}
.. autoclass:: TTS.model.BaseModel .. autoclass:: TTS.model.BaseTrainerModel
:members: :members:
``` ```
## Base `tts` Model ## Base tts Model
```{eval-rst} ```{eval-rst}
.. autoclass:: TTS.tts.models.base_tts.BaseTTS .. autoclass:: TTS.tts.models.base_tts.BaseTTS
:members: :members:
``` ```
## Base `vocoder` Model ## Base vocoder Model
```{eval-rst} ```{eval-rst}
.. autoclass:: TTS.vocoder.models.base_vocoder.BaseVocoder .. autoclass:: TTS.vocoder.models.base_vocoder.BaseVocoder

6
docs/source/models/bark.md
View File

@ -91,12 +91,6 @@ tts --model_name tts_models/multilingual/multi-dataset/bark \
:members: :members:
``` ```
## BarkArgs
```{eval-rst}
.. autoclass:: TTS.tts.models.bark.BarkArgs
:members:
```
## Bark Model ## Bark Model
```{eval-rst} ```{eval-rst}
.. autoclass:: TTS.tts.models.bark.Bark .. autoclass:: TTS.tts.models.bark.Bark