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

cli: unify flags to --recompute/--no-recompute for build/search/ask; docs: update references

Browse Source
This commit is contained in:
Andy Lee
2025-08-14 01:20:14 -07:00
parent 43cb500ed8
commit b988f0ab5b
3 changed files with 12 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -514,7 +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-embeddings Use recomputation for highest accuracy --recompute Use recomputation for highest accuracy
--pruning-strategy {global,local,proportional} --pruning-strategy {global,local,proportional}
``` ```

2
docs/configuration-guide.md
View File

@@ -291,7 +291,7 @@ leann build my-index \
# Search with OpenAI embeddings (recompute at query time) # Search with OpenAI embeddings (recompute at query time)
leann search my-index "your query" \ leann search my-index "your query" \
--recompute-embeddings --recompute
``` ```
### 2) Run remote builds with SkyPilot (cloud GPU) ### 2) Run remote builds with SkyPilot (cloud GPU)

30
packages/leann-core/src/leann/cli.py
View File

@@ -145,22 +145,17 @@ Examples:
search_parser.add_argument("--beam-width", type=int, default=1) 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("--prune-ratio", type=float, default=0.0)
search_parser.add_argument( search_parser.add_argument(
"--recompute-embeddings", "--no-recompute",
action="store_true",
default=True,
help="Recompute embeddings (default: True)",
)
search_parser.add_argument(
"--no-recompute-embeddings",
dest="recompute_embeddings", dest="recompute_embeddings",
action="store_false", action="store_false",
help="Disable embedding recomputation during search", help="Disable embedding recomputation during search",
) )
search_parser.add_argument( search_parser.add_argument(
"--no-recompute", "--recompute",
dest="recompute_embeddings", dest="recompute_embeddings",
action="store_false", action="store_true",
help="Alias for --no-recompute-embeddings", default=True,
help="Enable embedding recomputation during search (default)",
) )
search_parser.add_argument( search_parser.add_argument(
"--pruning-strategy", "--pruning-strategy",
@@ -185,22 +180,17 @@ Examples:
ask_parser.add_argument("--beam-width", type=int, default=1) 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("--prune-ratio", type=float, default=0.0)
ask_parser.add_argument( ask_parser.add_argument(
"--recompute-embeddings", "--no-recompute",
action="store_true",
default=True,
help="Recompute embeddings (default: True)",
)
ask_parser.add_argument(
"--no-recompute-embeddings",
dest="recompute_embeddings", dest="recompute_embeddings",
action="store_false", action="store_false",
help="Disable embedding recomputation during ask", help="Disable embedding recomputation during ask",
) )
ask_parser.add_argument( ask_parser.add_argument(
"--no-recompute", "--recompute",
dest="recompute_embeddings", dest="recompute_embeddings",
action="store_false", action="store_true",
help="Alias for --no-recompute-embeddings", default=True,
help="Enable embedding recomputation during ask (default)",
) )
ask_parser.add_argument( ask_parser.add_argument(
"--pruning-strategy", "--pruning-strategy",