Skip to main content

World Model Research Made Simple

Project description

PyPI

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

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

@article{swm_maes2026,
  title={stable-world model},
  author={},
  booktitle={stable-worldmodel: World Model Research Made Simple},
  year={2026},
}

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.3.tar.gz (115.3 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.0.3-py3-none-any.whl (160.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: stable_worldmodel-0.0.3.tar.gz
  • Upload date:
  • Size: 115.3 kB
  • 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.3.tar.gz
Algorithm Hash digest
SHA256 aba0f33a1f3ed765831e895fc417ca8a447db6fb20073312039332b739c72051
MD5 acf6fe7145d0a9895194761970cf539c
BLAKE2b-256 4c6d9c58f5f7290bb4294b62b57553d50d2ceec615e8de9592f9f7d04bcef7f7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stable_worldmodel-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 837e04abd003eb6568cb33eef7e9d40fb8f30f092e40400df76a3a44334bf6a7
MD5 e9f19704f36b22cc7efa1d5e20b3e8b0
BLAKE2b-256 1a5ed609fc1a82a5db29534f37f0137f6124367c42505f53868c9c4d59fe2040

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