Remove RAPIDS branding from docs - #229
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (4)
Included review availability: Your plan provides up to 12 included reviews per hour; 11 remain after this review. 📝 SummarySummary by CodeRabbit
WalkthroughChangesDocumentation and branding updates
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~10 minutes Change: Other Suggested reviewers: Merge Risk: ⚪ Minimal · up to 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)
✅ Passed checks (2 passed)
Full details: Linked Issues checkExplanation Issue [ Full details: Out of Scope Changes checkExplanation The README change removes the Contributing section. The available change summary provides no connection between that removal and the branding-retirement objective in [
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Comment |
| 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). |
There was a problem hiding this comment.
I believe that all the libraries are now NVIDIA you should change reference to that at least on the title.
| 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.** |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
We are planning to remove the RAFT and RMM dependencies, so that nvForest can be used independently of other (formerly) RAPIDS libraries.
| 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.** |
There was a problem hiding this comment.
I believe this info is also still true, just need rewording.
There was a problem hiding this comment.
Should we still use the https://docs.rapids.ai/install/ link?
There was a problem hiding this comment.
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.
| 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 |
There was a problem hiding this comment.
In your readme you have pip and conda installs, maybe mention both in the docs too
There was a problem hiding this comment.
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.
| $ conda install -c rapidsai -c conda-forge nvforest | ||
| ``` | ||
|
|
||
| ## Contributing |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
See example in this section from rapidsmpf https://github.com/rapidsai/rapidsmpf/blob/main/CONTRIBUTING.md#signing-your-work
Closes #207