docs(vdb): update command examples for current CLI#588
Draft
idevasena wants to merge 4 commits into
Draft
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 ✍️ ✅ |
Contributor
|
@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! :-) |
Contributor
|
Perfect. I'm done merging for the day. I'll await further instructions. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.