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

Update RAFT documentation #1717

Merged
merged 7 commits into from
Aug 10, 2023
Merged

Conversation

lowener
Copy link
Contributor

@lowener lowener commented Aug 4, 2023

  • Various documentation updates on C++ and Python doc, mainly for raft::neighbors
  • Add QPS vs Recall plot

Signed-off-by: Mickael Ide <mide@nvidia.com>
@github-actions github-actions bot added the python label Aug 4, 2023
@lowener lowener added doc Documentation non-breaking Non-breaking change labels Aug 4, 2023
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.

Overall I think the changes look great. I'm holding off on approving only because of the format changes for the code examples in the python docs. We had originally shifted these examples to a different format and I don't know if we want to revert them.

cc @benfred @galipremsagar for their thoughts here.

@lowener lowener marked this pull request as ready for review August 7, 2023 14:52
@lowener lowener requested a review from a team as a code owner August 7, 2023 14:52
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.

Changes LGTM! If we are choosing to document simple param structs at the class level, we should be as consistent as possible and make sure we do it everywhere.

Looks like the doctest pytests are failing. We should be able to merge after we fix those.

@cjnolet
Copy link
Member

cjnolet commented Aug 9, 2023

/merge

Signed-off-by: Mickael Ide <mide@nvidia.com>
@rapids-bot rapids-bot bot merged commit f49d8a2 into rapidsai:branch-23.10 Aug 10, 2023
@lowener lowener deleted the 23.10-doc branch August 10, 2023 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation non-breaking Non-breaking change python
Projects
Development

Successfully merging this pull request may close these issues.

3 participants