Skip to content

Improve Documentation When Training With --config_path #902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

GrmanRodriguez
Copy link

What this does

Fixes #888

The documentation (examples/4_train_policy_with_script.md) suggests that you can resume training with the following command:

python lerobot/scripts/train.py \
    --config_path=outputs/train/run_resumption/checkpoints/last/pretrained_model/ \
    --resume=true

The code however expects the path to train_config.json specifically.

This PR updates the documentation to reflect this.

How it was tested

  • Running python lerobot/scripts/train.py --config_path=outputs/train/run_resumption/checkpoints/last/pretrained_model/ --resume=true does not work
  • Running python lerobot/scripts/train.py --config_path=outputs/train/run_resumption/checkpoints/last/pretrained_model/train_config.json --resume=true does not work

How to checkout & try? (for the reviewer)

Try the two commands above.

Copy link
Collaborator

@imstevenpmwork imstevenpmwork left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM because I couldn't find where we consider the case when this argument is a directory and not a file. But curious to know what @aliberts thinks

@imstevenpmwork imstevenpmwork added the documentation Improvements or fixes to the project’s docs label Mar 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or fixes to the project’s docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation for resuming training runs
2 participants