Open Source RoboticsRobots, software & field notes

robomimic

Based on published sources · Not tested by us ·

Overview

Robot-learning-from-demonstration framework with HDF5 dataset tooling, offline learning algorithms and version-specific simulation datasets. [S001]

robomimic provides algorithms and data tooling for learning from robot demonstrations. The reviewed v0.5.0 framework supports configuration-driven training and a common HDF5 trajectory format. Its value for a comparison depends on preserving the dataset, simulator and preprocessing choices together. An installed training package alone does not reproduce an earlier experiment. [S001] [S002] [S007]

Specifications

DetailDescription
Intended usersResearchers comparing imitation and offline reinforcement-learning methods
Editorial assessment [S001] · Checked 2026-10-01
Required softwarePyTorch and torchvision; HDF5 tooling via h5py; huggingface_hub ==0.23.4; transformers ==4.41.2; diffusers ==0.11.1; Dataset-specific simulation dependencies
Reported by source [S005] [S006] · Checked 2026-10-01
InstallationSelect an isolated Python/PyTorch environment, install the pinned source, and follow the dataset-specific simulator instructions before the debug training example.
Guide recommends Python 3.8.0 and shows PyTorch 2.0.0; no resolved environment tested here.
Editorial assessment [S005] · Checked 2026-10-01
UsesDownload or collect demonstrations; Convert and inspect HDF5 data; Choose train-validation trajectory filters; Train policies with a dataset and configuration; Replay simulated states to generate selected observations
Reported by source [S007] [S008] · Checked 2026-10-01
File formatsNot known
Development statusDocumented setup available
Research classification from documented artifacts/workflow, not our reproduction or production qualification.
Editorial assessment [S001] · Checked 2026-10-01

3D preview

A robot-part preview is not applicable to this software project profile.

Installation and use

Installation and experiment reproduction are separate checks

The pinned installation guide names Linux and macOS, recommends Python 3.8.0 and shows PyTorch 2.0.0 with torchvision 0.15.1. Package metadata has a much broader Python declaration and also pins several learning dependencies, including transformers 4.41.2 and diffusers 0.11.1. These are source-level instructions, not a resolved environment tested here. Use an isolated environment and record the versions that actually install before treating it as reproducible. [S005] [S006]

The guide's small installation check is examples/train_bc_rnn.py --debug. Dataset use can require additional simulators. For the released robosuite demonstration route, the documentation points to robosuite v1.5.1. That is a more specific choice than its general statement of robosuite v1.2-or-newer compatibility. [S005]

The dataset guide explains why the distinction matters: the original CoRL 2021 data used the older offline_study branch and mujoco-py. Newer datasets use robosuite v1.5.1 with the official MuJoCo bindings, and upstream explicitly says learning results may not match the original results exactly. Older reproduction routes are documented through robomimic v0.2.0 or v0.3 for their respective dataset generations. Do not silently substitute one generation when reporting a historical comparison. [S009]

Inspect the data before training

A compatible HDF5 file contains trajectory groups and environment metadata, with actions, observations, rewards and termination signals. Images are stored as unsigned 8-bit arrays in channel-last order. Actions should be normalized between minus one and one; the documented dataset inspection script checks their range. An HDF5 extension alone therefore does not establish compatibility. [S007]

The robosuite conversion route changes a raw demonstration file in place. After that conversion, the data still lacks observations, rewards and termination signals needed for training. The separate state-to-observation step reconstructs selected observations and rewards from the recorded MuJoCo states. Preserve a copy of raw data before an in-place conversion; this is an editorial precaution for keeping the original evidence. [S008]

Generate train-validation splits before extracting observations. Upstream recommends that ordering so every derived HDF5 file inherits the same trajectory filters. Otherwise, comparisons between image and low-dimensional observations can inadvertently use different splits. The framework exposes filter keys for selecting training and validation trajectories explicitly. [S007] [S008]

Observation extraction also chooses camera names, resolution, depth, reward density and termination semantics. Its examples distinguish marking success from marking only the trajectory end. Compression trades smaller storage for decoding work; omitting next observations is appropriate only for algorithms that do not require them. Preserve these choices with the experiment configuration rather than treating every derived dataset as equivalent. [S008]

Keep source and dataset rights separate

