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

Add refine to public API #154

Merged
merged 7 commits into from
May 28, 2024
Merged

Conversation

lowener
Copy link
Contributor

@lowener lowener commented May 24, 2024

Add cuvs::neighbors::refine to public API, with it's test

@lowener lowener added the non-breaking Introduces a non-breaking change label May 24, 2024
@lowener lowener requested review from a team as code owners May 24, 2024 17:30
@lowener lowener changed the title 24 06 refine Add refine to public API May 24, 2024
@lowener lowener added the feature request New feature or request label May 24, 2024
Copy link
Contributor

@tfeher tfeher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Mickael for the PR! Looks good, just a few small comments.

cpp/include/cuvs/neighbors/refine.hpp Outdated Show resolved Hide resolved
cpp/include/cuvs/neighbors/refine.hpp Outdated Show resolved Hide resolved
void refine(raft::resources const& handle,
raft::host_matrix_view<const float, int64_t, raft::row_major> dataset,
raft::host_matrix_view<const float, int64_t, raft::row_major> queries,
raft::host_matrix_view<const uint32_t, int64_t, raft::row_major> neighbor_candidates,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: this is the only place where uint32_t indices are accepted. While I think it is good to handle uint32_t indices, if we do that we shall probably do for all dataset type (not only floats).

We should agree on what the supported index type shall be, and update here accordingly. I have created an issue for discussion #156.

@lowener lowener requested a review from a team as a code owner May 24, 2024 18:59
@lowener lowener requested a review from tfeher May 24, 2024 19:00
Copy link
Member

@cjnolet cjnolet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great- just one thing wrt docs (and we should really make sure we're doing it across the public APIs).

/**
* @defgroup ann_refine Approximate Nearest Neighbors Refinement
* @{
*/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know it seems exhaustive and repetitive, but for documentation's sake, please copy and update the docs for each individual prototype below. We want to make sure what any function in the docs a user looks up is going to carry along the full doc string with it, not matter the type.

@lowener lowener requested a review from cjnolet May 25, 2024 00:33
Copy link
Contributor

@tfeher tfeher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @lowener for the updates, the PR looks good to me!

Signed-off-by: Mickael Ide <[email protected]>
@tfeher tfeher mentioned this pull request May 28, 2024
10 tasks
@cjnolet
Copy link
Member

cjnolet commented May 28, 2024

/merge

@rapids-bot rapids-bot bot merged commit b9e8a4b into rapidsai:branch-24.06 May 28, 2024
54 checks passed
@lowener lowener deleted the 24-06_refine branch May 29, 2024 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CMake cpp feature request New feature or request non-breaking Introduces a non-breaking change
Projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants