Skip to content

Update locomanipulation SDG docs with clarification on converting to lerobot dataset#5648

Merged
kellyguo11 merged 2 commits into
isaac-sim:developfrom
jaybdub:jwelsh/docs-locomanip-sdg-convert-input-dir
May 18, 2026
Merged

Update locomanipulation SDG docs with clarification on converting to lerobot dataset#5648
kellyguo11 merged 2 commits into
isaac-sim:developfrom
jaybdub:jwelsh/docs-locomanip-sdg-convert-input-dir

Conversation

@jaybdub
Copy link
Copy Markdown
Contributor

@jaybdub jaybdub commented May 15, 2026

Description

  • Documents that convert_dataset.py's <input_dir> must contain only SDG .hdf5 outputs from generate_data.py; mixing in earlier-step datasets (e.g. dataset_annotated_g1_locomanip.hdf5, generated_dataset_g1_locomanip.hdf5) causes the converter to fail.
  • Updates the example to mkdir+mv the SDG output into ./datasets/locomanip_sdg/ before running the converter.

Type of change

  • Documentation update

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have updated the changelog and the corresponding version in the extension's config/extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@jaybdub jaybdub changed the base branch from main to develop May 15, 2026 22:35
@github-actions github-actions Bot added documentation Improvements or additions to documentation asset New asset feature or request isaac-sim Related to Isaac Sim team isaac-mimic Related to Isaac Mimic team infrastructure labels May 15, 2026
Copy link
Copy Markdown

@isaaclab-review-bot isaaclab-review-bot Bot left a comment

Choose a reason for hiding this comment

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

📚 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

  1. 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
  2. Conversion section: Updated description emphasizes the "no other HDF5 files" requirement
  3. Example: Changed from using ./datasets directly to a two-step workflow:
    • Create a dedicated subdirectory (./datasets/locomanip_sdg)
    • Move only the SDG output there before conversion

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

@kellyguo11 kellyguo11 merged commit c348f01 into isaac-sim:develop May 18, 2026
39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

asset New asset feature or request documentation Improvements or additions to documentation infrastructure isaac-mimic Related to Isaac Mimic team isaac-sim Related to Isaac Sim team

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants