[DOC] cuvs_bench should recommend specific block sizes and k-values
Open
Beginner friendly
Nobody has claimed this yet.
doc
- Dominant language
- Cuda
- Stars
- 854
- Forks
- 236
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 62
Description
Report incorrect documentation
The cuvs_bench documentation recommends a block size of 10 and k-value of 10 for running the benchmarks, but does not specify -bs and -k when exporting and plotting the results. Thus, the default block size (not 10) is used, and the export fails. The example listed should specify -bs and -k.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start from the cuvs_bench documentation example that recommends block size 10 and k-value 10, then inspect the export and plotting commands. Update the example so it explicitly passes -bs and -k, and verify that the documented benchmark export no longer uses the default block size or fails.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100