Align docs with pluggable benchmark API#1891
Merged
rapids-bot[bot] merged 13 commits intorapidsai:mainfrom Apr 9, 2026
Merged
Conversation
aamijar
added
non-breaking
cjnolet
reviewed
Mar 25, 2026
docs/source/cuvs_bench/index.rst
Outdated
|
|
||
| **Recommended: Orchestrator API** | ||
|
|
||
| Use the `BenchmarkOrchestrator` from `cuvs_bench.orchestrator` for the full workflow: |
Member
There was a problem hiding this comment.
Just to avoid confusion, let's assume a new user coming to the docs does not know about, nor want to use, the old APIs. Let's just remove them altogerher and put this as the way users should be downloading datasets and running benchmarks.
cjnolet
reviewed
Mar 25, 2026
docs/source/cuvs_bench/index.rst
Outdated
| # (4) Plot results. | ||
| python -m cuvs_bench.plot --dataset deep-image-96-inner | ||
|
|
||
| **Legacy CLI** |
cjnolet
reviewed
Mar 25, 2026
|
|
||
| **Tune mode** | ||
|
|
||
| Pass ``mode="tune"`` to use Optuna to search the parameter space instead of running every combination. You must pass: |
Member
There was a problem hiding this comment.
Maybe work the term "hyperparameter optimization" into this sentence, just for user benefit (so they can make the connection between the two).
cjnolet
reviewed
Mar 25, 2026
|
|
||
| Pass ``mode="tune"`` to use Optuna to search the parameter space instead of running every combination. You must pass: | ||
|
|
||
| - **constraints** (dict): The optimization target and optional bounds. One metric must be ``"maximize"`` or ``"minimize"`` (the goal). Others can set hard limits with ``{"min": X}`` or ``{"max": X}``. Examples: ``{"recall": "maximize", "latency": {"max": 10}}`` or ``{"latency": "minimize", "recall": {"min": 0.95}}``. |
cjnolet
approved these changes
Apr 8, 2026
Member
|
/merge |
github-project-automation
bot
moved this from In Progress
to Done
in Unstructured Data Processing
enp1s0
pushed a commit
to enp1s0/cuvs
that referenced
this pull request
Apr 10, 2026
**Description of changes** cuVS Bench documentation updates to align with the pluggable benchmark API: - **index.rst**: Fix datasets.yaml path and document the `constraints` field in algorithm YAML; add Recommended (orchestrator API) and Legacy CLI workflow; fix intro typo. - **param_tuning.rst**: Add Benchmark modes (sweep vs tune) and tune-mode example. - **pluggable_backend.rst** (new): Document config loader + backend pair, run flow, what the loader produces, steps to add a backend, and a minimal Elasticsearch-style example. Add to cuvs_bench toctree. Authors: - Joseph Nke (https://github.com/jnke2016) - Corey J. Nolet (https://github.com/cjnolet) - Anupam (https://github.com/aamijar) Approvers: - Corey J. Nolet (https://github.com/cjnolet) URL: rapidsai#1891
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
3 participants
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.
Description of changes
cuVS Bench documentation updates to align with the pluggable benchmark API:
constraintsfield in algorithm YAML; add Recommended (orchestrator API) and Legacy CLI workflow; fix intro typo.