Implementation:Rapidsai Cuml PR Workflow

Knowledge Sources	Rapidsai_Cuml
Domains	Machine_Learning, CI_CD
Last Updated	2026-02-08 12:00 GMT

Overview

This GitHub Actions workflow defines the continuous integration pipeline that runs on every pull request to the cuML repository.

Description

The PR workflow (pr.yaml) orchestrates the full CI pipeline for pull requests targeting the cuML repository. It is triggered when commits are pushed to branches matching the pattern pull-request/[0-9]+. The workflow uses concurrency groups to cancel in-progress runs when new commits are pushed to the same PR branch.

The pipeline consists of the following major stages:

1. Telemetry Setup -- Initializes OpenTelemetry tracing for build observability (continues on error).
2. Check Nightly CI -- Verifies that nightly CI has passed within the last 14 days using a shared action.
3. Changed Files Detection -- Determines which file groups have changed to enable conditional test execution. It defines five file groups: build_docs, test_cpp, test_notebooks, test_python_conda, and test_python_wheels.
4. Checks -- Runs pre-commit and style checks via shared workflows.
5. Clang-Tidy -- Runs C++ static analysis using clang-tidy on an amd64 CPU node with the rapidsai/ci-conda container image.
6. Conda C++ Build and Tests -- Builds the C++ library using conda and runs C++ tests (conditional on changed files).
7. Conda Python Build and Tests -- Builds the Python package and runs single-GPU tests, Dask tests, cudf-pandas integration tests, scikit-learn acceleration tests, and cuML accelerator upstream tests.
8. Notebook Tests -- Runs Jupyter notebook tests on a GPU node.
9. Documentation Build -- Builds documentation on a GPU node.
10. Wheel Builds and Tests -- Builds libcuml and cuml wheels and runs wheel-based tests for both single-GPU and Dask configurations.
11. DevContainer -- Validates the dev container build on both amd64 and arm64 architectures.
12. PR Builder -- The aggregation job that requires all other jobs to pass before reporting overall status.
13. Telemetry Summarize -- Summarizes telemetry traces after all jobs complete.

Most test jobs are conditional on the changed-files output, so unchanged areas of the codebase do not trigger unnecessary test runs.

Usage

This workflow runs automatically when commits are pushed to PR branches. It is not invoked manually. Contributors interact with it by pushing code to a pull request and observing the CI results in the GitHub Actions UI.

Code Reference

Source Location

• Repository: Rapidsai_Cuml
• File: .github/workflows/pr.yaml

Signature

name: pr
on:
  push:
    branches:
      - "pull-request/[0-9]+"
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

Import

# Shared workflow references:
uses: rapidsai/shared-workflows/.github/workflows/pr-builder.yaml@main
uses: rapidsai/shared-workflows/.github/workflows/changed-files.yaml@main
uses: rapidsai/shared-workflows/.github/workflows/checks.yaml@main
uses: rapidsai/shared-workflows/.github/workflows/conda-cpp-build.yaml@main
uses: rapidsai/shared-workflows/.github/workflows/conda-python-build.yaml@main
uses: rapidsai/shared-workflows/.github/workflows/wheels-build.yaml@main

I/O Contract

Inputs

Name	Type	Required	Description
Push event	Git push	Yes	Triggered by pushes to pull-request/[0-9]+ branches
GITHUB_TOKEN	Secret	Yes	Used for nightly CI check and telemetry
GIST_REPO_READ_ORG_GITHUB_TOKEN	Secret	Yes	Token for sccache distributed compilation

Outputs

Name	Type	Description
pr-builder status	Pass/Fail	Aggregate status of all CI jobs
Build artifacts	Conda/Wheel packages	Built packages for C++ and Python components
Test results	Pass/Fail	Results from C++, Python, notebook, and wheel tests

Usage Examples

# The workflow triggers automatically. To run it, push to a PR branch:
# git push origin HEAD:pull-request/1234

# Key jobs and their dependencies:
jobs:
  pr-builder:
    needs:
      - check-nightly-ci
      - changed-files
      - checks
      - clang-tidy
      - conda-cpp-build
      - conda-cpp-tests
      - conda-python-build
      - conda-python-tests-singlegpu
      - conda-python-tests-dask
      - wheel-build-cuml
      - wheel-tests-cuml
      - devcontainer

Related Pages

• Environment:Rapidsai_Cuml_CUDA_GPU