Skip to main content

Run, record, and evaluate robot policies in the Genesis simulator through the standard LeRobot interfaces.

Project description

lerobot-genesis

CI PyPI Python License: MIT

The bridge between the Genesis physics simulator and Hugging Face LeRobot.

Genesis is a fast, open robotics simulator; LeRobot is the open standard for robot datasets and policies. There is no official link between them — this package is that link, the same role NVIDIA's IsaacLab-Arena plays for Isaac Lab. It lets you expose any Genesis scene as a Gymnasium environment, record rollouts as a LeRobotDataset, and (from v0.2) evaluate a trained LeRobot policy in Genesis through the standard lerobot-eval workflow.

   Genesis scene ──▶ GenesisEnv (gym.Env) ──▶ LeRobotDataset ──▶ train a LeRobot policy
                          ▲                                              │
                          └────────────────── lerobot-eval ◀────────────┘   (v0.2)

Install

pip install "lerobot-genesis[all]"   # bridge + genesis-world + lerobot

genesis-world needs a CUDA GPU and a few system libraries — see the Genesis install guide. The bridge itself is pure Python; pip install lerobot-genesis (no extras) imports without either heavy dependency present.

Quickstart — record a dataset

Drive a robot in a Genesis scene and save the rollout in LeRobot's format:

from lerobot_genesis import GenesisEnv, GenesisRobotDriver, LeRobotDatasetSink, record_episodes

driver = GenesisRobotDriver(robot="path/to/robot.urdf")          # any URDF / MJCF / USD
env = GenesisEnv(driver, task="reach the target")
sink = LeRobotDatasetSink(
    "me/my-genesis-dataset",
    fps=30,
    state_dim=driver.state_dim,
    action_dim=driver.action_dim,
    image_shape=driver.image_shape,
    task="reach the target",
)

record_episodes(env, policy=lambda obs: env.action_space.sample(), sink=sink, n_episodes=10)

A runnable end-to-end example (a Franka arm, no asset download) lives in examples/record_franka.py.

Quickstart — evaluate a policy in Genesis

lerobot-genesis-eval is lerobot-eval with the Genesis env registered, so a LeRobot policy (ACT, SmolVLA, GR00T, …) can be rolled out in a Genesis scene. Smoke-test the wiring with a from-scratch policy (no checkpoint needed):

lerobot-genesis-eval --env.type=genesis --policy.type=act \
    --eval.batch_size=1 --eval.n_episodes=1 --eval.use_async_envs=false --policy.device=cpu

Point --policy.path at a trained checkpoint to score it, and --env.task at your own registered Genesis task. Training GR00T? lerobot_genesis.groot.write_modality_json emits the meta/modality.json it needs.

How it's designed

The simulator-specific work sits behind one small Protocol, so the Gymnasium contract and the recorder are testable on a CPU with no GPU and no upstream installed.

  • GenesisEnv — a gymnasium.Env over a Genesis scene. It owns the gym contract (the 5-tuple step, info["is_success"], the pixels/agent_pos observation, a continuous action Box) and delegates the physics to an injected SceneDriver.
  • GenesisRobotDriver — the reference SceneDriver: loads a robot, maps a normalised action onto a chosen subset of joints, steps physics, and reads a camera and joint state. Bring your own driver for richer scenes (objects, tasks, rewards).
  • record_episodes / LeRobotDatasetSink — roll a policy and write a LeRobotDataset (the verified v3 create → add_frame → save_episode → finalize loop).
  • GenesisEnvConfig — registers Genesis with LeRobot as --env.type=genesis.

Relationship to gym-genesis

Hugging Face's gym-genesis provides raw Gymnasium task scenes for Genesis. This package is complementary: it adds the LeRobot integration layer — dataset recording, env registration, and policy evaluation — and can wrap a gym-genesis env just as well as your own.

Roadmap

  • v0.1GenesisEnv, reference driver, LeRobotDataset recorder, --env.type=genesis.
  • v0.2 — EnvHub make_env + lerobot-eval policy evaluation; GR00T modality.json adapter; native vectorised (multi-env) rollouts.

License

MIT. An independent, community project — not affiliated with the Genesis or LeRobot teams.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lerobot_genesis-0.3.0.tar.gz (19.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lerobot_genesis-0.3.0-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file lerobot_genesis-0.3.0.tar.gz.

File metadata

  • Download URL: lerobot_genesis-0.3.0.tar.gz
  • Upload date:
  • Size: 19.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for lerobot_genesis-0.3.0.tar.gz
Algorithm Hash digest
SHA256 4bbb6a81d0eb8a43f0daf5c00fe9863c4a14dab97028c43cbb8f8989c9e956c7
MD5 3c18073fc8b249d9e67d375a7036e8f7
BLAKE2b-256 db47fa1f56dc1e32424c7e73f0529fec728bc6af03d8262be7f74f40d49ecbe3

See more details on using hashes here.

Provenance

The following attestation bundles were made for lerobot_genesis-0.3.0.tar.gz:

Publisher: publish.yml on arun-prasath2005/lerobot-genesis

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lerobot_genesis-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: lerobot_genesis-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for lerobot_genesis-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1c8737ccef9b13e61465d8afe2278240d727493d3601c1947201da3ae274304c
MD5 5a03837d6e9fcd79d07f5772d8c8ff21
BLAKE2b-256 acd36b4235fac78125fb7c4f6057129cedd33f7f07038e8144fa91d6526551a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for lerobot_genesis-0.3.0-py3-none-any.whl:

Publisher: publish.yml on arun-prasath2005/lerobot-genesis

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page