Skip to content

docs: add dataset loader and reward function tutorial - #463

Open
O7c2 wants to merge 1 commit into
inclusionAI:mainfrom
O7c2:docs/dataset-loader-reward-tutorial
Open

docs: add dataset loader and reward function tutorial#463
O7c2 wants to merge 1 commit into
inclusionAI:mainfrom
O7c2:docs/dataset-loader-reward-tutorial

Conversation

@O7c2

@O7c2 O7c2 commented Aug 11, 2026

Copy link
Copy Markdown

What does this PR do?

Add a step-by-step cookbook tutorial (writing-loaders-and-rewards.rst) that teaches users how to write custom
dataset loaders and reward functions for AReno. Covers the function signatures, record shapes per training mode
(SFT/DPO/RL/Agentic), worked examples for both prompt-based RL and agentic RL, debugging tips for isolated testing,
and common pitfalls.

Also adds cross-references from the existing concept guides (concepts/dataset-formats.rst,
concepts/reward-functions.rst) to the new tutorial.

Related issue

Fixes #42

Type of change

  • 📝 Documentation update

How was it tested?

Built docs with sphinx-build -b html -W . _build/html — zero warnings. Verified all :doc: cross-references resolve
correctly.

Checklist

  • The PR title summarizes the contribution.
  • Linked the related issue in the description (if any).
  • Existing tests pass (pytest tests/ -k cpu). (skipped — doc-only change)
  • New behavior is covered by tests. (N/A — doc-only change)
  • Described the test commands run and any hardware limitations.
  • Public API / CLI changes are additive and backward-compatible (see CONTRIBUTING.md). (N/A)

Add step-by-step cookbook tutorial covering custom dataset loader and
reward function authoring, with worked examples, debugging tips, and
cross-references from concept guides.
@O7c2

O7c2 commented Aug 11, 2026

Copy link
Copy Markdown
Author

#42

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Write a dataset loader and reward function tutorial

1 participant