From d1d95707bd212b5d4fd113906b9c7ff6e2d0743b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eren=20G=C3=B6lge?= Date: Mon, 4 Sep 2023 12:28:36 +0200 Subject: [PATCH] Update docs (#2919) --- docs/requirements.txt | 2 +- docs/source/docker_images.md | 2 +- docs/source/implementing_a_new_model.md | 4 +--- docs/source/main_classes/model_api.md | 6 +++--- docs/source/models/bark.md | 6 ------ 5 files changed, 6 insertions(+), 14 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 195ba1d8..efbefec4 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,6 +1,6 @@ furo myst-parser == 2.0.0 -sphinx == 7.0.1 +sphinx == 7.2.5 sphinx_inline_tabs sphinx_copybutton linkify-it-py \ No newline at end of file diff --git a/docs/source/docker_images.md b/docs/source/docker_images.md index 55d54afd..d08a5583 100644 --- a/docs/source/docker_images.md +++ b/docs/source/docker_images.md @@ -43,7 +43,7 @@ Start the container and get a shell inside it. ```bash 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 --model_name tts_models/en/vctk/vits +python3 TTS/server/server.py --model_name tts_models/en/vctk/vits ``` ### GPU version diff --git a/docs/source/implementing_a_new_model.md b/docs/source/implementing_a_new_model.md index 176c4865..134271ff 100644 --- a/docs/source/implementing_a_new_model.md +++ b/docs/source/implementing_a_new_model.md @@ -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 an infinite flexibility to add custom behaviours for your model and training routines. - For more details, see {ref}`BaseTTS ` and :obj:`TTS.utils.callbacks`. + For more details, see {ref}`BaseTTS ` and :obj:`TTS.utils.callbacks`. 6. Optionally, define `MyModelArgs`. @@ -204,5 +204,3 @@ class MyModel(BaseTTS): pass ``` - - diff --git a/docs/source/main_classes/model_api.md b/docs/source/main_classes/model_api.md index 6781a268..0e6f2d94 100644 --- a/docs/source/main_classes/model_api.md +++ b/docs/source/main_classes/model_api.md @@ -5,18 +5,18 @@ Model API provides you a set of functions that easily make your model compatible ## Base TTS Model ```{eval-rst} -.. autoclass:: TTS.model.BaseModel +.. autoclass:: TTS.model.BaseTrainerModel :members: ``` -## Base `tts` Model +## Base tts Model ```{eval-rst} .. autoclass:: TTS.tts.models.base_tts.BaseTTS :members: ``` -## Base `vocoder` Model +## Base vocoder Model ```{eval-rst} .. autoclass:: TTS.vocoder.models.base_vocoder.BaseVocoder diff --git a/docs/source/models/bark.md b/docs/source/models/bark.md index 978d793a..4092d9f4 100644 --- a/docs/source/models/bark.md +++ b/docs/source/models/bark.md @@ -91,12 +91,6 @@ tts --model_name tts_models/multilingual/multi-dataset/bark \ :members: ``` -## BarkArgs -```{eval-rst} -.. autoclass:: TTS.tts.models.bark.BarkArgs - :members: -``` - ## Bark Model ```{eval-rst} .. autoclass:: TTS.tts.models.bark.Bark