Skip to content

Add README#55

Merged
rapids-bot[bot] merged 1 commit intorapidsai:mainfrom
csadorf:add-readme
Mar 2, 2026
Merged

Add README#55
rapids-bot[bot] merged 1 commit intorapidsai:mainfrom
csadorf:add-readme

Conversation

@csadorf
Copy link
Contributor

@csadorf csadorf commented Mar 2, 2026

No description provided.

@csadorf csadorf requested a review from a team as a code owner March 2, 2026 19:12
@csadorf csadorf requested a review from gforsyth March 2, 2026 19:12
@csadorf csadorf added improvement Improves an existing functionality non-breaking Introduces a non-breaking change labels Mar 2, 2026
@coderabbitai
Copy link

coderabbitai bot commented Mar 2, 2026

ℹ️ Recent review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between e179377 and 6f4de72.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated project title to "nvForest - Highly Optimized Decision Tree Inference"
    • Expanded README with comprehensive overview and usage examples
    • Added GPU inference examples for XGBoost and scikit-learn
    • Included sections on supported models, inference modes, performance tuning, installation, and contribution guidelines

Walkthrough

The README.md file was substantially expanded to introduce the project as "nvForest - Highly Optimized Decision Tree Inference" with comprehensive documentation including usage examples, supported models, inference modes, performance tuning options, and sections on installation, building, contributing, and contact information.

Changes

Cohort / File(s) Summary
README Documentation
README.md
Replaced simple header with full tutorial-style documentation including project title, overview, GPU inference examples, supported models, inference modes, performance tuning, installation, build instructions, contributing guidelines, and contact information.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 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.

@csadorf csadorf linked an issue Mar 2, 2026 that may be closed by this pull request

## Installation

See [the RAPIDS Release Selector](https://docs.rapids.ai/install#selector) for the command line to install either nightly or official release nvForest packages via conda, pip, or Docker.
Copy link

Choose a reason for hiding this comment

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

Do we have a PR open to add this to the install selector or is this something we are planning to do?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We still need a PR for that, I can create that.


## Contact

Find out more on the [RAPIDS site](https://rapids.ai/community.html).
Copy link

Choose a reason for hiding this comment

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

Suggested change
Find out more on the [RAPIDS site](https://rapids.ai/community.html).
For bug reports or feature requests, please [file an issue](https://github.com/rapidsai/nvforest/issues/new) on GitHub.
For questions or discussion about nvForest or tree model inference, reach out in the [RAPIDS Slack](https://rapids.ai/slack-invite) workspace.```

Copy link

Choose a reason for hiding this comment

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

I think some of the content on that webpage is outdated so suggested this, but feel free to modify.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should we maybe push to modernize https://rapids.ai/community.html instead ?

@csadorf
Copy link
Contributor Author

csadorf commented Mar 2, 2026

/merge

@rapids-bot rapids-bot bot merged commit 9d28631 into rapidsai:main Mar 2, 2026
36 checks passed
@jameslamb jameslamb mentioned this pull request Mar 3, 2026
25 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement Improves an existing functionality non-breaking Introduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create README

3 participants