docs(readme): document the create_trainer training providers#960
Merged
Merged
Conversation
The README covered create_policy providers in depth but had no section for create_trainer, its training-side peer. Add a Training providers section that mirrors the Policy providers layout: the create_trainer/TrainSpec usage, a provider table (lerobot_local, groot, cosmos3, mock, ppo, fast_sac), and a note on the from-scratch RL trainers (BaseRLAlgo lifecycle, VecSimEnv rollouts, evaluate()). Surfaces the RL lane (strands-labs#915, strands-labs#918, strands-labs#920) that only lived in the CHANGELOG.
yinsong1986
approved these changes
Jul 1, 2026
yinsong1986
left a comment
Contributor
There was a problem hiding this comment.
Summary
Docs-only PR (+36/-0 in README.md) adding a Training providers section that mirrors the existing Policy providers layout. It documents create_trainer/TrainSpec for both imitation post-tuning and from-scratch RL, a provider table, and a note on the RL lane (BaseRLAlgo, the validate -> prepare -> train -> export lifecycle, VecSimEnv rollouts, BaseRLAlgo.evaluate(), and the torch-free-until-first-use property).
What's good
- Every claim checks out against source on
main:create_trainer(provider, **kwargs) -> Trainer(training/factory.py:116); the four imitation providers'trainerblocks inregistry/policies.json(mock/groot/lerobot_local/cosmos3);register_trainer("ppo"/"fast_sac", ...)intraining/__init__.py:59,68;TrainSpecfieldsdataset_root/base_model/output_dir/method(full|lora|...)/stepsintraining/base.py;PpoTrainer(BaseRLAlgo)/FastSacTrainer(BaseRLAlgo); theVecSimEnv"N independent SimEnv as one batched env" wording matches its class docstring verbatim;train_policywrapscreate_trainer(tools/train_policy.py:160,181); the groot embodiment-tag and cosmos3 multi-node HSDP notes are accurate. - Scope discipline: pure documentation, no code touched.
- No emojis or non-ASCII in the added section, and no host paths — consistent with AGENTS.md string-hygiene and no-host-path conventions.
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
The README documents
create_policyproviders in depth (a dedicated Policy providers section with a provider table), but there is no equivalent forcreate_trainer, its training-side peer. The RL trainers added in #915 / #918 / #920 (create_trainer("ppo"),create_trainer("fast_sac")) only appear in the CHANGELOG.This adds a Training providers section mirroring the Policy providers layout.
Contents
create_trainer/TrainSpecusage (imitation post-tuning and from-scratch RL), matching the pattern instrands_robots/training/__init__.py.lerobot_local,groot,cosmos3,mock(imitation) andppo,fast_sac(RL).BaseRLAlgo, thevalidate -> prepare -> train -> exportlifecycle,VecSimEnvrollouts, andBaseRLAlgo.evaluate().Verification
Every claim checked against source on
main:register_trainer("ppo", ...)/register_trainer("fast_sac", ...)intraining/__init__.py; imitation trainers intraining/{lerobot,groot,cosmos3,mock}.py.create_trainer(provider, **kwargs) -> Trainerand thevalidate/prepare/train/exportmethods →training/base.pyandtraining/factory.py.TrainSpecfields (dataset_root,base_model,output_dir,method,steps) →training/base.py;methodvaluesfull | lora | ....VecSimEnvdescription → its class docstring and the feat(training): VecSimEnv - N independent SimEnv as one (N, D)-batched env #918 commit title.Docs only, no code changes.