Skip to main content

World Model Research Made Simple

Project description

Documentation Tests PyPI PyTorch Ruff

stable-worldmodel

World model research made simple. From data collection to training and evaluation.

pip install stable-worldmodel

Note: The library is still in active development.

See the full documentation at here.

Quick Example

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

# collect a dataset
world = swm.World('swm/PushT-v1', num_envs=8)
world.set_policy(your_expert_policy)
world.record_dataset(dataset_name='pusht_demo', episodes=100)

# load dataset and train your world model
dataset = HDF5Dataset(name='pusht_demo', num_steps=16)
world_model = ...  # your world-model

# 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}%")

Supported Environments

Environments Grid 1
Environments Grid 2

Contributing

Setup your codebase:

uv venv --python=3.10
source .venv/bin/activate
uv sync --all-extras --group dev

Questions

If you have a question, please file an issue.

Citation

@misc{maes_lelidec2026swm-1,
      title={stable-worldmodel-v1: Reproducible World Modeling Research and Evaluation}, 
      author = {Lucas Maes and Quentin Le Lidec and Dan Haramati and
                Nassim Massaudi and Damien Scieur and Yann LeCun and
                Randall Balestriero},
      year={2026},
      eprint={2602.08968},
      archivePrefix={arXiv},
      primaryClass={cs.AI},
      url={https://arxiv.org/abs/2602.08968}, 
}

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.0.4.tar.gz (30.2 MB 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.0.4-py3-none-any.whl (50.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: stable_worldmodel-0.0.4.tar.gz
  • Upload date:
  • Size: 30.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for stable_worldmodel-0.0.4.tar.gz
Algorithm Hash digest
SHA256 28790b68cc3cfc50a13a03b2417eb95e65a9dd42d5bf9c6ef24cb8867812d41f
MD5 530603a09a9bb1813696c1725e445ced
BLAKE2b-256 276cfe36ed99269609d0caaca289e35f9a6877865779bcae9c6f3f1460dafc45

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stable_worldmodel-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 22aca0064bc74d349ddc3055b57442c1bc280465dd1f90ee2e34cbf7ac5e4e87
MD5 0addaa9d9ae97a2d4062a892c8920960
BLAKE2b-256 7ce242c6bd5f61cd0d8a0850f78cfbfe7c1ae214259a4ea2e81e1e386b89fcd7

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