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

docs: boolean flags

Browse Source
This commit is contained in:
Andy Lee
2025-08-15 11:50:46 -07:00
parent 6709afe38b
commit 92739c7899
1 changed files with 26 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -212,8 +212,8 @@ All RAG examples share these common parameters. **Interactive mode** is availabl
--backend-name NAME # Backend to use: hnsw or diskann (default: hnsw) --backend-name NAME # Backend to use: hnsw or diskann (default: hnsw)
--graph-degree N # Graph degree for index construction (default: 32) --graph-degree N # Graph degree for index construction (default: 32)
--build-complexity N # Build complexity for index construction (default: 64) --build-complexity N # Build complexity for index construction (default: 64)
--no-compact # Disable compact index storage (compact storage IS enabled to save storage by default) --compact / --no-compact # Use compact storage (default: true). Must be `no-compact` for `no-recompute` build.
--no-recompute # Disable embedding recomputation (recomputation IS enabled to save storage by default) --recompute / --no-recompute # Enable/disable embedding recomputation (default: enabled). Should not do a `no-recompute` search in a `recompute` build.
``` ```
</details> </details>
@@ -503,8 +503,8 @@ Options:
--graph-degree N Graph degree (default: 32) --graph-degree N Graph degree (default: 32)
--complexity N Build complexity (default: 64) --complexity N Build complexity (default: 64)
--force Force rebuild existing index --force Force rebuild existing index
--compact Use compact storage (default: true) --compact / --no-compact Use compact storage (default: true). Must be `no-compact` for `no-recompute` build.
--recompute Enable recomputation (default: true) --recompute / --no-recompute Enable recomputation (default: true)
``` ```
**Search Command:** **Search Command:**
@@ -514,8 +514,7 @@ leann search INDEX_NAME QUERY [OPTIONS]
Options: Options:
--top-k N Number of results (default: 5) --top-k N Number of results (default: 5)
--complexity N Search complexity (default: 64) --complexity N Search complexity (default: 64)
--recompute Use recomputation for highest accuracy --recompute / --no-recompute Enable/disable embedding recomputation (default: enabled). Should not do a `no-recompute` search in a `recompute` build.
--no-recompute Disable recomputation (requires non-compact HNSW index)
--pruning-strategy {global,local,proportional} --pruning-strategy {global,local,proportional}
``` ```