Skip to content

docs: expand dataset formats into a full reference guide - #465

Open
O7c2 wants to merge 3 commits into
inclusionAI:mainfrom
O7c2:docs/dataset-formats-guide
Open

docs: expand dataset formats into a full reference guide#465
O7c2 wants to merge 3 commits into
inclusionAI:mainfrom
O7c2:docs/dataset-formats-guide

Conversation

@O7c2

@O7c2 O7c2 commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

Rewrite the Dataset Formats concept page as a comprehensive reference guide covering the mental model (raw data →
loader → schema), all training schemas with concrete examples and working CLI commands, GSM8K walkthrough, and a
schema summary table.

Related issue

See #70

Type of change

  • 📝 Documentation update

How was it tested?

Built docs with sphinx-build -b html -W . _build/html — zero warnings.

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)

o7c2 added 3 commits August 11, 2026 15:33
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.
State that the current runtime is AReno-owned CUDA/NVIDIA code, and
explicitly list MLX, TPU, vLLM, SGLang, Megatron, and Ray as out of
scope per issue inclusionAI#58.

Closes inclusionAI#58
Rewrite the Dataset Formats page with mental model, concrete schema
examples per algorithm (SFT with pre-tokenized rows, RL with GSM8K
walkthrough, DPO with both prompt/response and chat message pairs,
agentic), working CLI commands, loader contract, and schema summary
table. State plainly that raw GSM8K is neither RL-ready nor SFT-ready.

Closes inclusionAI#70
@O7c2

O7c2 commented Aug 11, 2026

Copy link
Copy Markdown
Contributor Author

#70

1 similar comment
@O7c2

O7c2 commented Aug 11, 2026

Copy link
Copy Markdown
Contributor Author

#70

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.

1 participant