Update locomanipulation SDG docs with clarification on converting to lerobot dataset#5648
Merged
kellyguo11 merged 2 commits intoMay 18, 2026
Conversation
There was a problem hiding this comment.
📚 Documentation Review
Thanks for this documentation update, @jaybdub!
Summary
This PR adds helpful clarification about the convert_dataset.py script's input directory requirements for the locomanipulation SDG workflow.
What Changed
- Prerequisites section: Now explicitly warns that the input directory must contain only SDG outputs from
generate_data.py, not HDF5 files from earlier pipeline steps - Conversion section: Updated description emphasizes the "no other HDF5 files" requirement
- Example: Changed from using
./datasetsdirectly to a two-step workflow:- Create a dedicated subdirectory (
./datasets/locomanip_sdg) - Move only the SDG output there before conversion
- Create a dedicated subdirectory (
Review Notes
✅ Clarity: The warning is clear and the example demonstrates the correct workflow
✅ RST formatting: Looks correct (inline code markers, code blocks)
✅ Consistency: Maintains the existing documentation style
✅ User value: This will help users avoid a confusing error when the converter encounters incompatible HDF5 files
Minor observation: The bolded only and no other HDF5 files effectively draw attention to the constraint without being excessive.
🤖 Reviewed by Isaac Lab Review Bot
peterd-NV
approved these changes
May 15, 2026
This was referenced May 18, 2026
Merged
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.
Description
convert_dataset.py's<input_dir>must contain only SDG.hdf5outputs fromgenerate_data.py; mixing in earlier-step datasets (e.g.dataset_annotated_g1_locomanip.hdf5,generated_dataset_g1_locomanip.hdf5) causes the converter to fail.mkdir+mvthe SDG output into./datasets/locomanip_sdg/before running the converter.Type of change
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there