chore(docstrings): fixing deprecated root argument description in LeRobotDataset class#3035
Merged
imstevenpmwork merged 4 commits intomainfrom Feb 27, 2026
Merged
chore(docstrings): fixing deprecated root argument description in LeRobotDataset class#3035imstevenpmwork merged 4 commits intomainfrom
root argument description in LeRobotDataset class#3035imstevenpmwork merged 4 commits intomainfrom
Conversation
github-actions
bot
added
the
dataset
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the docstring for the root parameter in the LeRobotDataset class to accurately reflect the behavior change introduced in v2.0. The documentation previously stated that datasets would be stored under root/repo_id, but since v2.0, the root parameter points directly to the dataset folder without appending repo_id.
Changes:
- Updated the
rootparameter documentation inLeRobotDataset.__init__to clarify that it represents the direct path to the dataset folder, not a parent directory
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…RobotDataset class
CarolinePascal
force-pushed
the
fix/dataset-docstrings
branch
from
93535ed to
9320de6
Compare
github-actions
bot
added
configuration
4 tasks
xianglunkai
pushed a commit
to xianglunkai/lerobot
that referenced
this pull request
Feb 28, 2026
…eRobotDataset class (huggingface#3035) * chore(docstrings): fixing deprecated `root` argument docstrings in LeRobotDataset class * chore(draccus): updating draccus CLI help * chore(revert): reverting changes in lerobot_dataset_viz.py --------- Co-authored-by: Steven Palma <imstevenpmwork@ieee.org>
sorelferris
pushed a commit
to sorelferris/lerobot
that referenced
this pull request
Mar 1, 2026
…eRobotDataset class (huggingface#3035) * chore(docstrings): fixing deprecated `root` argument docstrings in LeRobotDataset class * chore(draccus): updating draccus CLI help * chore(revert): reverting changes in lerobot_dataset_viz.py --------- Co-authored-by: Steven Palma <imstevenpmwork@ieee.org>
4 tasks
2 tasks
4 tasks
LePao1
pushed a commit
to LePao1/lerobot
that referenced
this pull request
Mar 7, 2026
…eRobotDataset class (huggingface#3035) * chore(docstrings): fixing deprecated `root` argument docstrings in LeRobotDataset class * chore(draccus): updating draccus CLI help * chore(revert): reverting changes in lerobot_dataset_viz.py --------- Co-authored-by: Steven Palma <imstevenpmwork@ieee.org>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Type / Scope
Summary / Motivation
Updates the description of the
rootparameter inLeRobotDatasetclass. SinceLeRobotDatasetv.2.0,rootdirectly points to the folder in which the dataset is stored. Norepo_idwill be added to the provided path.Related issues
--rootargument set fails if you've recorded a policy before #534, Correctly resolve root path when merging local datasets in dataset-tools #3030, Fix: lerobot-dataset-edit merge with custom root paths locally #2739, fix: updateroot/repo_idpath inlerobot_dataset.py#1057, Deleting episodes bylerobot_edit_datasetfails whenrootis used #2316What changed
LeRobotDatasetdocstrings.How was this tested (or how to run locally)
N/A
Checklist (required before merge)
pre-commit run -a)pytest)Reviewer notes