[Doc] Add tutorial by hcho3 · Pull Request #48 · rapidsai/nvforest

hcho3 · 2026-02-24T07:56:00Z

Migrate BUILD.md to Sphinx.
Provide a basic tutorial for Python and C++ API.
Rename: cuforest -> nvforest

coderabbitai · 2026-02-24T07:56:38Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

📝 Walkthrough

Walkthrough

The changes consolidate and reorganize nvForest documentation by moving detailed build instructions from BUILD.md to a new comprehensive docs/source/build.rst file, adding new getting-started guides with Python and C++ usage examples, restructuring the documentation index with updated toctree entries, removing the supported versions documentation, and updating build system paths for Doxygen configuration.

Changes

Cohort / File(s)	Summary
Documentation Consolidation `BUILD.md`, `docs/source/build.rst`	Removed detailed build and environment setup instructions from BUILD.md (214 lines) and delegated to new comprehensive build.rst documentation covering hardware/software dependencies, GPU/CPU build modes, conda setup, CMake workflow, custom build options, and ccache usage.
Documentation Restructuring `docs/source/index.rst`, `docs/source/supported_versions.rst`	Updated documentation title from cuForest to nvForest, restructured toctree entries to include new Getting started and build sections, and removed entire supported_versions.rst file (10 lines deleted).
New Documentation `docs/source/getting_started.rst`	Added comprehensive getting-started guide with Python examples (XGBoost, LightGBM, scikit-learn model loading), multi-GPU device handling, inference methods, and C++/Treelite integration workflow with code examples.
Documentation Formatting Updates `docs/source/cpp_api.rst`, `docs/source/python_api.rst`	Updated documentation header formatting from underlined titles to formatted heading blocks; changed "C++ API Documentation" to "C++ API" and "Python API Reference" to "Python API".
Build System Updates `cpp/CMakeLists.txt`	Updated Doxygen target configuration to reference new doxygen subdirectory paths for both OUT_DOXYFILE and working directory instead of root directory.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

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

Co-authored-by: James Lamb <jaylamb20@gmail.com>

hcho3 · 2026-02-25T03:27:22Z

/merge

copy-pr-bot · 2026-02-27T18:15:16Z

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

hcho3 · 2026-02-27T18:47:37Z

/ok to test 596d49f

csadorf

Not sure how this got merged, but there are some things that need to be fixed.

csadorf · 2026-02-27T18:17:39Z

+   It is possible to build nvForest without GPU support; in this case, the CUDA toolkit is not required.
+   To build nvForest without GPU, set the CMake option ``NVFOREST_ENABLE_GPU=ON``.


That seems backwards.

csadorf · 2026-02-27T18:20:37Z

We should automatically run the code in these files in a follow-up. I know that we are note, because there are some minor syntax errors within the code right now.

I'm sorry that I missed the syntax errors. I will pay more attention to the details in the future. Also, I will follow up by creating an automated CI pipeline to run the example code.

csadorf · 2026-02-27T18:21:23Z

+   fm = nvforest.load_model("/path/to/xgboost_model.ubj", device="gpu"
+                            model_type="xgboost_ubj")


missing comma

Suggested change

fm = nvforest.load_model("/path/to/xgboost_model.ubj", device="gpu"

model_type="xgboost_ubj")

fm = nvforest.load_model("/path/to/xgboost_model.ubj", device="gpu",

model_type="xgboost_ubj")

csadorf · 2026-02-27T18:21:48Z

+  The model will reside in the GPU memory.
+* :py:class:`~nvforest.CPUForestInferenceClassifier`: a classification model, to run on CPU.
+  The model object will reside in the main memory.
+* :py:class:`~nvforest.CPUForestInferenceRegressor`: a classification model, to run on CPU.


Suggested change

* :py:class:`~nvforest.CPUForestInferenceRegressor`: a classification model, to run on CPU.

* :py:class:`~nvforest.CPUForestInferenceRegressor`: a regression model, to run on CPU.

csadorf · 2026-02-27T18:22:10Z

+  std::unique_ptr<treelite::Model> treelite_model
+    = treelite::model_loader::LoadXGBoostModelUBJSON(
+        "/path/to/xgboost_model.ubj", "{}")


missing semicolon

Suggested change

std::unique_ptr<treelite::Model> treelite_model

= treelite::model_loader::LoadXGBoostModelUBJSON(

"/path/to/xgboost_model.ubj", "{}")

std::unique_ptr<treelite::Model> treelite_model