The framework's root license is MIT. The separately inspected maintainer-hosted Hugging Face dataset card also labels its collection MIT, but that collection is only part of the broader supported-data ecosystem. The dataset guide says its real-robot releases are not hosted there. Neither license statement establishes the terms of every external dataset supported by the framework. [S003] [S009] [S010]

This review inspected source and documentation and preserved the dataset card revision. It did not download the HDF5 payloads, resolve an installation, replay states, train a policy or measure a reproduction result. [S002] [S010]

Source files and licenses

Available project sources support research coverage; complete build and commercial qualification remain separate.

LayerAvailability / license
softwareavailable · MIT
Framework license; dependencies and externally hosted datasets are separate artifacts. [S003]
datasetsavailable · MIT
Maintainer dataset card reports MIT for this hosted collection. Dataset payloads not downloaded or validated. This does not cover every supported external dataset or real-robot release. [S009] [S010]
documentationavailable · License not fully assessed
Documentation source present; separate documentation-wide terms not established. [S004] [S005]

Framework and demonstration-data profile; no specific pretrained checkpoint selected.

References

Links identify the documentation and revisions used in this profile. Access dates record when each source was retrieved.

  1. S001 · ARISE-Initiative / project contributors
    Upstream project overview
    Accessed 2026-10-01 · README.md
    Source notes

    Source text inspected for the cited scoped claims; see profile claim notes.

  2. S002 · ARISE-Initiative / project contributors
    Repository revision and release metadata
    Accessed 2026-10-01 · ae5799f0fae05c4559ee1f9645b0f77eb5251929
    Source notes

    Source text inspected for the cited scoped claims; see profile claim notes.

  3. S003 · ARISE-Initiative / project contributors
    Repository license
    Accessed 2026-10-01 · LICENSE
    Source notes

    Source text inspected for the cited scoped claims; see profile claim notes.

  4. S004 · ARISE-Initiative / project contributors
    Pinned repository artifact inventory
    Accessed 2026-10-01 · ae5799f0fae05c4559ee1f9645b0f77eb5251929 archive file inventory
    Source notes

    Source text inspected for the cited scoped claims; see profile claim notes.

  5. S005 · ARISE-Initiative / project contributors
    robomimic v0.5.0: docs/introduction/installation.md
    Accessed 2026-10-01 · ae5799f0fae05c4559ee1f9645b0f77eb5251929 / docs/introduction/installation.md
    Source notes

    Source text inspected for the cited scoped claims; see profile claim notes.

  6. S006 · ARISE-Initiative / project contributors
    robomimic v0.5.0: setup.py
    Accessed 2026-10-01 · ae5799f0fae05c4559ee1f9645b0f77eb5251929 / setup.py
    Source notes

    Source text inspected for the cited scoped claims; see profile claim notes.

  7. S007 · ARISE-Initiative / project contributors
    robomimic v0.5.0: docs/datasets/overview.md
    Accessed 2026-10-01 · ae5799f0fae05c4559ee1f9645b0f77eb5251929 / docs/datasets/overview.md
    Source notes

    Source text inspected for the cited scoped claims; see profile claim notes.

  8. S008 · ARISE-Initiative / project contributors
    robomimic v0.5.0: docs/datasets/robosuite.md
    Accessed 2026-10-01 · ae5799f0fae05c4559ee1f9645b0f77eb5251929 / docs/datasets/robosuite.md
    Source notes

    Source text inspected for the cited scoped claims; see profile claim notes.

  9. S009 · ARISE-Initiative / project contributors
    robomimic v0.5.0: docs/datasets/robomimic_v0.1.md
    Accessed 2026-10-01 · ae5799f0fae05c4559ee1f9645b0f77eb5251929 / docs/datasets/robomimic_v0.1.md
    Source notes

    Source text inspected for the cited scoped claims; see profile claim notes.

  10. S010 · ARISE-Initiative / project contributors
    Maintainer-hosted dataset card
    Accessed 2026-10-01 · 74fa018461f479cd9fd15b924a16103012096203 / README.md
    Source notes

    Source text inspected for the cited scoped claims; see profile claim notes.

Research and review details

Source research only; no installation, physical build or performance test performed. No affiliate links added.

Profile edited 2026-10-01 · Sources checked 2026-10-01 · Next review target 2026-10-31

Revision: ae5799f0fae05c4559ee1f9645b0f77eb5251929 (release v0.5.0). Software repository activity recorded 2025-06-27 [S002]

Correction guidance · Discussion is not enabled · Profile format 0.6.0-draft.1

Change history