[docs] Fix stale TrainingEngine, RL, and checkpoint config paths - #4805
Merged
Merged
Conversation
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.
YeonwooSung
requested review from
fegin,
felipemello1,
pzhan9,
tianyu-l,
wconstab and
wwwjn
as code owners
September 20, 2026 09:06
|
|
|
The following ciflow label(s) have been added but CI has not been triggered yet because the workflows are awaiting approval:
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
approved these changes
Sep 21, 2026
This was referenced Sep 22, 2026
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`
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.
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.pynow lives underrl/model/.torchtitan/rl/README.md:TrainingEnginelives intorchtitan.training_engine, nottorchtitan.trainer.docs/checkpoint.md: shared checkpoint fields are onBaseCheckpointManager.Configincheckpointer/base.py.dcp.pyonly addsasync_mode.torchtitan/models/qwen3/state_dict_adapter.py: llama3's adapter ismodels/llama3/state_dict_adapter.py(nomodel/subdirectory).Docs only. No behavior change.
Test plan