Improve Documentation When Training With --config_path
#902
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 this does
Fixes #888
The documentation (
examples/4_train_policy_with_script.md
) suggests that you can resume training with the following command:The code however expects the path to
train_config.json
specifically.This PR updates the documentation to reflect this.
How it was tested
python lerobot/scripts/train.py --config_path=outputs/train/run_resumption/checkpoints/last/pretrained_model/ --resume=true
does not workpython lerobot/scripts/train.py --config_path=outputs/train/run_resumption/checkpoints/last/pretrained_model/train_config.json --resume=true
does not workHow to checkout & try? (for the reviewer)
Try the two commands above.