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 cuML devcontainers #5568

Merged
merged 62 commits into from
Dec 9, 2023
Merged

Conversation

trxcllnt
Copy link
Collaborator

Description

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

It also adds an optional job to the pr.yaml to build the cuML 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 cuml/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 cuML components:

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

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

$ build-cuml-cpp # only builds cuml C++ lib
$ build-cuml-python # only builds cuml Python lib
$ build-cuml # builds both C++ and Python libs
  • The C++ build script is a small wrapper around cmake -S ~/cuml/cpp -B ~/cuml/cpp/build and cmake --build ~/cuml/cpp/build
  • The Python build script is a small wrapper around pip install --editable ~/cuml/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 ~/cuml/cpp -B ~/cuml/cpp/build
$ CMAKE_ARGS="-Dcuml_ROOT=~/cuml/cpp/build" \ # <-- this argument is automatic
  pip install -e ~/cuml/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 added 30 commits July 17, 2023 10:11
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

@bdice bdice changed the base branch from branch-23.10 to branch-24.02 November 17, 2023 00:55
@github-actions github-actions bot added the conda conda issue label Nov 17, 2023
@bdice
Copy link
Contributor

bdice commented Nov 17, 2023

/ok to test

@github-actions github-actions bot removed the conda conda issue label Nov 20, 2023
@bdice
Copy link
Contributor

bdice commented Nov 20, 2023

/ok to test

@bdice
Copy link
Contributor

bdice commented Nov 28, 2023

/ok to test

@bdice
Copy link
Contributor

bdice commented Dec 1, 2023

/ok to test

vyasr
vyasr previously requested changes Dec 6, 2023
dependencies.yaml Show resolved Hide resolved
dependencies.yaml Show resolved Hide resolved
dependencies.yaml Show resolved Hide resolved
@bdice
Copy link
Contributor

bdice commented Dec 8, 2023

/ok to test

@bdice
Copy link
Contributor

bdice commented Dec 8, 2023

/ok to test

@bdice bdice requested a review from vyasr December 8, 2023 14:38
@bdice
Copy link
Contributor

bdice commented Dec 8, 2023

/merge

@rapids-bot rapids-bot bot merged commit c524553 into rapidsai:branch-24.02 Dec 9, 2023
55 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 Ready for review by team ci CMake CUDA/C++ Cython / Python Cython or Python issue 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.

7 participants