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

Paying down some tech debt on docs, runtime API, and cython #1055

Merged
merged 39 commits into from
Dec 6, 2022

Conversation

cjnolet
Copy link
Member

@cjnolet cjnolet commented Nov 30, 2022

This PR pays down some tech debt and cleans up some things. On the surface, you'll notice many files have been touched or modified but the modifications are largely confined to a few major categories of changes:

  1. Fixes some of the issues found with the doc updates in 22.12.

  2. Breaks some of the docs for the c++ namespaces down into multiple sections to make them easier to navigate and consume

  3. Renames raft_distance directory into more appropriately named raft_runtime. (This is also in preparation to eventually rename the libraft-distance library into libraft once we can remove the FAISS dependency.

  4. Separates out some runtime source files and APIs that were being mistakenly combined with the template specializations API

  5. Consolidates multiple mdspan.pxd files into a single file.

  6. Consistently uses cpp directory for new(er) pxd files, nested into their respective packages.

  7. Consistently uses doxygen groups in many of the namespaces.

@cjnolet cjnolet added doc Documentation non-breaking Non-breaking change labels Nov 30, 2022
@cjnolet cjnolet requested review from a team as code owners November 30, 2022 16:08
@github-actions github-actions bot added the cpp label Nov 30, 2022
@github-actions github-actions bot added the python label Dec 1, 2022
Copy link
Member

@benfred benfred left a comment

Choose a reason for hiding this comment

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

this looks great! I'm liking how much more fleshed out the docs will be here -

cpp/include/raft/stats/kl_divergence.cuh Outdated Show resolved Hide resolved
python/pylibraft/pylibraft/cluster/kmeans.pyx Show resolved Hide resolved
docs/source/cpp_api/mdspan_mdspan.rst Outdated Show resolved Hide resolved
@cjnolet cjnolet requested a review from a team as a code owner December 2, 2022 21:47
@github-actions github-actions bot added the CMake label Dec 2, 2022
@cjnolet cjnolet changed the title Follow-on fixes for docs Paying down some tech debt on docs, runtime API, and cython Dec 3, 2022
@cjnolet
Copy link
Member Author

cjnolet commented Dec 6, 2022

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 092c515 into rapidsai:branch-23.02 Dec 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CMake cpp doc Documentation non-breaking Non-breaking change python
Projects
Development

Successfully merging this pull request may close these issues.

3 participants