Skip to main content

OpenWAM

An extensible framework for video-action world models in robot learning

CI Documentation Python 3.11 or 3.12 License: AGPL v3

Documentation · Quickstart · Methods · Training and evaluation · Extension SDK · Citation

Developed by the OpenWAM Team at the Stanford Vision and Learning Lab (SVL).

Stanford University     Stanford Artificial Intelligence Laboratory     Stanford Vision and Learning Lab     Stanford Robotics Center

OpenWAM separates model topology, video/action conditioning, sequence semantics, visual execution, and action decoding so that controlled experiments share the same trainer and visual stack.

Version 0.2.0: OpenWAM remains alpha-stage Linux research software; see the 0.2 migration guide before upgrading. The public CPU lifecycle and synthetic artifacts are self-contained. Large benchmark runs use separately provisioned datasets and checkpoints described by the artifact contract.

OpenWAM robot manipulation teaser

Upcoming Research Release

Detailed evaluation results, trained model checkpoints, datasets, and the OpenWAM research paper are being prepared for public release and will be available very soon. Canonical links and integrity metadata will be added to the artifact documentation as each resource is published.

Research Scope

For OpenWAM video pretraining, see the pretraining datasets and workflow. The guide covers the nine pretraining data sources, downloads, RGB multi-view composition before VAE encoding, task text, verified object storage with a bounded cache, training, checkpoints, and inference. These inputs are the pretraining corpus; downstream robot policy fine-tuning and evaluation have their own dataset configurations. Published model weights are available at OpenWAM-Stanford/OpenWAM-Pretraining on Hugging Face.

OpenWAM provides:

  • one typed train, resume, evaluation, and simulator runtime across policy architectures;
  • six standard video/action programs plus generalist joint denoising (GJD);
  • full-state checkpoint continuation and versioned run provenance;
  • adapters for LIBERO, RoboTwin, CALVIN, heterogeneous LeRobot data, and synthetic fixtures;
  • role-scoped extension APIs for datasets, policies, decoders, attention profiles, and simulators; and
  • CPU semantic tests plus opt-in real-checkpoint GPU parity gates for changes near model numerics.

Maintained Methods

Architecture Topology Maintained programs
parallel_stream Video and action tokens share one transformer. Six standard programs, GJD, and standalone conditional FDM/IDM through the exact LingBot-compatible runtime.
dual_expert Video and action use separate transformer experts. Six standard programs, GJD, and standalone conditional FDM/IDM.
causal_video_prediction The visual model runs without action supervision. Video-only prediction.

The six standard program selectors are video_then_action, action_then_video, joint, decoupled_same_step, video_noisy_to_action, and action_noisy_to_video. GJD samples joint, forward-dynamics (FDM), and inverse-dynamics (IDM) submodes within one model. Standalone forward_dynamics and inverse_dynamics preserve the strict GJD conditional contract: one clean t0 latent in a singleton chunk, one-frame conditional history, no task text, and only the matching prediction loss.

Experiment configs and public commands use architecture and program names directly.

Installation

OpenWAM is available on PyPI for Linux with Python 3.11 or 3.12. In a virtual environment:

python -m pip install openwam

The base package provides configuration and metadata APIs. For model training and evaluation, install the runtime extras:

python -m pip install 'openwam[train,eval]'

Use openwam[train,pretrain] for video data preparation and pretraining, or openwam[sim] for model-driven simulator rollouts. Python imports use open_wam. The optional openwam-sdk installation alias provides the same implementation and extras.

The quickstart covers installed-package usage. For development or exact dependency reproduction, use the frozen source checkout below. Model weights, datasets, and external simulator source trees are provisioned separately.

Quick Start From Source

OpenWAM supports Linux with Python 3.11 or 3.12. Install uv, then run the public CPU contract:

git clone https://github.com/OpenWAM/OpenWAM.git
cd OpenWAM

uv sync --frozen --group dev --extra train --extra eval

uv run openwam-validate-config \
  configs/examples/public_tiny_synthetic_contract.yaml \
  configs/evals/public_tiny_synthetic_contract.yaml

uv run --extra train openwam-sanity \
  --cfg configs/examples/public_tiny_synthetic_contract.yaml \
  --device cpu --max-batches 1 --rollout-steps 1

This path requires no private data, checkpoint, GPU, or external simulator. It checks config loading, dataset construction, a train forward pass, batch inference, and recurrent rollout-style inference. The complete CPU first run adds stateful resume and checkpoint-backed evaluation.

