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

Moving a few more things around #822

Merged

Conversation

cjnolet
Copy link
Member

@cjnolet cjnolet commented Sep 13, 2022

  1. Moving lap -> raft::solver, mst -> raft::sparse::solver, single_linkage -> raft::cluster.

  2. This also establishes a convention for headers which include definitions for various API vocabulary types, such as knn indices, distance enum types, etc...

  3. Common utilities are moved into the raft/util directory.

  4. raft/sparse/selection is renamed to raft/sparse/spatial

  5. Excluding removed and deprecated items from docs where appropriate.

Proper deprecation is done so these changes shouldn't break any users downstream.

`raft::sparse::solver, `single_linkage` -> raft::cluster.
@cjnolet cjnolet requested a review from a team as a code owner September 13, 2022 15:23
@github-actions github-actions bot added the cpp label Sep 13, 2022
@cjnolet cjnolet added improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Sep 13, 2022

1. Use the `hpp` extension for files which can be compiled with `gcc` against the CUDA-runtime. Use the `cuh` extension for files which require `nvcc` to be compiled. `hpp` can also be used for functions marked `__host__ __device__` only if proper checks are in place to remove the `__device__` designation when not compiling with `nvcc`.

2. When additional classes, structs, or general POCO types are needed to be used for representing data in the public API, place them in a new file called `<primitive_name>_types.hpp`. This tells users they are safe to expose these types on their own public APIs without bringing in device code. At a minimum, the definitions for these types, at least, should not require `nvcc`. In general, these classes should only store very simple state and should not perform their own computations. Instead, new functions should be exposed on the public API which accept these objects, reading or updating their state as necessary.
Copy link
Member

Choose a reason for hiding this comment

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

These design considerations are great!

@cjnolet
Copy link
Member Author

cjnolet commented Sep 14, 2022

@gpucibot merge

@rapids-bot rapids-bot bot merged commit cc95aed into rapidsai:branch-22.10 Sep 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cpp improvement Improvement / enhancement to an existing function non-breaking Non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants