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 RAFT devcontainers #1791

Merged
merged 71 commits into from
Sep 27, 2023
Merged

Conversation

trxcllnt
Copy link
Collaborator

Description

This PR adds some devcontainers to help simplify building the RAFT C++ and Python libraries.

It also adds an optional job to the pr.yaml to build the RAFT libs in each devcontainer, so the build caches are populated for devs by CI.

A devcontainer can be launched by clicking the "Reopen in Container" button that VSCode shows when opening the repo (or by using the "Rebuild and Reopen in Container" command from the command palette):
image

Clicking this button will cause VSCode to prompt the user to select one of these devcontainer variants:
image

On startup, the devcontainer creates or updates the conda/pip environment using raft/dependencies.yaml. The envs/package caches are cached on the host via volume mounts, which are described in more detail in .devcontainer/README.md.

The container includes convenience functions to clean, configure, and build the various RAFT components:

$ clean-raft-cpp # only cleans the C++ build dir
$ clean-pylibraft-python # only cleans the Python build dir
$ clean-raft # cleans both C++ and Python build dirs

$ configure-raft-cpp # only configures raft C++ lib

$ build-raft-cpp # only builds raft C++ lib
$ build-pylibraft-python # only builds raft Python lib
$ build-raft # builds both C++ and Python libs
  • The C++ build script is a small wrapper around cmake -S ~/raft/cpp -B ~/raft/cpp/build and cmake --build ~/raft/cpp/build
  • The Python build script is a small wrapper around pip install --editable ~/raft/cpp

Unlike build.sh, these convenience scripts don't install the libraries after building them. Instead, they automatically inject the correct arguments to build the C++ libraries from source and use their build dirs as package roots:

$ cmake -S ~/raft/cpp -B ~/raft/cpp/build
$ CMAKE_ARGS="-Draft_ROOT=~/raft/cpp/build" \ # <-- this argument is automatic
  pip install -e ~/raft/cpp

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@trxcllnt
Copy link
Collaborator Author

/ok to test

@trxcllnt
Copy link
Collaborator Author

/ok to test

@trxcllnt
Copy link
Collaborator Author

/ok to test

@trxcllnt
Copy link
Collaborator Author

/ok to test

@trxcllnt
Copy link
Collaborator Author

/ok to test

@trxcllnt
Copy link
Collaborator Author

/ok to test

@trxcllnt
Copy link
Collaborator Author

/ok to test

@trxcllnt
Copy link
Collaborator Author

/ok to test

@trxcllnt
Copy link
Collaborator Author

/ok to test

rapids-bot bot pushed a commit to rapidsai/cuspatial that referenced this pull request Sep 25, 2023
Removes the unified and isolated devcontainers in favor of just the single one. The unified devcontainers are [still available](https://github.com/rapidsai/devcontainers/blob/d970ac17a894f5d1047fcfd17cffa6d14fe66ec8/.devcontainer/cuda12.0-conda/devcontainer.json#L23-L31) in the [`rapidsai/devcontainers`](https://github.com/rapidsai/devcontainers) repository.


Adds an optional job to the `pr.yaml` to [build the cuGraph libs in each devcontainer](https://github.com/trxcllnt/cuspatial/blob/fea/devcontainers/.github/workflows/pr.yaml#L106-L111), so the build caches are populated for devs by CI.

Other PRs:

* rapidsai/rmm#1328
* rapidsai/kvikio#273
* rapidsai/cudf#14015
* rapidsai/raft#1791
* rapidsai/cumlprims_mg#149
* rapidsai/cuml#5568
* rapidsai/cugraph-ops#538
* rapidsai/cugraph#3838

Authors:
  - Paul Taylor (https://github.com/trxcllnt)
  - H. Thomson Comer (https://github.com/thomcom)

Approvers:
  - Mark Harris (https://github.com/harrism)
  - Jake Awe (https://github.com/AyodeAwe)

URL: #1263
@trxcllnt
Copy link
Collaborator Author

/ok to test

@trxcllnt
Copy link
Collaborator Author

/ok to test

@@ -0,0 +1,65 @@
# https://clangd.llvm.org/config
Copy link
Member

Choose a reason for hiding this comment

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

Does this imply that you've actually gotten RAFT compiling w/ clang?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No, this file is for the clang language server daemon to provide C++ and CUDA intellisense.

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.

I'll admit I'm no docker expert but the changes here LGTM in general.

@trxcllnt
Copy link
Collaborator Author

/ok to test

@cjnolet
Copy link
Member

cjnolet commented Sep 27, 2023

/merge

@rapids-bot rapids-bot bot merged commit d17376a into rapidsai:branch-23.10 Sep 27, 2023
59 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Ready for Review ci CMake cpp improvement Improvement / enhancement to an existing function non-breaking Non-breaking change python
Projects
Development

Successfully merging this pull request may close these issues.

4 participants