Add Console Scripts for Cleaner, More Simple Script Execution #513
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
This PR adds console script entry points in
pyproject.toml
using Poetry's[tool.poetry.scripts]
section. This enables running scripts with simple commands likelr_train
instead ofpython lerobot/scripts/train.py
. All documentation has been updated accordingly, and the original method of running scripts remains functional.Benefits
Users can run scripts with short, legible commands without needing to specify the python command or the script's file path.
Removing hardcoded file paths from documentation and docstrings decouples the documentation from the project's directory structure, facilitating future refactors.
Scripts can now be executed from any directory, not just the repository's root.
Low risk of breakage
How it was tested
How to checkout & try? (for the reviewer)