Skip to content

[doc][ML] Update the RDataLoader documentation page - #23916

Merged
siliataider merged 2 commits into
root-project:masterfrom
siliataider:rdataloader
Nov 19, 2026
Merged

siliataider merged 2 commits into
root-project:masterfrom
siliataider:rdataloader

Conversation

@siliataider

@siliataider siliataider commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

The layout now is a walkthrough of a simple mock training script exploring all the features the RDataLoader offers.

You can preview the changes by downloading the page rendered as a PDF rdataloader-doc-preview.pdf

The `*/bindings/pyroot/*.py` exclude pattern drops all the pythonization files found in the directory,
only their module docstrings reach the documentation through the `extract_docstrings.py` script and attach on top of their C++ class reference docs pages.
`RDataLoader` is a pure Python class with no C++ class page to attach to so its class and method docstrings just never appeared.
Listing `_ml_dataloader.py` explicitly in the input ignores the exclude pattern for this file only.
@siliataider siliataider self-assigned this Oct 30, 2026
@siliataider siliataider added the skip ci Skip the full builds on the actions runners label Oct 30, 2026
@github-actions

github-actions Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

Test Results

0 tests   0 ✅  0s ⏱️
0 suites  0 💤
0 files    0 ❌

Results for commit 2d71d66.

♻️ This comment has been updated with latest results.

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

Thanks, this is great! Some comments for your consideration before final approval.

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

Thanks!

@siliataider
siliataider merged commit 44db4aa into root-project:master Nov 19, 2026
15 checks passed
@siliataider

Copy link
Copy Markdown
Contributor Author

/backport to 6.42

@root-project-bot

Copy link
Copy Markdown

Preparing to backport PR #23916 to branch 6.42 requested by siliataider

@root-project-bot

Copy link
Copy Markdown

This PR has been backported to branch 6.42: #24252

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

Labels

AI-Assisted in:Documentation in:ML Everything under ROOT/ML in:Python Interface skip ci Skip the full builds on the actions runners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants