Skip to main content

World Model Research Made Simple

Project description

stable-worldmodel

A platform for reproducible world model research and evaluation.

Documentation Tests PyPI ArXiv PyTorch Ruff Open In Colab

Installation · Quick Start · Environments · Solvers & Baselines · Documentation · Paper · Citation


stable-worldmodel provides a single, unified interface for the three stages of world model research — collecting data, training, and evaluating with model-predictive control — across a large suite of standardized environments. It ships with reference implementations of common baselines and planning solvers so research code can stay focused on the contribution that matters: the model and the objective.

Installation

From PyPI:

pip install stable-worldmodel            # base only
pip install 'stable-worldmodel[all]'     # + training, environments, and data formats

LeRobot dataset support is a separate opt-in extra (requires Python 3.12+): pip install 'stable-worldmodel[lerobot]'.

From source (development):

git clone https://github.com/galilai-group/stable-worldmodel
cd stable-worldmodel
uv venv --python=3.10 && source .venv/bin/activate
uv sync --extra all --group dev

Datasets and checkpoints are stored under $STABLEWM_HOME (defaults to ~/.stable_worldmodel/). Override the variable to point at your preferred storage location.

The library is in active development. APIs may change between minor versions.

Quick Start

import stable_worldmodel as swm
from stable_worldmodel.policy import WorldModelPolicy, PlanConfig
from stable_worldmodel.solver import CEMSolver

# 1. Collect a dataset
world = swm.World("swm/PushT-v1", num_envs=8)
world.set_policy(your_expert_policy)
world.collect("data/pusht_demo.lance", episodes=100, seed=0)

# 2. Load it and train your world model (format is autodetected)
dataset = swm.data.load_dataset("data/pusht_demo.lance", num_steps=16)
world_model = ...  # your model

# 3. Evaluate with model-predictive control
solver = CEMSolver(model=world_model, num_samples=300)
policy = WorldModelPolicy(solver=solver, config=PlanConfig(horizon=10))

world.set_policy(policy)
results = world.evaluate(episodes=50)
print(f"Success Rate: {results['success_rate']:.1f}%")

Reference implementations are provided in scripts/train/: lewm.py implements LeWM, and prejepa.py reproduces DINO-WM. To train directly from HuggingFace object storage with no local dataset download, see the Open In Colab notebook.

GPU utilization comparison
GPU utilization for LeWM trained with Push-T LanceDB dataset on a H200 GPU.

Data Formats

Recording, loading, and conversion all go through a small format registry. Pick the backend that matches your trade-off, or register your own.

Format On-disk layout Best for
lance LanceDB table (episode-contiguous flat rows) default — append-friendly, fast indexed reads
hdf5 single .h5 file (one dataset per column) portable single-file artifact
folder .npz columns + one JPEG per step inspection, partial-key streaming
video .npz columns + one MP4 per episode (decord) long episodes, compact image storage
lerobot lerobot://<repo_id> (read-only adapter) training/eval directly on LeRobot Hub datasets
world.collect("data/pusht.lance", episodes=100)                  # default: lance
world.collect("data/pusht_video", episodes=100, format="video")  # mp4 episodes

ds = swm.data.load_dataset("data/pusht.lance", num_steps=16)     # autodetect
swm.data.convert("data/pusht.lance", "data/pusht_video",
                 dest_format="video", fps=30)                    # one-shot migration

Every writer accepts a mode kwarg ('append' (default), 'overwrite', 'error'); re-running world.collect extends the existing dataset rather than failing.

Throughput & storage benchmarks

Numbers below were produced by scripts/benchmark/compare_h5_lance.py and can be reproduced with it. Benchmarks use the PushT dataset from the LeWorldModel paper.

Throughput

Format Source Cache samples/s ms/step
HDF5 local no-cache 1416.1 45.2
HDF5 local cached 1474.0 43.4
LanceDB local no-cache 4814.8 13.3
LanceDB local cached 4431.3 14.4
Video local - 1330.6 48.1
LanceDB s3 no-cache 3183.7 20.1
LanceDB s3 cached 3253.2 19.7
HDF5 s3 no-cache 9.1 7032.5
HDF5 s3 cached 756.5 84.6

Storage size per format (local)

Format Local size
HDF5 43.12 GB
LanceDB 13.31 GB
Video 496.29 MB

Environments























Top row: default appearance  ·  Bottom row: visual factor of variation

Environments are pulled from the DeepMind Control Suite, Gymnasium classic control, OGBench, Craftax, the Arcade Learning Environment (100+ Atari games), and classical world model benchmarks (Two-Room, PushT). Most environments ship with a set of factors of variation — independently controllable visual and physical parameters (lighting, textures, dynamics, morphology) — that make it straightforward to evaluate zero-shot generalization to distribution shifts without any additional setup. Adding a new environment only requires conforming to the Gymnasium interface.

Full environment list
Environment ID # FoV
swm/PushT-v1 16
swm/TwoRoom-v1 17
swm/OGBCube-v0 11
swm/OGBScene-v0 12
swm/HumanoidDMControl-v0 7
swm/CheetahDMControl-v0 7
swm/HopperDMControl-v0 7
swm/ReacherDMControl-v0 8
swm/WalkerDMControl-v0 8
swm/AcrobotDMControl-v0 8
swm/PendulumDMControl-v0 6
swm/CartpoleDMControl-v0 6
swm/BallInCupDMControl-v0 9
swm/FingerDMControl-v0 10
swm/ManipulatorDMControl-v0 8
swm/QuadrupedDMControl-v0 7
swm/CartPoleControl-v1 10
swm/MountainCarControl-v0 5
swm/MountainCarContinuousControl-v0 4
swm/AcrobotControl-v1 11
swm/PendulumControl-v1 9
swm/FetchReach-v3 8
swm/FetchPush-v3 11
swm/FetchSlide-v3 11
swm/FetchPickAndPlace-v3 11
swm/CraftaxClassicPixels-v1
swm/CraftaxClassicSymbolic-v1
swm/CraftaxPixels-v1
swm/CraftaxSymbolic-v1
ALE/* (100+ Atari games)

Solvers and Baselines

Solver Type
Cross-Entropy Method (CEM) Sampling
Improved CEM (iCEM) Sampling
Model Predictive Path Integral (MPPI) Sampling
Predictive Sampling Sampling
Gradient Descent (SGD, Adam) Gradient
Projected Gradient Descent (PGD) Gradient
Augmented Lagrangian Constrained Opt
Baseline Type
DINO-WM JEPA
PLDM JEPA
LeWM JEPA
GCBC Behaviour Cloning
GCIVL RL
GCIQL RL

Command-Line Interface

After installation, the swm command is available for inspecting/converting datasets, environments, and checkpoints without writing code:

swm datasets                                        # list cached datasets
swm inspect pusht_expert_train                      # inspect a specific dataset
swm envs                                            # list all registered environments
swm fovs PushT-v1                                   # show factors of variation for an environment
swm checkpoints                                     # list available model checkpoints
swm convert pusht_expert_train --dest-format video  # convert a dataset to another format

Documentation

The full documentation lives at galilai-group.github.io/stable-worldmodel, with API references, tutorials, and guides.

Built on stable-worldmodel

Citation

@misc{maes_lld2026swm,
  title  = {stable-worldmodel: A Platform for Reproducible World Modeling Research and Evaluation},
  author = {Lucas Maes and Quentin Le Lidec and Luiz Facury and Nassim Massaudi and
            Ayush Chaurasia and Francesco Capuano and Richard Gao and Taj Gillin and
            Dan Haramati and Damien Scieur and Yann LeCun and Randall Balestriero},
  year   = {2026},
  eprint = {2605.21800},
  archivePrefix = {arXiv},
  primaryClass = {cs.LG},
  url    = {https://arxiv.org/abs/2605.21800},
}

Questions

Open an issue — happy to help.

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

stable_worldmodel-0.1.1.tar.gz (215.7 kB view details)

Uploaded Source

Built Distribution

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

stable_worldmodel-0.1.1-py3-none-any.whl (305.8 kB view details)

Uploaded Python 3

File details

Details for the file stable_worldmodel-0.1.1.tar.gz.

File metadata

  • Download URL: stable_worldmodel-0.1.1.tar.gz
  • Upload date:
  • Size: 215.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.11

File hashes

Hashes for stable_worldmodel-0.1.1.tar.gz
Algorithm Hash digest
SHA256 81a6576cd7e3537dabfa322005cddc064d5aa062c893dc0675eb13672f7df065
MD5 7a020a2a9cc091bd64faefaefa2596e5
BLAKE2b-256 f0d1f9d68807d871b74fb5f300ca9beb398304c296f609aa0be8b2d57394624f

See more details on using hashes here.

File details

Details for the file stable_worldmodel-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for stable_worldmodel-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 00eaabd9e046e6364b3d1db47e5b365a0f628aea3a9376d6a407f75cbbbd2ef5
MD5 0fa3be18fe21fd4975acc40792c36150
BLAKE2b-256 8577933c8d5f3b2e0f31966aa02eacef39bc90b548aa2e816f81e7a394624c83

See more details on using hashes here.

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