chore: add instruction on using HuggingFace access token
This commit is contained in:
parent
1a885d2f80
commit
89532d624c
1 changed files with 10 additions and 0 deletions
10
README.md
10
README.md
|
|
@ -180,6 +180,16 @@ ls ./outputs/simple-greetings
|
||||||
|
|
||||||
Each of the [voices below](#voices) need to be downloaded once the first time they are used, and this needs an online connection. Subsequent runs can be done offline.
|
Each of the [voices below](#voices) need to be downloaded once the first time they are used, and this needs an online connection. Subsequent runs can be done offline.
|
||||||
|
|
||||||
|
### HuggingFace Access Token (Optional)
|
||||||
|
|
||||||
|
The download of the model can be faster if you sent the `HF_TOKEN` environment variable. Create a [user access token](https://huggingface.co/docs/hub/security-tokens) and set the environment variable if you want to unlock this, but it is totally optional.
|
||||||
|
|
||||||
|
Once you have a HuggingFace access token, you can add it on your `.bashrc` file (or similar)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export HF_TOKEN=<your huggingface access token>
|
||||||
|
```
|
||||||
|
|
||||||
### Voices
|
### Voices
|
||||||
|
|
||||||
You can choose a voice to use with the `--voice` flag. For this, we use [kokoro](https://huggingface.co/hexgrad/Kokoro-82M), which is an Apache-licensed model. See [all available voices](https://huggingface.co/hexgrad/Kokoro-82M/blob/main/VOICES.md).
|
You can choose a voice to use with the `--voice` flag. For this, we use [kokoro](https://huggingface.co/hexgrad/Kokoro-82M), which is an Apache-licensed model. See [all available voices](https://huggingface.co/hexgrad/Kokoro-82M/blob/main/VOICES.md).
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue