Skip to content

DOC Add hyper-parameter search example - #8095

Merged
rapids-bot[bot] merged 4 commits into
NVIDIA:release/26.06from
betatim:estimator-tournament-example
May 18, 2026
Merged

DOC Add hyper-parameter search example#8095
rapids-bot[bot] merged 4 commits into
NVIDIA:release/26.06from
betatim:estimator-tournament-example

Conversation

@betatim

@betatim betatim commented May 13, 2026

Copy link
Copy Markdown
Contributor

This adds a cuml.accel example that illustrates the point that using cuml.accel makes it easier to do things because you aren't interrupted by things taking forever and forever.

It uses a simple pipeline that can be fully GPU accelerated and then searches a few hyper-parameter combinations for that pipeline.

@betatim
betatim requested a review from a team as a code owner May 13, 2026 12:24
@betatim
betatim requested a review from viclafargue May 13, 2026 12:24
@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@betatim betatim added doc Documentation non-breaking Non-breaking change labels May 13, 2026
@coderabbitai

coderabbitai Bot commented May 13, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: f64cb450-235c-4595-a348-830a73cc8567

📥 Commits

Reviewing files that changed from the base of the PR and between de17423 and b4d478f.

📒 Files selected for processing (1)
  • docs/source/cuml-accel/examples/index.rst
✅ Files skipped from review due to trivial changes (1)
  • docs/source/cuml-accel/examples/index.rst

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added a new example notebook demonstrating accelerated randomized hyperparameter tuning for an end-to-end preprocessing + classification workflow, including inspecting top configurations and evaluating the best model on a held-out test set.
    • Included the notebook in the examples documentation navigation so it appears alongside other tutorials.

Walkthrough

Adds a new Jupyter notebook demonstrating accelerated hyperparameter search with cuml.accel: loads the Forest Cover Type dataset (300k subsample), builds a StandardScaler→PCA→KNeighbors pipeline, runs RandomizedSearchCV (20 iter, 5-fold) and evaluates the refit model; registers the notebook in the examples index.

Changes

Hyperparameter Search Example

Layer / File(s) Summary
Introduction and dataset preparation
docs/source/cuml-accel/examples/hyperparameter_search.ipynb
Introduces the accelerated hyperparameter search use case, three-stage pipeline, and dataset. Loads Forest Cover Type via fetch_covtype, subsamples to 300k rows, and creates stratified 80/20 train/test splits.
Model pipeline and hyperparameter search
docs/source/cuml-accel/examples/hyperparameter_search.ipynb
Constructs a scikit-learn Pipeline with StandardScaler, PCA, and KNeighborsClassifier. Declares param_distributions for PCA components and KNN hyperparameters. Runs RandomizedSearchCV with n_iter=20, cv=5, scoring="accuracy", random_state=42, n_jobs=1, and refit=True after enabling %load_ext cuml.accel.
Results inspection, evaluation, and registration
docs/source/cuml-accel/examples/hyperparameter_search.ipynb, docs/source/cuml-accel/examples/index.rst
Prints search.best_params_ and search.best_score_, converts search.cv_results_ to a DataFrame and shows top-ranked configurations, evaluates the refit best model on the test set with search.score, includes notebook metadata, and adds the notebook to the examples .. toctree::.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

  • jcrist
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: adding a documentation example for hyperparameter search with cuml.accel.
Description check ✅ Passed The description is related to the changeset, explaining the purpose of the new example and how it demonstrates cuml.accel benefits.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/source/cuml-accel/examples/hyperparameter_search.ipynb`:
- Around line 32-34: Update the two benchmark sentences that read "Without
`cuml.accel`, this search takes ~4.5 minutes" and "With `cuml.accel` enabled the
same search completes in ~30 seconds" to clearly state these are example results
from a specific test machine/configuration (e.g., "On our test machine (specify
CPU/GPU, n_jobs, and other relevant config), this search took ~4.5 minutes; with
`cuml.accel` enabled it completed in ~30 seconds"), and apply the same qualified
wording to the later occurrence of the timing text (the similar lines around the
second mention) so readers understand timings are hardware/setup dependent.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: fffff2cd-2ac4-4bbe-8d0d-f8b9844bee63

📥 Commits

Reviewing files that changed from the base of the PR and between 57426c4 and 9fe7a14.

📒 Files selected for processing (2)
  • docs/source/cuml-accel/examples/hyperparameter_search.ipynb
  • docs/source/cuml-accel/examples/index.rst

Comment thread docs/source/cuml-accel/examples/hyperparameter_search.ipynb Outdated
@betatim
betatim changed the base branch from main to release/26.06 May 15, 2026 15:42

@jcrist jcrist left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

:shipit:

@jcrist

jcrist commented May 18, 2026

Copy link
Copy Markdown
Member

/merge

@rapids-bot
rapids-bot Bot merged commit 8e26320 into NVIDIA:release/26.06 May 18, 2026
56 checks passed
@betatim
betatim deleted the estimator-tournament-example branch May 19, 2026 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants