Documentation errors

[xvdp]

Describe the bug

different docs describe commands differently and not always correctly.

https://docs.coqui.ai/en/latest/ and the github README say this

from TTS.api import TTS
print(TTS().list_models())
# <TTS.utils.manage.ModelManager object at 0x7f1441bc8c70>

however the previous returns the manager, not the list, so this would be the correct command.

print(TTS().list_models().list_models())

Although I agree that this looks weird.

If instead you look inside TTS/api.py which is the first thing I did to to see where the first error was coming from, the first example line for TTS.__init__(), line 30, states

Example with a multi-speaker model:
>>> from TTS.api import TTS
>>> tts = TTS(TTS.list_models()[0])
# which natturally yields an error
# TypeError: list_models() missing 1 required positional argument: 'self'

the bash variant to that command works as advertised

tts --list_models

Aside from these, the project looks great, I just wanted to point out some confusing directions.

To Reproduce

git clone and install

I installed within my own Dockerimage, first locally cloning
git clone "https://github.com/coqui-ai/TTS"
then pip installing

ADD --chown=appuser:appuser TTS TTS
RUN pip install --no-cache-dir TTS/.

Expected behavior

No response

Logs

No response

Environment

/collect_env_info.py
{
    "CUDA": {
        "GPU": [
            "NVIDIA GeForce RTX 3080 Ti Laptop GPU"
        ],
        "available": true,
        "version": "12.1"
    },
    "Packages": {
        "PyTorch_debug": false,
        "PyTorch_version": "2.1.2",
        "TTS": "0.22.0",
        "numpy": "1.22.0"
    },
    "System": {
        "OS": "Linux",
        "architecture": [
            "64bit",
            ""
        ],
        "processor": "x86_64",
        "python": "3.9.18",
        "version": "#40~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Thu Nov 16 10:53:04 UTC 2"
    }
}

Additional context

No response

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. You might also look our discussion channels.