Skip to content

Commit 3c2f9ba

Browse files
authored
docs: Update HUGGING_FACE_HUB_TOKEN to HF_API_TOKEN in README (#263)
1 parent 970922e commit 3c2f9ba

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -288,14 +288,14 @@ at: [https://huggingface.github.io/text-embeddings-inference](https://huggingfac
288288

289289
### Using a private or gated model
290290

291-
You have the option to utilize the `HUGGING_FACE_HUB_TOKEN` environment variable for configuring the token employed by
291+
You have the option to utilize the `HF_API_TOKEN` environment variable for configuring the token employed by
292292
`text-embeddings-inference`. This allows you to gain access to protected resources.
293293

294294
For example:
295295

296296
1. Go to https://huggingface.co/settings/tokens
297297
2. Copy your cli READ token
298-
3. Export `HUGGING_FACE_HUB_TOKEN=<your cli READ token>`
298+
3. Export `HF_API_TOKEN=<your cli READ token>`
299299

300300
or with Docker:
301301

@@ -304,7 +304,7 @@ model=<your private model>
304304
volume=$PWD/data # share a volume with the Docker container to avoid downloading weights every run
305305
token=<your cli READ token>
306306

307-
docker run --gpus all -e HUGGING_FACE_HUB_TOKEN=$token -p 8080:80 -v $volume:/data --pull always ghcr.io/huggingface/text-embeddings-inference:1.2 --model-id $model
307+
docker run --gpus all -e HF_API_TOKEN=$token -p 8080:80 -v $volume:/data --pull always ghcr.io/huggingface/text-embeddings-inference:1.2 --model-id $model
308308
```
309309

310310
### Using Re-rankers models

0 commit comments

Comments
 (0)