Skip to content

docs(training): align cookbook docs and skill references with main#422

Merged
Hecate0821 merged 5 commits into
mainfrom
chengxi/training-docs-only
May 5, 2026
Merged

docs(training): align cookbook docs and skill references with main#422
Hecate0821 merged 5 commits into
mainfrom
chengxi/training-docs-only

Conversation

@Hecate0821

@Hecate0821 Hecate0821 commented May 4, 2026

Copy link
Copy Markdown
Collaborator

Summary

Doc-only PR fixing training docs / dev skill references that drifted from the current tree, plus the SDK pin bump.

  • training/pyproject.toml — bump fireworks-ai[training] to the latest available prerelease, >=1.2.0a66,<2.
  • skills/dev/references/recipes.md — IGPO row label corrected: "Importance-weighted GRPO" -> "Information Gain-based Policy Optimization (IGPO)"; async RL row documents the existing async recipe.
  • skills/dev/references/examples.md — fix wrong example paths (sft_getting_started/, deepmath_rl, top-level frozen_lake/ don't exist on main); add current async/manual example paths; relabel multi-hop as IGPO.
  • training/README.md — add Async RL and IGPO recipe rows; fix the Directory layout block (snippets/ -> tools/; list current example subdirs).
  • skills/dev/references/checkpoints.md — include async_rl_loop in the warm-start support list.
  • skills/dev/SKILL.md, skills/dev/references/shapes.md, skills/dev/references/recipes.md — align shape guidance with auto-selection and refresh the SDK pin example to fireworks-ai[training]>=1.2.0a66,<2.
  • training/examples/tools/README.md — relabel snippets as tools and document the current utility scripts / control-plane checkpoint source.

No recipe, async loop, IGPO implementation, or multi-hop example code changes remain in this PR.

Test plan

  • python -m pip index versions fireworks-ai --pre confirms latest prerelease is 1.2.0a66
  • git diff --check origin/main...HEAD
  • Referenced examples / recipes exist in the working tree
  • Added-line secret scan found no credential values; only the literal env var name FIREWORKS_API_KEY appears in docs

Hecate0821 and others added 5 commits May 4, 2026 22:51
- recipes.md: rename IGPO row from "Importance-weighted GRPO" to
  "Information Gain-based Policy Optimization (IGPO)" -- matches the
  recipe's actual algorithm (Wang et al., ICLR 2026).
- examples.md: fix wrong paths (sft_getting_started, deepmath_rl,
  frozen_lake), add single_turn_token_in / multi_turn_message_in /
  manual entries, drop the misleading "Generic RL wiring -> examples/rl/"
  parent-dir row, relabel Multi-hop QA RL -> Multi-hop QA IGPO.
- README.md: add Async RL and IGPO recipe rows; fix the Directory layout
  block (snippets -> tools, list every existing example subdir).
- checkpoints.md: include async_rl_loop in the warm_start support list
  (the recipe already wires validate_warm_start_config).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The multi-hop QA example previously bundled its own training loop in
`train_multihop_qa_igpo.py` (~1k lines) with a custom client/sampler
wiring around `igpo_loop`'s lower-level helpers.  Replace it with a
thin `train.py` that targets `recipes/async_rl_loop.main()` and a
`rollout.py` factory that emits `RolloutSample` per call.  The
multi-turn search/submit_answer tool loop and per-turn IG scoring
are preserved by reusing `MultiHopQARolloutProcessor` (the rollout
factory wraps a single-row eval-protocol invocation and threads
`scorer.on_turn_complete` through `turn_callback`).  Per-turn IG
rewards are folded into the trajectory's scalar reward as
`outcome + ig_weight * sum(ig_per_turn)` so the async loop's GRPO
advantage z-normalises across the prompt group.

Trade-off vs. the legacy recipe: per-token credit assignment is
collapsed to a per-trajectory scalar (the IG signal still propagates
via group z-score, just without per-token weighting).  This is what
the `RolloutSample` flat contract supports; per-turn formulations
should fork `rollout.py`.

Updates `run.sh`, the example README, the cookbook README directory
listing, and the skill index entry.  Adds a `.gitignore` for the
materialised dataset.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@Hecate0821
Hecate0821 merged commit ec7cb4b into main May 5, 2026
1 check passed
@Hecate0821
Hecate0821 deleted the chengxi/training-docs-only branch May 5, 2026 17:24
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.

2 participants