TBNilles/LEANN
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs+sky: simplify SkyPilot flow (auto-build on launch, rsync copy-back); clarify HNSW auto non-compact when no-recompute

Browse Source
This commit is contained in:
Andy Lee
2025-08-13 14:30:14 -07:00
parent 737dfc960c
commit fa2a775867
2 changed files with 8 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/configuration-guide.md
View File

@@ -288,23 +288,18 @@ Offload embedding generation and index building to a GPU VM using [SkyPilot](htt
# One-time: install and configure SkyPilot # One-time: install and configure SkyPilot
pip install skypilot pip install skypilot
# Launch with defaults (L4:1) and mount ./data to ~/leann-data # Launch with defaults (L4:1) and mount ./data to ~/leann-data; the build runs automatically
sky launch -c leann-gpu sky/leann-build.yaml sky launch -c leann-gpu sky/leann-build.yaml
# Override parameters via -e key=value # Override parameters via -e key=value (optional)
sky launch -c leann-gpu sky/leann-build.yaml \ sky launch -c leann-gpu sky/leann-build.yaml \
-e index_name=my-index \ -e index_name=my-index \
-e backend=hnsw \ -e backend=hnsw \
-e recompute=false \
-e compact=false \
-e embedding_mode=sentence-transformers \ -e embedding_mode=sentence-transformers \
-e embedding_model=Qwen/Qwen3-Embedding-0.6B -e embedding_model=Qwen/Qwen3-Embedding-0.6B
# Build remotely (template installs uv + leann CLI) # Copy the built index back to your local .leann (use rsync)
sky exec leann-gpu -- "leann build my-index --docs ~/leann-data --backend hnsw --complexity 64 --graph-degree 32 --no-recompute --no-compact" rsync -Pavz leann-gpu:~/.leann/indexes/my-index ./.leann/indexes/
# Copy the built index back to your local .leann
sky cp leann-gpu:~/.leann/indexes/my-index ./.leann/indexes/
``` ```
### 3) Disable recomputation to trade storage for speed ### 3) Disable recomputation to trade storage for speed
@@ -325,7 +320,7 @@ When to use:
- Environments without a stable embedding server - Environments without a stable embedding server
Constraints: Constraints:
- HNSW: must use `--no-compact` when `--no-recompute` (compact/pruned graphs rely on recomputation) - HNSW: when `--no-recompute` is set, LEANN automatically disables compact mode during build
- DiskANN: supported; `--no-recompute` skips selective recompute during search - DiskANN: supported; `--no-recompute` skips selective recompute during search
Storage impact: Storage impact:

10
sky/leann-build.yaml
View File

@@ -19,8 +19,8 @@ env:
embedding_mode: sentence-transformers # sentence-transformers | openai | mlx | ollama embedding_mode: sentence-transformers # sentence-transformers | openai | mlx | ollama
embedding_model: facebook/contriever embedding_model: facebook/contriever
# Storage/latency knobs # Storage/latency knobs
recompute: true # true => selective recomputation; false => store full embeddings recompute: true # true => selective recomputation (recommended)
compact: true # for HNSW only: false when recompute=false compact: true # for HNSW only
# Optional pass-through # Optional pass-through
extra_args: "" extra_args: ""
@@ -45,10 +45,6 @@ run: |
if [ "${recompute}" = "false" ] || [ "${recompute}" = "0" ]; then if [ "${recompute}" = "false" ] || [ "${recompute}" = "0" ]; then
recompute_flag="--no-recompute" recompute_flag="--no-recompute"
fi fi
compact_flag=""
if [ "${compact}" = "false" ] || [ "${compact}" = "0" ]; then
compact_flag="--no-compact"
fi
# Build command # Build command
leann build ${index_name} \ leann build ${index_name} \
@@ -59,4 +55,4 @@ run: |
--num-threads ${num_threads} \ --num-threads ${num_threads} \
--embedding-mode ${embedding_mode} \ --embedding-mode ${embedding_mode} \
--embedding-model ${embedding_model} \ --embedding-model ${embedding_model} \
${recompute_flag} ${compact_flag} ${extra_args} ${recompute_flag} ${extra_args}