Skip to content

Align docs with pluggable benchmark API#1891

Open
jnke2016 wants to merge 6 commits intorapidsai:mainfrom
jnke2016:update-docs
Open

Align docs with pluggable benchmark API#1891
jnke2016 wants to merge 6 commits intorapidsai:mainfrom
jnke2016:update-docs

Conversation

@jnke2016
Copy link
Contributor

@jnke2016 jnke2016 commented Mar 6, 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

1 participant