Skip to content

Commit d1d9570

Browse files
authored
Update docs (coqui-ai#2919)
1 parent 32b8ebb commit d1d9570

File tree

5 files changed

+6
-14
lines changed

5 files changed

+6
-14
lines changed

docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
furo
22
myst-parser == 2.0.0
3-
sphinx == 7.0.1
3+
sphinx == 7.2.5
44
sphinx_inline_tabs
55
sphinx_copybutton
66
linkify-it-py

docs/source/docker_images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Start the container and get a shell inside it.
4343
```bash
4444
docker run --rm -it -p 5002:5002 --entrypoint /bin/bash ghcr.io/coqui-ai/tts-cpu
4545
python3 TTS/server/server.py --list_models #To get the list of available models
46-
python3 TTS/server/server.py --model_name tts_models/en/vctk/vits
46+
python3 TTS/server/server.py --model_name tts_models/en/vctk/vits
4747
```
4848

4949
### GPU version

docs/source/implementing_a_new_model.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
There is also the `callback` interface by which you can manipulate both the model and the `Trainer` states. Callbacks give you
3737
an infinite flexibility to add custom behaviours for your model and training routines.
3838

39-
For more details, see {ref}`BaseTTS <Base TTS Model>` and :obj:`TTS.utils.callbacks`.
39+
For more details, see {ref}`BaseTTS <Base tts Model>` and :obj:`TTS.utils.callbacks`.
4040

4141
6. Optionally, define `MyModelArgs`.
4242

@@ -204,5 +204,3 @@ class MyModel(BaseTTS):
204204
pass
205205

206206
```
207-
208-

docs/source/main_classes/model_api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ Model API provides you a set of functions that easily make your model compatible
55
## Base TTS Model
66

77
```{eval-rst}
8-
.. autoclass:: TTS.model.BaseModel
8+
.. autoclass:: TTS.model.BaseTrainerModel
99
:members:
1010
```
1111

12-
## Base `tts` Model
12+
## Base tts Model
1313

1414
```{eval-rst}
1515
.. autoclass:: TTS.tts.models.base_tts.BaseTTS
1616
:members:
1717
```
1818

19-
## Base `vocoder` Model
19+
## Base vocoder Model
2020

2121
```{eval-rst}
2222
.. autoclass:: TTS.vocoder.models.base_vocoder.BaseVocoder

docs/source/models/bark.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,6 @@ tts --model_name tts_models/multilingual/multi-dataset/bark \
9191
:members:
9292
```
9393

94-
## BarkArgs
95-
```{eval-rst}
96-
.. autoclass:: TTS.tts.models.bark.BarkArgs
97-
:members:
98-
```
99-
10094
## Bark Model
10195
```{eval-rst}
10296
.. autoclass:: TTS.tts.models.bark.Bark

0 commit comments

Comments
 (0)