[DOC] Update host refine default
Nobody has claimed this yet.
- Dominant language
- Cuda
- Stars
- 854
- Forks
- 236
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 62
Description
Report incorrect documentation
Location of incorrect documentation
(https://github.com/rapidsai/cuvs/blob/9dc3a4dc5085cb5eb92d18ca1eafd5eef3dc405e/cpp/src/neighbors/refine/refine_host.hpp#L179)
Describe the problems or issues found in the documentation
The default value for the metric is for host refine is L2Unexpanded however the only supported metrics are L2Expanded and InnerProduct.
Steps taken to verify documentation is incorrect
Ran refinement without passing in value for metric and this fails to run to due to "Unsupported metric."
Suggested fix for documentation
Change default to L2Expanded or support L2Unexpanded usage in refine call.
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 cpp/src/neighbors/refine/refine_host.hpp at line 179 and rerun refinement without a metric to confirm the reported unsupported-metric failure. Resolve whether the documented default should change or L2Unexpanded should be supported, then update the relevant documentation or implementation and verify the no-metric call succeeds.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100