Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Update host refine default #194

Open
shainotshy1 opened this issue Jun 17, 2024 · 1 comment
Open

[DOC] Update host refine default #194

shainotshy1 opened this issue Jun 17, 2024 · 1 comment
Labels
doc Improvements or additions to documentation

Comments

@shainotshy1
Copy link

shainotshy1 commented Jun 17, 2024

Report incorrect documentation

Location of incorrect documentation
(

cuvs::distance::DistanceType metric = cuvs::distance::DistanceType::L2Unexpanded)
)

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.

@shainotshy1 shainotshy1 added the doc Improvements or additions to documentation label Jun 17, 2024
@cjnolet
Copy link
Member

cjnolet commented Jul 3, 2024

Thank you for reporting this issue to us @shainotshy1. We get this fixed asap.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
Development

No branches or pull requests

2 participants