WorldFoundry is an open-source infrastructure for world models: a shared stack for in-tree runners, local asset staging, inference (TUI / CLI / Studio), and benchmark evaluation across video generation, 3D/4D representation, embodied action, and interactive worlds.
⚠️ This repository is still under active development. We will keep updating it regularly. Feel free to open an issue if you encounter any problem.
Day-one workflow:
- Environment + assets — bootstrap conda, stage checkpoints and datasets outside git.
- Inference — generate and inspect artifacts via TUI, CLI, scripts, or Studio.
- Evaluation — score only after artifacts match the benchmark layout; use scorecards for readiness claims.
Join the WorldFoundry Community [Slack / Wechat] for discussions, announcements, technical support, and the latest project updates.
WeChat Community
| Group 1 — Full | Group 2 — Open |
|
|
WeChat Group 1 is full. Please scan the Group 2 QR code to join the community.
The QR codes will be updated if they expire.
- [2026-07-17] 🔧 WorldFoundry v0.2.0: Major Infrastructure Overhaul
- Core Inference Upgrades – Refactored to inference‑only path with integrated Wan, HunyuanVideo, LTX2, Cosmos, perception & 3D foundation modules. Unified attention backend selection (FlashAttention 2/3, SageAttention, xFormers, SDPA fallback). Triton kernel registration, compilation & inference caching. NVFP4 quantization support. GPU selection driven by actual compute capability (A100, H100). Multi‑GPU Context/Sequence Parallel with advanced memory management.
- World Model Integration – Incorporated LingBot World 2, Lingbot Video, Helios, Bernini, AlayaWorld, Rolling Forcing, LiveWorld, MinWM, sana streaming, and more.
- Action Policy Integration – Integrated LingBot VLA/VLA2, Xiaomi Robotics, Hy‑Embodied VLA, Spatial Forcing, X‑VLA, X‑WAM, OpenPI, OpenVLA‑OFT, GROOT, Octo, and more.
- Studio Enhancements – Refined model discovery, Conda environment isolation, GPU allocation, torchrun distributed launch, Workspace Jobs, visualization, and result presentation.
- Benchmark Expansion – Added benchmark catalog and runtime profiling, including LaryBench, WorldReasonBench and WRBench.
- [2026-07-12] 🔥 WorldFoundry reached 100+ stars on its very first day! Thanks to the community for the incredible support and encouragement. More exciting updates are coming!
- [2026-07-11] 🎉 WorldFoundry is officially open-sourced. We welcome ⭐ stars, bug reports, feature requests, and pull requests from the community!
- [Coming Soon] Documentation improvements and additional benchmark integrations.
- Documentation
- Project overview
- Design and architecture
- What is included
- Why WorldFoundry
- Quickstart
- Environment reference
- Local asset preparation
- TUI
- Inference guide
- Studio guide
- CLI reference
- Python API reference
- Supported models
- Benchmark hub
- Contributing
These examples are checked into the documentation site so a new user can see the expected artifact shape before running GPU jobs. Full release claims still require the matching run manifest, runtime profile, and validation scorecard.
More curated generated samples are embedded in the Studio docs.
| Surface | Purpose | Entry point |
|---|---|---|
| Model zoo | Catalogs video, world, 3D/4D, VLA/VA/WAM, hosted API, and metadata-only model entries. | worldfoundry/data/models/catalog |
| In-tree runtimes | Keeps model architecture and inference adapters inside worldfoundry; checkpoints stay in local/Hugging Face caches. |
worldfoundry/synthesis, worldfoundry/pipelines |
| TUI | Interactive model/benchmark picker that prints runnable CLI commands. | worldfoundry-eval tui / worldfoundry-tui |
| Studio workspace | Browser UI for inference jobs, model-specific parameters, and artifact review. | worldfoundry.studio.workspace_app |
| Benchmark zoo | Catalogs benchmark manifests, required assets, official runner constraints, and readiness states. | worldfoundry/data/benchmarks/catalog |
| Evaluation runner | Runs model × benchmark cells, imports existing outputs, and writes normalized scorecards. | worldfoundry/evaluation |
| Docs | Bilingual Fumadocs site with setup, inference, evaluation, Studio, and maintainer guides. | docs/fumadocs |
WorldFoundry uses conda as the supported open-source runtime path. Start with the unified GPU environment; only use a dedicated environment when a model profile documents a real ABI or simulator conflict. The full day-one path lives in the Quickstart.
# You can clone the repository with all demo videos
git clone https://github.com/OpenEnvision/WorldFoundry.git
# or clone the repository skipping large LFS media files for a much faster download
GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/OpenEnvision/WorldFoundry.git
cd WorldFoundry
bash scripts/setup/bootstrap_worldfoundry.sh
source tmp/worldfoundry_unified_env.sh
conda activate "${WORLDFOUNDRY_UNIFIED_ENV_PREFIX}"Checkpoints, datasets, evaluator weights, API keys, and generated artifacts are not in git. See Local asset preparation for cache layout, Hugging Face downloads, non-HF aliases, and benchmark assets.
On modern CUDA 12.8 hosts the installer resolves worldfoundry-unified-cu128. Pin a wheel tier only when the host requires it:
bash scripts/setup/bootstrap_worldfoundry.sh --cuda cu124
bash scripts/setup/bootstrap_worldfoundry.sh --cuda cu121Keep datasets and checkpoints outside the repository on shared machines:
bash scripts/setup/bootstrap_worldfoundry.sh \
--home /path/to/worldfoundry-home \
--data-root /path/to/worldfoundry-data \
--model-root /path/to/worldfoundry-models \
--artifact-root /path/to/worldfoundry-artifactsHugging Face models use native Hub loading (from_pretrained, snapshot_download, HF_HOME / HF_HUB_CACHE, and HF_TOKEN for gated assets). WORLDFOUNDRY_CKPT_DIR remains for non-HF checkpoints and compatibility aliases.
Some VLA/action policies need a documented model-specific environment (for example OpenVLA-OFT / CogACT). Embodied simulator benchmarks follow the Docker VLA harness pattern — see the environment reference.
After the environment is active:
worldfoundry-eval --help
worldfoundry-eval zoo models --json
worldfoundry-eval zoo benchmarks --jsonpython -m pip install -e ".[tui]"
worldfoundry-eval tui
# or: worldfoundry-tuiThe TUI reads the same catalogs as the CLI and can print a runnable command before anything expensive runs:
worldfoundry-eval tui \
--model-id <model-id> \
--benchmark-id <benchmark-id> \
--print-commandPrepare assets, then launch a small demo. A common starter is matrix-game-2 (public HF repo Skywork/Matrix-Game-2.0):
bash scripts/inference/prepare_model_infer.sh matrix-game-2 --download
worldfoundry-eval zoo model-download --model-id matrix-game-2 --check-local --json
bash scripts/inference/test_nav_video_gen.sh matrix-game-2 \
--output-dir tmp/matrix_game2_first_runIf weights already live in a shared checkpoint tree, link them instead of copying:
bash scripts/setup/link_hf_checkpoints.sh \
--ckpt-dir "${WORLDFOUNDRY_CKPT_DIR}" \
--hfd-root "${WORLDFOUNDRY_HFD_ROOT}" \
--hf-hub-cache "${HF_HUB_CACHE}" \
--default-worldPrefer the TUI or the documented inference helpers once assets are staged:
bash scripts/inference/test_nav_video_gen.sh matrix-game-2
conda run -p "${WORLDFOUNDRY_UNIFIED_ENV_PREFIX}" \
bash scripts/inference/test_nav_video_gen.sh matrix-game-2
bash scripts/inference/run_infer.sh --category video --model <model-id>
bash scripts/inference/run_infer.sh --category three_d_four_d --model <model-id>CLI-shaped inference (same contract as Studio jobs):
python -m worldfoundry.studio.workspace_job infer \
--model-id <model-id> \
--prompt "a cinematic scene, high quality" \
--output-dir tmp/worldfoundry_infer/<model-id> \
--device cudaEach successful run should write media, logs, and manifest metadata under the output directory. Treat a file as demo evidence only after visual check and matching runtime-profile assumptions. Details: Inference guide.
Studio is the preferred UI for release validation: model-specific forms, job status, preview media, and artifact links in one place. Start it from the same unified env used for inference:
source tmp/worldfoundry_unified_env.sh
conda activate "${WORLDFOUNDRY_UNIFIED_ENV_PREFIX}"
bash scripts/workspace/run_workspace.sh \
--host 127.0.0.1 \
--port 7870 \
--max-jobs 8Open http://127.0.0.1:7870/. If python, LOAD, or START fails with a missing interpreter, cv2, or libssl/libcrypto error, recreate or verify the env and restart:
bash scripts/setup/bootstrap_worldfoundry.sh --verify-only
source tmp/worldfoundry_unified_env.sh
bash scripts/workspace/run_workspace.shConfigure jobs in Create Job; optional shared defaults can use WORLDFOUNDRY_STUDIO_SETTINGS_FILE. Expensive runtime checks and preview builders are opt-in via WORLDFOUNDRY_STUDIO_* — see the Studio guide.
Use the Visualizers tab as the browser entrypoint for local preview services (World / Gradio, Spark, Viser, Rerun, Embodied bridge). On a remote machine, forward port 7870 plus any viewer ports you launch.
For a single-model Studio process:
worldfoundry-studioRun evaluation through a runnable benchmark path. Use official-run when the evaluator can execute locally; use official-validation when you already have official-shaped result files to import.
worldfoundry-eval run \
--model matrix-game-2 \
--benchmark vbench \
--mode official-run \
--output-dir tmp/hello_world_run \
--jsonInspect:
run_manifest.json: selected model, benchmark/task metadata, timestamps, and output paths.results.jsonl: per-sample generation records and artifact metadata.metrics/summary.json: aggregate metrics and failed/skipped sample counts.scorecard.json: readiness, leaderboard eligibility, metric values, and blockers.
For model and benchmark discovery:
worldfoundry-eval tasks list
worldfoundry-eval zoo models --json
worldfoundry-eval zoo benchmarks --json
worldfoundry-eval zoo model-show --model-id <model-id> --include-manifest --json
worldfoundry-eval zoo benchmark-show --benchmark-id <benchmark-id> --include-spec --jsonFor existing official-shaped benchmark outputs:
worldfoundry-eval zoo benchmark-run \
--benchmark-id vbench \
--mode official-validation \
--official-results-path <official_results.json> \
--generated-artifact-dir <generated_videos> \
--output-dir tmp/benchmark_zoo/official_validation/vbench \
--jsonFor existing generated outputs:
worldfoundry-eval evaluate \
--results-path tmp/results.jsonl \
--output-dir tmp/worldfoundry_evaluate \
--metric artifact_count \
--required-artifact video \
--jsonFor the formal benchmark inventory, review the expanded plan first:
worldfoundry-eval prepare \
--all-benchmarks \
--output-dir tmp/worldfoundry_all_benchmarks_plan \
--json
worldfoundry-eval run \
--all-benchmarks \
--model <model-zoo-id> \
--prepare \
--data-root cache/worldfoundry/data/hfd_datasets \
--plan-only \
--output-dir tmp/worldfoundry_all_benchmarks_plan \
--jsonUse the integrity commands before claiming benchmark support:
worldfoundry-eval zoo benchmarks --json
worldfoundry-eval run --plan-only --jsonFor release audits, use public CLI surfaces only:
worldfoundry-eval validate-artifact tmp/benchmark-run/scorecard.json \
--kind scorecard --check-artifacts --jsonContract runs, normalizer-only imports, partial dataset runs, and missing-official-runner checks are not leaderboard evidence. A public claim needs the full official data/runtime path and a scorecard whose eligibility fields explicitly support the claim.
Run the docs locally:
cd docs/fumadocs
npm ci
npm run dev -- --port 8014Build the static docs from the repository root:
bash scripts/docs/build.shThe docs app serves English routes under /docs and Chinese routes under /zh/docs.
Use these checks before opening a PR or marking a model/benchmark ready:
source tmp/worldfoundry_unified_env.sh
conda activate "${WORLDFOUNDRY_UNIFIED_ENV_PREFIX}"
PYTHONPATH=. python -m compileall -q worldfoundry scripts
PYTHONPATH=. python -m pytest -m fast_eval_core test/eval_core
bash scripts/docs/build.sh --skip-bootstrap
worldfoundry-eval zoo model-download --model-id <model-id> --check-local --json
worldfoundry-eval zoo benchmark-download --benchmark-id <benchmark-id> --check-local --json
worldfoundry-eval run --plan-only --fail-on-overclaim --fail-on-stale --jsonWhen adding or changing a model:
- Port required inference code into
worldfoundry; do not depend on a cloned external repo at runtime. - Keep official repositories only as provenance or parity references.
- Declare checkpoints, runtime variables, and environment assumptions in the model catalog/runtime profile.
- Run the smallest official-style demo and visually inspect the artifact.
- Record evidence in the docs before promoting readiness.
WorldFoundry
├─ docs/fumadocs # Documentation site, teaser, screenshots, and demo media
├─ requirements # Unified and optional dependency presets
├─ scripts
│ ├─ inference # User-facing inference entrypoints
│ ├─ setup # Conda setup wrappers
│ ├─ workspace # Studio / Workspace launch helpers
│ └─ docs # Documentation build wrapper
├─ worldfoundry
│ ├─ core # Shared contracts and reusable runtime abstractions
│ ├─ data # Model/benchmark catalogs, runtime profiles, fixtures
│ ├─ evaluation # Runner, tasks, metrics, scorecards, reports
│ ├─ operators # Input validation, preprocessing, interaction handling
│ ├─ pipelines # User-facing pipeline wrappers
│ ├─ representations # 3D/4D and spatial representation outputs
│ ├─ runtime # Runtime paths, assets, jobs, and probes
│ ├─ studio # Workspace and Studio frontends
│ └─ synthesis # In-tree model synthesis/action-generation runtimes
├─ test # Test suites
├─ thirdparty # Reviewed vendored/native dependencies
└─ tools # Maintenance and asset utilities
If you use WorldFoundry or its benchmark/model integrations in research, cite this repository and the upstream methods, checkpoints, datasets, and benchmarks that your run depends on. A formal paper citation will be added when the technical report is released.
WorldFoundry integrates and wraps a large set of upstream world-model, video-generation, perception, reconstruction, and embodied-action projects. See the method-specific runtime profiles and the docs appendix for upstream project pointers and licenses.
We also thank the following open-source projects for their model, runtime, and evaluation work:
- FastVideo — a unified inference and post-training framework for accelerated video generation
- OpenWorldLib — a unified codebase for advanced world models
- VLA Evaluation Harness — one framework to evaluate VLA models on robot simulation benchmarks





























