Skip to content

Improve documentation for resuming training runs #888

Description

@leonmkim

lerobot/examples/4_train_policy_with_script.md guides users to point CLI arg config_path to the directory containing the train_config.json file rather than the json file itself which doesnt work.

Put explicitly,

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

is wrong and should be corrected to

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

Furthermore, if the training run to be resumed uses wandb for logging and the user did not initially provide a wandb run id, the user must pass in the corresponding wandb run id as the train_config.json does not save it. The documentation should specify that wandb.run_id should be provided with resumption. Or, more conveniently, the id should be saved somewhere with the checkpoint.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn’t working correctly

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions