docs(vdb): update command examples for current CLI#588
Conversation
Signed-off-by: Devasena Inupakutika <devasena.i@samsung.com>
Signed-off-by: Devasena Inupakutika <devasena.i@samsung.com>
|
MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅ |
|
@idevasena I converted this to DRAFT so that I could figure out what needs to change (and what doesn't) in the --results-dir generation and validation code without worry that a wild @russfellows would merge it in! :-) |
|
Perfect. I'm done merging for the day. I'll await further instructions. |
|
@idevasena Sorry for taking so long to get back to you. How important are the changes to Rules.md? Do they bring the Rules into alignment with the code, or do they improve the Rules, or do they enable future flexibility? It's very late in the process to change the Rules (we've got 10 days until the submission window closes) unless they're just broken, so I'm looking to understand the what's and why's. The addition of in the --results-dir path, for example, is that future flexibility or is it that the code generates that for all submissions so the validator needs to recognize it? Are all of the tweaks to the parameters just helpful human text changes, or do they change the values that the benchmark uses or defaults to? |
|
@FileSystemGuy can we take changes to vdb Readme.md from this PR ? Because the vdb run commands now reflect latest cli changes for mlpstorage. |
|
@idevasena Sure! The README for VDB is anything you want it to be. I'm protective over Rules.md, ManPage.md, and the mlpstorage_py directory hierarchy, but not much else. |
There was a problem hiding this comment.
Option modifications and default values look aligned to source code, the changes look good to me.
There was a problem hiding this comment.
README changes are merged as part of #670.
…ist_size are applied (#670) * fix(#590): use snake_case DiskANN build params so max_degree/search_list_size are applied + README updates based on mlpstorage cli changes (pulled from PR #588) * chore: bump 3.0.29 -> 3.0.30; regenerate uv.lock Ride-along with the #590 DISKANN fix. Since 3.0.29 (silently rolled in by #648) the following have landed on main: #649, #650, #652, #654, #656, #657, #659, #665, and #602. Marks a natural version boundary before the DISKANN key-name fix ships. --------- Co-authored-by: Curtis Anderson <curtis@mlcommons.org>
Summary
This PR follows up on the VectorDB documentation review from #452 and updates the command examples to match the current
mlpstorageCLI.The change is intentionally narrow: it updates stale command syntax in
vdb_benchmark/README.mdand aligns the directly related VectorDB result-path / parameter wording inRules.md. It does not rewrite the README structure or change unrelated sections such as Prerequisites, Deploy Milvus, Direct Scripts, Metrics, or Troubleshooting.Motivation
The current VectorDB README still contains older
mlpstoragecommand forms, including examples such as:The current CLI uses a mode-first structure and positional storage type:
Updates to Rules.md
Updated only the directly related VectorDB CLI / result identity wording.
Key updates:
Updated VectorDB result path wording from:
vector_database/<index>/...to:
vector_database/<vdb_engine>/<vdb_index>/...Clarified the distinction between:
--vdb-engine--vdb-index--index-typewhere
--vdb-engineand--vdb-indexidentify the benchmark result path / reporting identity, while--index-typeremains the concrete Milvus build argument used by datasize and datagen.Corrected the HNSW parameter row:
index.Mfrom the stale DiskANN-style flag:
--max-degreeto the HNSW-specific flag:
--MCorrected the HNSW implementation fallback from 64 to 16.
Updated the run-mode row from:
run.mode / --modeto:
run.benchmark_mode / --benchmark-modeRenamed the VectorDB table column from Default to Implementation fallback to avoid implying that parser fallbacks are finalized CLOSED-profile requirements.