= treelite::model_loader::LoadXGBoostModelUBJSON(

"/path/to/xgboost_model.ubj", "{}");

csadorf · 2026-02-27T18:22:39Z

+     - [ON, OFF]
+     - ON
+     - Use detection of conda environment for dependencies. If set to ON, and no value for CMAKE_INSTALL_PREFIX is passed, then it will assign it to $CONDA_PREFIX (to install in the active environment).
+   * - DIABLE_DEPRECATION_WARNINGS


typo

Suggested change

* - DIABLE_DEPRECATION_WARNINGS

* - DISABLE_DEPRECATION_WARNINGS

csadorf · 2026-02-27T19:39:33Z

Not sure how this got merged, but there are some things that need to be fixed.

Might be related to the codeowner team names.

* Address comments from #48 * Set up doctest Authors: - Philip Hyunsu Cho (https://github.com/hcho3) - Simon Adorf (https://github.com/csadorf) Approvers: - Simon Adorf (https://github.com/csadorf) - James Lamb (https://github.com/jameslamb) URL: #60

hcho3 added 4 commits February 23, 2026 22:53

Migrate BUILD.md to Sphinx rst

7535bc7

Misc polish

572bed9

Add tutorial

a19deed

Refine docstring for C++ predict

2178a1a

hcho3 requested review from a team as code owners February 24, 2026 07:56

hcho3 requested a review from jameslamb February 24, 2026 07:56

github-actions Bot added the CUDA/C++ label Feb 24, 2026

hcho3 added doc Improvements or additions to documentation non-breaking Introduces a non-breaking change labels Feb 24, 2026

Remove supported_versions.rst

ec77254

jameslamb approved these changes Feb 24, 2026

View reviewed changes

Comment thread docs/source/build.rst Outdated

github-actions Bot added the CMake label Feb 25, 2026

Use cmake --build; remove cd

5e6c8d9

Co-authored-by: James Lamb <jaylamb20@gmail.com>

hcho3 force-pushed the add_tutorial branch from fdd8406 to 5e6c8d9 Compare February 25, 2026 02:29

hcho3 added 3 commits February 25, 2026 13:53

Revert C++ change for now

ed2a219

Rename cuForest -> nvForest

d415521

Merge remote-tracking branch 'origin/main' into add_tutorial

1b81e97

hcho3 force-pushed the add_tutorial branch from 99fb3dd to 1b81e97 Compare February 25, 2026 21:59

rapidsai deleted a comment from copy-pr-bot Bot Feb 25, 2026

hcho3 mentioned this pull request Feb 26, 2026

Update codebase to rename cuforest -> nvforest #51

Merged

Merge remote-tracking branch 'origin/main' into add_tutorial

596d49f

rapids-bot Bot merged commit b4e8ba2 into rapidsai:main Feb 27, 2026
59 checks passed

csadorf reviewed Feb 27, 2026

View reviewed changes

hcho3 deleted the add_tutorial branch February 27, 2026 21:54

This was referenced Feb 28, 2026

Fix typos and syntax error in tutorial #52

Closed

Fix typos and syntax error in tutorial #60

Merged

		It is possible to build nvForest without GPU support; in this case, the CUDA toolkit is not required.
		To build nvForest without GPU, set the CMake option ``NVFOREST_ENABLE_GPU=ON``.

		fm = nvforest.load_model("/path/to/xgboost_model.ubj", device="gpu"
		model_type="xgboost_ubj")

	* :py:class:`~nvforest.CPUForestInferenceRegressor`: a classification model, to run on CPU.
	* :py:class:`~nvforest.CPUForestInferenceRegressor`: a regression model, to run on CPU.

	* - DIABLE_DEPRECATION_WARNINGS
	* - DISABLE_DEPRECATION_WARNINGS

Conversation

hcho3 commented Feb 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Feb 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Changes

Estimated code review effort

Uh oh!

Uh oh!

hcho3 commented Feb 25, 2026

Uh oh!

copy-pr-bot Bot commented Feb 27, 2026

Uh oh!

hcho3 commented Feb 27, 2026

Uh oh!

Uh oh!

csadorf left a comment

Choose a reason for hiding this comment

Uh oh!

csadorf Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

csadorf Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

hcho3 Feb 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

csadorf Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

csadorf Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

csadorf Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

csadorf Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

csadorf commented Feb 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hcho3 commented Feb 24, 2026 •

edited

Loading

coderabbitai Bot commented Feb 24, 2026 •

edited

Loading

hcho3 Feb 27, 2026 •

edited

Loading