Install only the runtime needed for later work:

Task Command
Config and metadata development uv sync --group dev
Training uv sync --extra train
Offline evaluation uv sync --extra eval
Model-driven simulator rollout uv sync --extra sim
Documentation uv sync --extra docs

Benchmark extras supply dependency overlays, not upstream source trees. Follow Benchmarks and Data before a real simulator run.

Training

Real datasets, checkpoints, simulator checkouts, and output directories remain outside versioned experiment YAML. Start with the local path registry:

cp configs/local_paths.sample.yaml configs/local_paths.yaml
uv run openwam-inspect-config \
  --cfg configs/experiments/dual_expert_libero_joint.yaml

Populate only the aliases used by the selected config. The local registry is gitignored; set OPEN_WAM_LOCAL_PATHS=/absolute/path/paths.yaml to keep it elsewhere.

All architectures use openwam-train. The shipped Parallel Stream and Dual Expert LIBERO policy programs use the same validated full-trajectory W64 recipe described in Training and Inference. The reference 30-layer configs are FSDP workloads characterized with four 48 GB GPUs:

uv run --extra train torchrun --standalone --nproc-per-node=4 \
  -m open_wam.cli.train \
  --cfg configs/experiments/dual_expert_libero_joint.yaml \
  --save-root runs/dual-expert-joint \
  --expected-world-size 4

For a one-off method ablation, change the public program selector rather than the trainer:

uv run --extra train torchrun --standalone --nproc-per-node=4 \
  -m open_wam.cli.train \
  --cfg configs/experiments/dual_expert_libero_joint.yaml \
  --set policy_variant.program=video_then_action \
  --save-root runs/dual-expert-vta \
  --expected-world-size 4

Resume from a full training-state checkpoint with the same command and --resume-from:

uv run --extra train torchrun --standalone --nproc-per-node=4 \
  -m open_wam.cli.train \
  --cfg configs/experiments/dual_expert_libero_joint.yaml \
  --save-root runs/dual-expert-joint \
  --resume-from runs/dual-expert-joint/checkpoints/checkpoint_step_N \
  --expected-world-size 4

--resume-from requires full_training_state.pt and restores model, optimizer, scheduler, strategy/scaler, step state, and the next sampler epoch/batch cursor. Resumable checkpoints are written only at optimizer boundaries because partial gradients are not serialized. Exact loader-cursor continuation also requires a sized training dataloader. Process and stochastic dataset/worker RNG streams are not checkpointed, so a restarted run is not bitwise identical. Use --initialize-weights-from for a fresh run initialized from model weights. The removed ambiguous --checkpoint-root operation always errors. Every checkpoint stores its resolved config as an audit record; it is not merged into the invocation config.

Conditional FDM/IDM uses the dynamics-routing data adapter. The maintained config mixes real demonstrations with encoded counterfactual train and validation roots; a real-demo-only ablation is also supported. Read the data prerequisites before selecting forward_dynamics or inverse_dynamics.

Evaluation And Rollout

Run offline metrics through the generic evaluator:

uv run --extra eval openwam-eval \
  --cfg configs/evals/dual_expert_robotwin_smoke_eval.yaml \
  --checkpoint /path/to/model_state.pt \
  --device cuda:0

Run a configured environment through the simulator boundary:

uv run --extra sim openwam-sim-rollout \
  --cfg configs/experiments/parallel_stream_robotwin_smoke.yaml \
  --checkpoint /path/to/model_state.pt \
  --benchmark robotwin \
  --robotwin-task-name <task-name>

Benchmark adapters translate observations and actions. Sequence, attention, cache, and denoising semantics remain owned by the selected policy. Maintained LIBERO and GJD commands are listed in Training and Inference.

Architecture

Every built-in method follows one composition boundary:

ExperimentConfig -> VariantPipeline -> VisualTower -> PolicyVariant -> ActionDecoder
Contract Responsibility
ExperimentConfig Typed architecture, program, data, sequence, runtime, and optimization choices.
VariantPipeline Shared training and inference orchestration.
VisualTower Frontend encoding, visual backbone execution, decode stages, and runtime hooks.
PolicyVariant Parameter topology, architecture-specific packing, conditioning adapters, and recurrent state.
ActionDecoder Final supervised outputs, masks, losses, metrics, and committed actions.

This boundary keeps the visual stack stable while experiments vary one owned contract at a time. See Architecture and Policy Architectures and Programs.

Use OpenWAM With Your System

