docs: update document in response to Simplify configs PR #1596
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation across policy configuration files to replace outdated parameter names with their current equivalents. Following a previous change where policy configurations inherited from PreTrainedConfig, the parameter names changed from input_shapes/output_shapes to input_features/output_features, but the documentation wasn't updated accordingly.
- Updates docstrings in all policy configuration classes to use correct parameter names
- Ensures documentation consistency across the codebase
- Corrects references in both class-level docstrings and parameter descriptions
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/lerobot/policies/vqbet/configuration_vqbet.py | Updates VQBeTConfig docstring to reference input_features and output_features |
| src/lerobot/policies/tdmpc/configuration_tdmpc.py | Updates TDMPCConfig docstring to reference input_features and output_features |
| src/lerobot/policies/diffusion/configuration_diffusion.py | Updates DiffusionConfig docstring to reference input_features and output_features |
| src/lerobot/policies/act/configuration_act.py | Updates ACTConfig docstring to reference input_features and output_features |
| src/lerobot/configs/policies.py | Updates base PreTrainedConfig docstring to reference input_features and output_features |
CarolinePascal
added
bug
|
Hi @HiroIshida, Good catch with this PR ! I see you've marked it as a draft, let me know when it's completed and ready for merge ;) Best, Caroline. |
HiroIshida
force-pushed
the
update_docs_shapes_to_features
branch
from
9c63290 to
4602efe
Compare
HiroIshida
force-pushed
the
update_docs_shapes_to_features
branch
from
4602efe to
96419f3
Compare
HiroIshida
changed the title
|
@CarolinePascal |
|
@CarolinePascal ping |
3 participants
What this does
This PR simply fixes the documentation.
In PR #550, it seems that all the policy configuration starts to inherit from the base class
PreTrainedConfigwhich hasinput_featuresandoutput_featuresas attributes, andinput_shapesandoutput_shapesare removed from each subclasses instead. However, the docstrings update regarding this is not included in the PR. Also, the content of theinput_featuresandoutput_featuresare nowPolicyFeatureso I tweaked the docstrings.Similary,
input_normalization_modesandoutput_normalization_modesare outdated and nownormalization_mappingdo that role. So I changed the docstrings accordingly.This PR, hence, complements the PR (cc, @aliberts )