add model downloading section to README

51b5c2ca9bc73adeb1df25d4ba35b692974165ff · 2025-02-01 20:23:05 +0000 · Alex Cheema

Files touched

M README.md

Diff

commit 51b5c2ca9bc73adeb1df25d4ba35b692974165ff
Author: Alex Cheema <alexcheema123@gmail.com>
Date:   Sat Feb 1 20:23:05 2025 +0000

    add model downloading section to README
---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 5e645abb..97b19cc4 100644
--- a/README.md
+++ b/README.md
@@ -216,6 +216,16 @@ Models by default are stored in `~/.cache/exo/downloads`.
 
 You can set a different model storage location by setting the `EXO_HOME` env var.
 
+## Model Downloading
+
+Models are downloaded from Hugging Face. If you are running exo in a country with strict internet censorship, you may need to download the models manually and put them in the `~/.cache/exo/downloads` directory.
+
+To download models from a proxy endpoint, set the `HF_ENDPOINT` environment variable. For example, to run exo with the huggingface mirror endpoint:
+
+```sh
+HF_ENDPOINT=https://hf-mirror.com exo
+```
+
 ## Debugging
 
 Enable debug logs with the DEBUG environment variable (0-9).

← 2c0d17c3 beautiful download · back to Exo · patch for manual discovery, set known_peers 72329ba9 →