diff --git a/docs/configuration-guide.md b/docs/configuration-guide.md index 8fda762..ba0ea14 100644 --- a/docs/configuration-guide.md +++ b/docs/configuration-guide.md @@ -319,8 +319,8 @@ Details: see “Running Builds on SkyPilot (Optional)” below. If you need lower latency and have more storage/memory, disable recomputation. This stores full embeddings and avoids recomputing at search time. ```bash -# Build without recomputation -leann build my-index --no-recompute +# Build without recomputation (HNSW requires non-compact in this mode) +leann build my-index --no-recompute --no-compact # Search without recomputation leann search my-index "your query" --no-recompute diff --git a/packages/leann-core/src/leann/cli.py b/packages/leann-core/src/leann/cli.py index 9f6911f..6c1aae8 100644 --- a/packages/leann-core/src/leann/cli.py +++ b/packages/leann-core/src/leann/cli.py @@ -117,7 +117,19 @@ Examples: build_parser.add_argument("--complexity", type=int, default=64) build_parser.add_argument("--num-threads", type=int, default=1) build_parser.add_argument("--compact", action="store_true", default=True) + build_parser.add_argument( + "--no-compact", + dest="compact", + action="store_false", + help="Disable compact index storage (store full embeddings; higher storage)", + ) build_parser.add_argument("--recompute", action="store_true", default=True) + build_parser.add_argument( + "--no-recompute", + dest="recompute", + action="store_false", + help="Disable embedding recomputation (store full embeddings; lower query latency)", + ) build_parser.add_argument( "--file-types", type=str, @@ -138,6 +150,18 @@ Examples: default=True, help="Recompute embeddings (default: True)", ) + search_parser.add_argument( + "--no-recompute-embeddings", + dest="recompute_embeddings", + action="store_false", + help="Disable embedding recomputation during search", + ) + search_parser.add_argument( + "--no-recompute", + dest="recompute_embeddings", + action="store_false", + help="Alias for --no-recompute-embeddings", + ) search_parser.add_argument( "--pruning-strategy", choices=["global", "local", "proportional"], @@ -166,6 +190,18 @@ Examples: default=True, help="Recompute embeddings (default: True)", ) + ask_parser.add_argument( + "--no-recompute-embeddings", + dest="recompute_embeddings", + action="store_false", + help="Disable embedding recomputation during ask", + ) + ask_parser.add_argument( + "--no-recompute", + dest="recompute_embeddings", + action="store_false", + help="Alias for --no-recompute-embeddings", + ) ask_parser.add_argument( "--pruning-strategy", choices=["global", "local", "proportional"],