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.2.tar.gz (111.6 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.2-py3-none-any.whl (154.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: stable_worldmodel-0.0.2.tar.gz
  • Upload date:
  • Size: 111.6 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.2.tar.gz
Algorithm Hash digest
SHA256 8ac6daf2b01430ec2a1ca5c6ee94388e54fb767c005ffbb26d19ec534b9d6d76
MD5 aac30d0097baed4e05a631d03795f4b5
BLAKE2b-256 f50a5c958cd539f504b6591cc1f211ed9fb81070ea7f4be212d65dbba16a38b5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stable_worldmodel-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9ea40e902134af6f4aa8ecd7c23ea08ab304e1b7bb305b15a2ad8a6fcb701aab
MD5 e9d33b981a414db19c9e2127c46c935a
BLAKE2b-256 261b8079c048884c06830708208e0ea572736f12055f1831d47913e9ce0648c2

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