Skip to content

Add installation guide and migration guide#150

Open
hcho3 wants to merge 6 commits into
rapidsai:mainfrom
hcho3:add_install
Open

Add installation guide and migration guide#150
hcho3 wants to merge 6 commits into
rapidsai:mainfrom
hcho3:add_install

Conversation

@hcho3

@hcho3 hcho3 commented Jun 30, 2026

Copy link
Copy Markdown
Contributor
  • Add doctest.

Installation guide
Screenshot 2026-06-30 131711

Migration guide
Screenshot 2026-06-30 131602

@hcho3 hcho3 requested a review from a team as a code owner June 30, 2026 07:40
@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Review Change Stack

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

Documentation updates migrate the FIL guide to nvForest, add installation instructions to the getting started page, and add the migration page to docs navigation.

Changes

Documentation updates

Layer / File(s) Summary
FIL migration guide content
docs/source/fil_migration.rst
Basic workflow example replaces FIL model loading/optimize with nvforest.load_from_sklearn and optimize, notes is_classifier is no longer needed, and replaces the FIL device-selection example with an nvForest snippet documenting device="auto" GPU-first/CPU-fallback behavior.
Getting started installation
docs/source/getting_started.rst
Adds an Installation subsection with PyPI and Conda commands, plus a RAPIDS install note and link.
Docs index entries
docs/source/index.rst
Adds fil_migration to the docs index list and toctree.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: adding installation and migration guides.
Description check ✅ Passed The description is related to the docs changes and screenshots shown in the pull request.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@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/fil_migration.rst`:
- Around line 23-28: The AFTER example in the nvforest migration snippet is
using the unoptimized nvforest_model for predict calls even though optimize()
returns a new model instance. Update the example so the result of
nvforest_model.optimize(batch_size=1024) is assigned back to nvforest_model, or
change the subsequent predict/predict_proba/predict_per_tree/apply calls to use
nvforest_model_optimized, keeping the usage consistent within the documented
flow.
🪄 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: 657abeb1-04e2-45bb-815f-70e7028ebfee

📥 Commits

Reviewing files that changed from the base of the PR and between 5b9f052 and bfe7a09.

📒 Files selected for processing (3)
  • docs/source/fil_migration.rst
  • docs/source/getting_started.rst
  • docs/source/index.rst

Comment thread docs/source/fil_migration.rst Outdated
@hcho3 hcho3 added doc Improvements or additions to documentation non-breaking Introduces a non-breaking change labels Jun 30, 2026
@hcho3 hcho3 requested a review from a team as a code owner June 30, 2026 20:14
@hcho3 hcho3 requested a review from jameslamb June 30, 2026 20:14
@github-actions github-actions Bot added the conda Relates to conda packaging label Jun 30, 2026

@jameslamb jameslamb 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.

Left a couple small comments for your consideration, approving so you can merge without needing another review from me.

Comment thread docs/source/getting_started.rst Outdated
Comment thread docs/source/getting_started.rst Outdated
Comment thread dependencies.yaml Outdated
@github-actions github-actions Bot removed the conda Relates to conda packaging label Jul 1, 2026
Co-authored-by: James Lamb <jaylamb20@gmail.com>
Comment thread docs/source/getting_started.rst Outdated
Comment thread docs/source/fil_migration.rst Outdated
@hcho3

hcho3 commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

/merge

@hcho3

hcho3 commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

@csadorf @dantegd Can I get an approval for this pull request?

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

Labels

doc Improvements or additions to documentation non-breaking Introduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants