NVIDIA / NVIDIA/cuvs

[FEA] Improve usability and documentation of cuvs-bench python wrapper

Open
#679 0 comments 0 reactions 1 assignee View on GitHub

@tfeher is already working on this.

Since Feb 11, 2025.

doc feature request
Dominant language
Cuda
Stars
854
Forks
236
Avg merge
3d 3h
Merged PRs (30d)
62

Description

The python wrapper around the cuvs ANN benchmark is a useful tool that can make it easy to run and evaluate parameter scans. Unfortunately, there are a few issues with it that are either a problem with documentation, or a missing feature. Here I list these:

  • I have created a new dataset, and placed in /path/to/mydataset/dataset.fbin. What are the exact steps needed to use this dataset in the benchmarks?
  • I need to control which executable to use (e.g. I have multiple binaries compiled with different experimental features). How to do that
  • Only use benchmark configs I specify, not other base configs (#585)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.