[DOC] File names, formats, and usage for Vamana disk build files
Nobody has claimed this yet.
- Dominant language
- Cuda
- Stars
- 854
- Forks
- 236
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 62
Description
Report needed documentation
Report needed documentation
Vamana disk build serializer creates several different files, and usage with the CPU DiskANN repo is complicated. Documentation needed about which files are created and how to use them fro searching with CPU DiskANN. Possibly need to change / streamline file name formats and options to make the usage as simple as possible.
Describe the documentation you'd like
Clear documentation on files created by cuVS vamana serialize (with different options) and how they can be used by CPU DiskANN search. Some sample code would be helpful here as well.
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 by reading the cuVS Vamana disk-build serializer documentation and the CPU DiskANN repository's search guidance. Document the files produced for each serialize option, explain how to use them with CPU DiskANN search, and include sample code; completion should make the cross-repository workflow unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, search
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100