Skip to content

[docs] Fix stale TrainingEngine, RL, and checkpoint config paths - #4805

Merged
tianyu-l merged 4 commits into
pytorch:mainfrom
YeonwooSung:pr/docs-4773-stale-paths
Sep 21, 2026
Merged

tianyu-l merged 4 commits into
pytorch:mainfrom
YeonwooSung:pr/docs-4773-stale-paths

Conversation

@YeonwooSung

Copy link
Copy Markdown
Contributor

Summary

Fix four stale paths left after the RL promotion and TrainingEngine split (#4773), plus one leftover llama3 adapter path.

  • torchtitan/rl/docs/bitwise_parity.md: batch_invariance.py now lives under rl/model/.
  • torchtitan/rl/README.md: TrainingEngine lives in torchtitan.training_engine, not torchtitan.trainer.
  • docs/checkpoint.md: shared checkpoint fields are on BaseCheckpointManager.Config in checkpointer/base.py. dcp.py only adds async_mode.
  • torchtitan/models/qwen3/state_dict_adapter.py: llama3's adapter is models/llama3/state_dict_adapter.py (no model/ subdirectory).

Docs only. No behavior change.

Test plan

  • Confirmed each replacement path exists on this branch
  • Lint / docs checks

The module moved under rl/model/ when RL was promoted out of experiments.
TrainingEngine was extracted from trainer.py in the core/RL split.
Shared load/save fields live on the base config; dcp.py only adds async_mode.
llama3 keeps the adapter at models/llama3/, not under a model/ subdirectory.
@pytorch-bot pytorch-bot Bot added ciflow/fake-pg Run 1-GPU Fake PG integration tests ciflow/rl labels Sep 20, 2026
@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Meta Open Source bot. label Sep 20, 2026
@pytorch-bot

pytorch-bot Bot commented Sep 20, 2026

Copy link
Copy Markdown

Workflows were awaiting approval. CI has now been triggered for the ciflow labels on this PR.

@pytorch-bot

pytorch-bot Bot commented Sep 20, 2026

Copy link
Copy Markdown

The following ciflow label(s) have been added but CI has not been triggered yet because the workflows are awaiting approval:

  • ciflow/rl
  • ciflow/fake-pg

Once a maintainer approves the workflows (scroll to the bottom of the PR page), the corresponding CI jobs will be triggered automatically. Please ping one of the reviewers if you do not have access to approve and run workflows.

@tianyu-l
tianyu-l merged commit 6eaab7b into pytorch:main Sep 21, 2026
16 checks passed
@YeonwooSung
YeonwooSung deleted the pr/docs-4773-stale-paths branch September 22, 2026 01:40
tianyu-l pushed a commit that referenced this pull request Sep 22, 2026
…4829)

## Summary

#4810 deleted `ModelSpec` and per-model `parallelize.py`.
`Trainer.Config.model` (and `Controller.Config.model`) is the
Suppress-annotated field. Four docs still used the old names, so
copy-paste snippets fail with `TypeError: unexpected keyword argument
'model_spec'` or point at a file that no longer exists.

Same class of stale-path cleanup as #4805.

- `torchtitan/config/README.md`: `Trainer.Config(model=...)` and
`Trainer.Config.model` in the CLI-freeze paragraph
- `torchtitan/rl/README.md`: `Controller.Config(model=...)`
- `torchtitan/overrides/README.md`: FQN example
`model.layers.0.feed_forward`
- `torchtitan/models/llama3/README.md`: point at `sharding.py` and
`BaseModel.parallelize()` instead of `parallelize.py`

Docs only. No behavior change.

Fixes #4827.

## Test plan

- [ ] Confirmed each replacement path exists on this branch
(`Trainer.Config.model`, `Controller.Config.model`,
`llama3/sharding.py`, `BaseModel.parallelize`)
- [ ] Grepped the four files for leftover `model_spec=` Config keywords
and `parallelize.py`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ciflow/fake-pg Run 1-GPU Fake PG integration tests ciflow/rl CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants