From b988f0ab5b53556cfac6fe58f1c65bb6b7f8e007 Mon Sep 17 00:00:00 2001 From: Andy Lee Date: Thu, 14 Aug 2025 01:20:14 -0700 Subject: [PATCH] cli: unify flags to --recompute/--no-recompute for build/search/ask; docs: update references --- README.md | 2 +- docs/configuration-guide.md | 2 +- packages/leann-core/src/leann/cli.py | 30 ++++++++++------------------ 3 files changed, 12 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 5fdb004..a158a38 100755 --- a/README.md +++ b/README.md @@ -514,7 +514,7 @@ leann search INDEX_NAME QUERY [OPTIONS] Options: --top-k N Number of results (default: 5) --complexity N Search complexity (default: 64) - --recompute-embeddings Use recomputation for highest accuracy + --recompute Use recomputation for highest accuracy --pruning-strategy {global,local,proportional} ``` diff --git a/docs/configuration-guide.md b/docs/configuration-guide.md index 2f93d6a..a7393ce 100644 --- a/docs/configuration-guide.md +++ b/docs/configuration-guide.md @@ -291,7 +291,7 @@ leann build my-index \ # Search with OpenAI embeddings (recompute at query time) leann search my-index "your query" \ - --recompute-embeddings + --recompute ``` ### 2) Run remote builds with SkyPilot (cloud GPU) diff --git a/packages/leann-core/src/leann/cli.py b/packages/leann-core/src/leann/cli.py index 6c1aae8..07ff0d7 100644 --- a/packages/leann-core/src/leann/cli.py +++ b/packages/leann-core/src/leann/cli.py @@ -145,22 +145,17 @@ Examples: search_parser.add_argument("--beam-width", type=int, default=1) search_parser.add_argument("--prune-ratio", type=float, default=0.0) search_parser.add_argument( - "--recompute-embeddings", - action="store_true", - default=True, - help="Recompute embeddings (default: True)", - ) - search_parser.add_argument( - "--no-recompute-embeddings", + "--no-recompute", dest="recompute_embeddings", action="store_false", help="Disable embedding recomputation during search", ) search_parser.add_argument( - "--no-recompute", + "--recompute", dest="recompute_embeddings", - action="store_false", - help="Alias for --no-recompute-embeddings", + action="store_true", + default=True, + help="Enable embedding recomputation during search (default)", ) search_parser.add_argument( "--pruning-strategy", @@ -185,22 +180,17 @@ Examples: ask_parser.add_argument("--beam-width", type=int, default=1) ask_parser.add_argument("--prune-ratio", type=float, default=0.0) ask_parser.add_argument( - "--recompute-embeddings", - action="store_true", - default=True, - help="Recompute embeddings (default: True)", - ) - ask_parser.add_argument( - "--no-recompute-embeddings", + "--no-recompute", dest="recompute_embeddings", action="store_false", help="Disable embedding recomputation during ask", ) ask_parser.add_argument( - "--no-recompute", + "--recompute", dest="recompute_embeddings", - action="store_false", - help="Alias for --no-recompute-embeddings", + action="store_true", + default=True, + help="Enable embedding recomputation during ask (default)", ) ask_parser.add_argument( "--pruning-strategy",