Skip to content

Commit e2055de

Browse files
committed
docs(env): improve .env.example with detailed cache directory configurations
1 parent 2b75f17 commit e2055de

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

.env.example

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,8 +256,35 @@ GRAIL_CHECKPOINT_RETENTION_LIMIT=3
256256
GRAIL_CHECKPOINT_MILESTONE_INTERVAL=100
257257

258258
# Local cache directory for checkpoints (default: ~/.cache/grail)
259+
#
260+
# IMPORTANT:
261+
# - If left blank, defaults to ~/.cache/grail (persistent on disk)
262+
# - Empty strings should NOT be used as they can cause path resolution issues
263+
#
264+
# Recommended for faster checkpoint I/O (RAM disk / tmpfs):
265+
# GRAIL_CACHE_DIR=/dev/shm/grail
266+
#
267+
# Example (persistent on disk):
268+
# GRAIL_CACHE_DIR=/home/user/.cache/grail
269+
#
270+
# Leave blank to use default (~/.cache/grail):
259271
GRAIL_CACHE_DIR=
260272

273+
# HuggingFace models cache directory (default: ~/.cache/huggingface)
274+
#
275+
# IMPORTANT:
276+
# - Redirects all HuggingFace model downloads (AutoModel, AutoTokenizer)
277+
# - If left blank, HuggingFace defaults to ~/.cache/huggingface
278+
#
279+
# Recommended for faster model I/O (RAM disk / tmpfs):
280+
# HF_HOME=/dev/shm/huggingface
281+
#
282+
# Example (persistent on disk):
283+
# HF_HOME=/home/user/.cache/huggingface
284+
#
285+
# Leave blank to use default (~/.cache/huggingface):
286+
HF_HOME=
287+
261288
# ============================================================================
262289
# MONITORING SYSTEM CONFIGURATION
263290
# ============================================================================

0 commit comments

Comments
 (0)