docs: add dataset loader and reward function tutorial - #463
Open
O7c2 wants to merge 1 commit into
Open
Conversation
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.
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Add a step-by-step cookbook tutorial (
writing-loaders-and-rewards.rst) that teaches users how to write customdataset 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
How was it tested?
Built docs with
sphinx-build -b html -W . _build/html— zero warnings. Verified all:doc:cross-references resolvecorrectly.
Checklist
pytest tests/ -k cpu). (skipped — doc-only change)