Skip to main content

lerobot-quality-gates

lerobot-quality-gates checks a LeRobot-style dataset's metadata, episode records, sensor and video references, intervention labels, and dataset-card disclosures before training or publication review.

At a Glance

Job Fail fast on deterministic dataset packaging and documentation gaps.
Built for Robotics dataset teams, training pipeline owners, and release reviewers.
Differentiator Local checks plus lightweight Hugging Face metadata inspection without downloading media.
Produces Markdown, JSON, Hugging Face card snippets, or badge JSON with severity-ranked findings.

Install

python -m pip install "lerobot-quality-gates==0.1.7"

Verified Quickstart

Run from a source checkout:

lerobot-quality-gates check examples/mock_lerobot_v3_good \
  --format json \
  --out /tmp/lerobot-quality-report.json \
  --fail-on high

The bundled good fixture contains two episodes and returns zero findings. The bad fixture is intentionally incomplete and can return exit code 1.

Gate Families

  • required meta/info.json fields and declared feature shapes;
  • meta/episodes.json IDs, tasks, frame counts, timestamps, and data references;
  • timestamp monotonicity and frame-count consistency;
  • declared action/state shape consistency;
  • camera feature to video-file reference coverage;
  • intervention and recovery labels when the dataset claims those modes;
  • README disclosure for mock/tutorial data and limitations.

The v1 checks inspect metadata and file references. They do not decode videos, load training shards, evaluate demonstrations, or establish model readiness.

Lightweight Hugging Face Inspection

lerobot-quality-gates check \
  --hf-repo owner/dataset-name \
  --format hf-card \
  --out /tmp/QA.md

This mode requests only README.md, meta/info.json, and meta/episodes.json from huggingface.co. It does not request videos or full data shards.

GitHub Action

Pin the published Action to its immutable release commit:

- uses: auraoneai/lerobot-quality-gates@3d46690c322914e9a90b1310b86ea7f3bba32747 # v0.1.7
  with:
    path: datasets/review-candidate
    fail-on: high
    format: markdown

See docs/github-action.md for the complete workflow. The Action supports local paths only and writes its report to the job log.

Runtime, Data, and Network Boundary

  • Local mode reads dataset metadata, README text, and referenced file paths. It does not make network requests.
  • Local JSON and Markdown reports include an absolute dataset root plus finding paths. Review them before sharing.
  • --hf-repo performs outbound HTTPS reads to Hugging Face for the three lightweight files listed above.
  • The composite Action may contact the configured Python package index while installing build requirements.

Limitations

  • The checks operate on metadata and file references. They do not decode videos, inspect shard contents, or measure demonstration quality.
  • Passing gates does not establish training readiness, benchmark quality, robot safety, or completeness of a downstream dataset review.

Compatibility

robostudio-engine exposes a direct robostudio quality-gates integration that imports this package or invokes its CLI when installed. The output remains a dataset quality diagnostic, not a robot safety certification, benchmark, or expert-review claim.

Publication Status

Verified on 2026-07-13:

  • PyPI: lerobot-quality-gates==0.1.7
  • GitHub Action release: v0.1.7
  • The Action and PyPI package share release 0.1.7; the Action installs the package source from its checked-out immutable commit.
  • All checked-in datasets are synthetic tutorial fixtures.

Next Action

Run the gate on a review candidate before training, triage every high finding, and paste the generated Hugging Face snippet into the dataset card.

Release files for lerobot-quality-gates 0.1.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lerobot-quality-gates 0.1.7
File Size Uploaded
lerobot_quality_gates-0.1.7.tar.gz 14.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for lerobot-quality-gates 0.1.7
File Interpreter ABI Platform
lerobot_quality_gates-0.1.7-py3-none-any.whl Python 3 none any Details

Total release size: 29.9 kB

Release files / lerobot_quality_gates-0.1.7.tar.gz

Download URL lerobot_quality_gates-0.1.7.tar.gz
Size 14.5 kB
Tags Source
SHA-256 checksum
How to use checksums
30b46440764df9427fc8bed8d623e590f33fab52620eaee9fea3fdd0869afd9a
BLAKE2b-256 checksum
How to use checksums
8e2f23225ee2b1db1768508050e4e1bc2b7c990f9bd20825f4842151cc9f74ce
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.9

Release files / lerobot_quality_gates-0.1.7-py3-none-any.whl

Download URL lerobot_quality_gates-0.1.7-py3-none-any.whl
Size 15.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b17217fb1c797d91938890ef00161b98e72e65bcf45a4331ca94ee83957c4dd4
BLAKE2b-256 checksum
How to use checksums
7aac1eb157b60d58762a6035c7c157e144d0c2de9872bbb6fa217a7372a428dd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.9

Release history Release notifications | RSS feed

This release

0.1.7 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page