Skip to content

Commit

Permalink
custom installation
Browse files Browse the repository at this point in the history
  • Loading branch information
KoljaB committed Jul 4, 2024
1 parent ac16ee0 commit c839181
Showing 1 changed file with 7 additions and 12 deletions.
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,15 +69,10 @@ The RealtimeTTS library provides installation options to various dependencies fo

### Full Installation

To install RealtimeTTS with support for all TTS engines for CUDA 12.X:
To install RealtimeTTS with support for all TTS engines:

```bash
pip install -U realtimetts[all] --index-url https://download.pytorch.org/whl/cu121
```

To install RealtimeTTS with support for all TTS engines for CUDA 11.8:
```bash
pip install -U realtimetts[all] --index-url https://download.pytorch.org/whl/cu118
pip install -U realtimetts[all]
```

### Custom Installation
Expand All @@ -93,27 +88,27 @@ RealtimeTTS allows for custom installation with minimal library installations. H
- **minimal**: Installs only the base requirements with no engine (only needed if you want to develop an own engine)


Say you want to install RealtimeTTS only for local neuronal Coqui TTS usage and you have CUDA 12.4 installed. Then you should use:
Say you want to install RealtimeTTS only for local neuronal Coqui TTS usage, then you should use:

```bash
pip install realtimetts[coqui] --index-url https://download.pytorch.org/whl/cu121
pip install realtimetts[coqui]
```

If for example you want to install RealtimeTTS with only Azure Cognitive Services Speech, ElevenLabs, and OpenAI support (then you would not need CUDA):
If for example you want to install RealtimeTTS with only Azure Cognitive Services Speech, ElevenLabs, and OpenAI support:

```bash
pip install realtimetts[azure,elevenlabs,openai]
```

### Virtual Environment Installation

For those who want to perform a full installation with CUDA 12.X within a virtual environment, follow these steps:
For those who want to perform a full installation within a virtual environment, follow these steps:

```bash
python -m venv env_realtimetts
env_realtimetts\Scripts\activate.bat
python.exe -m pip install --upgrade pip
pip install -U realtimetts[all] --index-url https://download.pytorch.org/whl/cu121
pip install -U realtimetts[all]
```

More information about [CUDA installation](#cuda-installation).
Expand Down

0 comments on commit c839181

Please sign in to comment.