Out-of-tree packages load through repeatable --extension module[:hook] arguments. Choose the smallest owning boundary:

Customization Extension surface
Storage format, camera schema, or action/state representation Dataset adapter selected by data.dataset_type
Learned parameters, conditioning, attention profile, or recurrent state PolicyVariant
Final outputs, loss, sampling, or committed action count ActionDecoder
Environment construction and observation/action translation Simulator adapter
Existing method, geometry, schedule, cache, or optimizer choice YAML only

The packaged extension scaffold verifies registration, gradients, inference state, and packaging before custom code is introduced:

uv run --extra train openwam-train \
  --cfg templates/extension_method/config.yaml \
  --extension open_wam.templates.extension_method \
  --save-root runs/extension-method-smoke \
  --disable-wandb

Extensions import compatibility-managed contracts from the role-specific open_wam.sdk modules. See the Extension SDK and cookbooks.

Reproducibility

Evaluation, sanity, and simulator commands can emit the same versioned result envelope with source state, exact argv, config hashes, checkpoint identity, dataset metadata, package versions, and device details. Use full provenance to hash a publication checkpoint:

openwam-eval --cfg evaluation.yaml --output-json result.json \
  --provenance-mode full

Exact numerical claims use the locked dependency graph and documented hardware/software stack. A refactor near model execution must pass immutable training-step, recurrent-inference, cache-rollover, and full-state-resume characterization; expected values are not regenerated by the refactor. See Reproducibility, Compatibility, and Testing.

Repository Layout

configs/       typed experiments, evaluations, examples, and path templates
docs/          public guides, experiment cards, and extension cookbooks
scripts/       thin benchmark adapters and checkout-only research tools
src/open_wam/  installable library and role-scoped SDK
tests/         unit, integration, simulator, and numerical parity gates
notes/index/   generated public consortium metadata packaged at runtime

Documentation

Topic Guide
Install and first run Quickstart
Runtime ownership Architecture
Architectures and programs Policy Architectures
Train, resume, evaluate, and roll out Training and Inference
Dataset and simulator setup Benchmarks and Data
Custom datasets, policies, decoders, and simulators Extension SDK
Checkpoints and manifests Artifacts
Test and parity tiers Testing

Contributing

Contributions should preserve the typed runtime boundary and add focused tests for every changed contract. Read CONTRIBUTING.md, the Code of Conduct, and the Security Policy before opening a pull request.

Citation

If OpenWAM supports your research, cite the software record in CITATION.cff:

@software{open_wam_2026,
  title   = {OpenWAM},
  author  = {{OpenWAM Team}},
  year    = {2026},
  version = {0.2.0},
  url     = {https://github.com/OpenWAM/OpenWAM}
}

License

OpenWAM is released under the GNU Affero General Public License v3.0 with the redistribution attribution described in NOTICE. Covered modified versions and network services must provide corresponding source, and redistributed copies must preserve the OpenWAM attribution notice. Academic work that uses OpenWAM should cite the software record in CITATION.cff.

Third-party components retain their own terms; the adapted LingBot-VA module is distributed under Apache License 2.0. Full attributions are listed in THIRD_PARTY_NOTICES.md and LICENSES/. Stanford, SAIL, SVL, and SRC marks are not licensed under AGPL-3.0-only and remain the property of Stanford University.

Metadata

Release files for openwam 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openwam 0.2.0
File Size Uploaded
openwam-0.2.0.tar.gz 10.2 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for openwam 0.2.0
File Interpreter ABI Platform
openwam-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 11.3 MB

Release files / openwam-0.2.0.tar.gz

Download URL openwam-0.2.0.tar.gz
Size 10.2 MB
Tags Source
SHA-256 checksum
How to use checksums
fd0ea2ea1e201b2c5ef9c1b80e653dcbc5ee7bf3dacc900576ca3909900049c4
BLAKE2b-256 checksum
How to use checksums
52f1e9bba6b63bcbdac898460072d6a80cf4df4468c4e1b3683e8985b711c315
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.

Transparency log

Release files / openwam-0.2.0-py3-none-any.whl

Download URL openwam-0.2.0-py3-none-any.whl
Size 1.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
4c7ab52fb0a6d4af1ca3c5bb498fc094cbfbc56a4fce51f2d7fc4cc971ab6718
BLAKE2b-256 checksum
How to use checksums
171186dbbc64d89c5e14fc16e2997b2e84fc0bc072f4ab2d98bf6d2dfc3b85c0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page