feat: Model cache (#6)

Closes #5

Author: tazarov

README.md

@@ -4,18 +4,41 @@ The purpose of this docker image is to provide a convenient way to download mode
 
 ## Usage
 
+### Basic
+
 ```bash
 docker run -it --rm -v $(PWD):/models amikos/hf-model-downloader  sentence-transformers/all-MiniLM-L6-v2
 ```
 
-With HF Token:
+### With cache:
+
+You can use the image to download models to a existing HF cache (`~/.cache/torch/sentence_transformers`) by setting `USE_CACHE=true` and mounting the cache directory.
+
+```bash
+docker run -it --rm -e USE_CACHE=true -v ~/.cache/torch/sentence_transformers:/models amikos/hf-model-downloader  sentence-transformers/all-MiniLM-L6-v2
+```
+
+> Note: An alternative location for HF models is `~/.cache/huggingface/hub/`
+
+> Note: You can use a different cache directory by mounting a different directory.
+
+Using HF sentence-transformers with custom cache dir:
+
+```py
+from sentence_transformers import SentenceTransformer
+model = SentenceTransformer("sentence-transformers/all-MiniLM-L6-v2", cache_folder="/models")
+```
+
+### With HF Token:
+
+Using HF token can be useful if your model is private.
 
 ```bash
 export HF_TOKEN="your_huggingface_token"
 docker run -it --rm -e HF_TOKEN="$HF_TOKEN" -v $(PWD):/models amikos/hf-model-downloader  sentence-transformers/all-MiniLM-L6-v2
 ```
 
-Using in Docker Compose:
+### Using in Docker Compose:
 
 ```yaml
 version: '3.8'

docker-entrypoint.sh

@@ -10,6 +10,10 @@ do
         token="--token ${HF_TOKEN}"
         echo "Found HF token, using it to download $model"
     fi
+    target_dir_cmd="--local-dir /models/$sanitized_model"
+    if [ -n "$USE_CACHE" ] && [ "$(echo "$USE_CACHE" | tr '[:upper:]' '[:lower:]')" = "true" ]; then
+        target_dir_cmd="--cache-dir /models"
+    fi
     # Use printf to safely pass arguments
-    printf '%s\0' "--local-dir" "/models/$sanitized_model" "$model" | xargs -0 huggingface-cli download $token
+    printf '%s\0' $target_dir_cmd "$model" | xargs -0 huggingface-cli download $token
 done