Skip to content

Remove RAPIDS branding from docs - #229

Open
chyunsu3 wants to merge 1 commit into
rapidsai:mainfrom
chyunsu3:remove_rapids_branding
Open

Remove RAPIDS branding from docs#229
chyunsu3 wants to merge 1 commit into
rapidsai:mainfrom
chyunsu3:remove_rapids_branding

Conversation

@chyunsu3

Copy link
Copy Markdown
Contributor

Closes #207

@chyunsu3
chyunsu3 requested review from a team as code owners September 14, 2026 04:24
@coderabbitai

coderabbitai Bot commented Sep 14, 2026

Copy link
Copy Markdown

Review Change StackReview 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: 8c26d4c6-4cd6-42b5-af53-a4f55146fedb

📥 Commits

Reviewing files that changed from the base of the PR and between 07d10dd and ad7f27b.

📒 Files selected for processing (4)
  • README.md
  • cpp/include/nvforest/README.md
  • docs/source/build.rst
  • docs/source/getting_started.rst

Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated installation guidance with Pip and Conda commands and links to the RAPIDS Installation Guide.
    • Added CUDA-focused system requirements and supported architecture guidance.
    • Clarified that nvForest supports CPU/GPU inference for decision-tree models and does not support training.
    • Updated project branding, NVIDIA CUDA-X for Data Science information, and related links.

Walkthrough

Changes

Documentation and branding updates

Layer / File(s) Summary
Branding and project scope
README.md, cpp/include/nvforest/README.md
Project descriptions and links use NVIDIA CUDA-X terminology. The C++ README describes CPU/GPU inference, supported model sources, and the absence of training support.
Installation guidance
README.md, docs/source/getting_started.rst
Installation instructions use Pip and Conda commands and link to supported operating systems, drivers, and CUDA versions.
Build requirements and CUDA architectures
docs/source/build.rst
Build documentation adds Conda setup guidance, retains GPU-disabled instructions, links to the RAPIDS Installation Guide, and updates CUDA architecture wording.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: csadorf

Merge Risk: ⚪ Minimal · up to ad7f2

The branding and installation documentation updates have no identified issue that should block merging.

🚥 Pre-merge checks | ✅ 2 | ❌ 3

❌ Failed checks (2 warnings, 1 inconclusive)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning Issue [#207] requires documentation, metadata, and branding assets to use NVIDIA CUDA-X terminology. The PR updates several documentation files, but the reviewed head still contains RAPIDS references … Update the remaining documentation references, metadata, and branding assets required by [#207]. Verify that the final repository state no longer uses retired RAPIDS branding where NVIDIA CUDA-X terminology is required.
Out of Scope Changes check ⚠️ Warning The README change removes the Contributing section. The available change summary provides no connection between that removal and the branding-retirement objective in [#207]. The other documented insta… Restore the Contributing section, or move its removal to a separate issue with an explicit requirement.
Description check ❓ Inconclusive The description references the linked issue but does not explain the documentation or branding changes. It is too vague to assess fully. Add a brief summary of the documentation changes, such as removing RAPIDS branding, updating installation guidance, and replacing RAPIDS terminology with NVIDIA CUDA-X terminology.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: removing RAPIDS branding from the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Linked Issues check

Explanation

Issue [#207] requires documentation, metadata, and branding assets to use NVIDIA CUDA-X terminology. The PR updates several documentation files, but the reviewed head still contains RAPIDS references in README.md, docs/source/build.rst, and docs/source/getting_started.rst, including the rapidsai channel, RAPIDS URLs, and rapidsai.disable-cuda. The repository also still contains RAPIDS_BRANCH and docs/source/_static/RAPIDS-logo-purple.png. The change summary shows no metadata or branding-asset updates.

Full details: Out of Scope Changes check

Explanation

The README change removes the Contributing section. The available change summary provides no connection between that removal and the branding-retirement objective in [#207]. The other documented installation and terminology changes are within the issue scope.

  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

LightGBM, or even Scikit-Learn/cuML's random forest implementations, nvForest
cannot be used to _train_ forest models. Instead, its goal is to speed up
inference using forest models trained by all of those packages.
nvForest is a highly-optimized and lightweight library that enables fast inference for decision tree models on NVIDIA GPUs and CPUs. It does not train models; it runs inference on models trained elsewhere (e.g., XGBoost, LightGBM, scikit-learn, or cuML).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I believe that all the libraries are now NVIDIA you should change reference to that at least on the title.

Comment thread docs/source/build.rst
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=OFF``.

**RAPIDS libraries.**

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I beleieve this is still true for the libraries that nvForest is compatible with right?

Maybe use the same wording pointing to cuML or cuDF if those are the libraries that you'd use jointly with nvForest.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

We are planning to remove the RAFT and RMM dependencies, so that nvForest can be used independently of other (formerly) RAPIDS libraries.

Comment thread docs/source/build.rst
should use the latest version of RAPIDS as well. (For example, nvForest 26.04 will require 26.04 version of
all RAPIDS packages.)

**Python dependencies.**

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I believe this info is also still true, just need rewording.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Should we still use the https://docs.rapids.ai/install/ link?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

We are close to migrating that page, see rapidsai/docs#827

If you want to wait for that PR to be in, I can point you in the right direction when it's done.

Comment thread docs/source/build.rst
To build nvForest without GPU, set the CMake option ``NVFOREST_ENABLE_GPU=OFF``.

.. note:: Use Conda to install all software dependencies
Using Conda to install all software dependencies

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

In your readme you have pip and conda installs, maybe mention both in the docs too

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This page is for building nvForest from the source, and for that scenario, we recommend Conda.

In the getting_started.rst, I show both Pip and Conda.

Comment thread README.md
$ conda install -c rapidsai -c conda-forge nvforest
```

## Contributing

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Juts as an FYI you should have a Contributing.md in this repo as part of a requirement of OSRB if you don't have one, please create one accordingly and also make sure you include the DCO if applicable

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

What's the DCO?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update documentation etc to retire RAPIDS brand

2 participants