Skip to content

Add tutorial Jupyter notebooks for world-model training and Atari benchmark#171

Open
ParamThakkar123 wants to merge 6 commits into
mainfrom
codex/prepare-python-tutorials-for-world-models
Open

Add tutorial Jupyter notebooks for world-model training and Atari benchmark#171
ParamThakkar123 wants to merge 6 commits into
mainfrom
codex/prepare-python-tutorials-for-world-models

Conversation

@ParamThakkar123

Copy link
Copy Markdown
Owner

Motivation

  • Provide runnable, user-facing tutorial notebooks that demonstrate how to train each supported world-model family (Dreamer, PlaNet/RSSM, JEPA, IRIS, Genie, DIAMOND, DiT) on representative environments/datasets and how to run the Atari benchmark with trained checkpoints.
  • Make the notebooks discoverable from the documentation site and ensure docs builds do not execute expensive training/download cells by default.

Description

  • Added a new tutorials landing page at docs/source/tutorials/index.md and registered it in the main docs toctree (docs/source/index.rst).
  • Added per-model tutorial notebooks under docs/source/tutorials/notebooks/: dreamer_dmc_walker.ipynb, planet_gym_cartpole.ipynb, jepa_cifar10.ipynb, iris_atari_pong.ipynb, genie_tinyworlds_sonic.ipynb, diamond_atari_breakout.ipynb, dit_cifar10.ipynb, and atari_benchmark.ipynb.
  • Enabled notebook rendering in Sphinx by adding nbsphinx to docs/source/conf.py and set nbsphinx_execute = "never" so notebooks are rendered but not executed during doc builds.
  • Kept long-running training/evaluation cells commented out in notebooks and used small smoke-run configs in examples so users can opt in to run them locally.

Testing

  • Ran python -m py_compile docs/source/conf.py to validate the Sphinx config which succeeded.
  • Verified each notebook is valid JSON and that all code cells parse with ast.parse (checked via a small script), which succeeded.
  • Validated torchwm.create_config(...) overrides used by the notebooks (e.g. Dreamer and JEPA examples) to ensure the tutorial override fields are accepted, which succeeded.
  • Checked availability of the optional nbsphinx package as part of verification and reported it missing in the current environment (import nbsphinx failed), which is expected for environments that do not install docs extras and does not block the change.

Codex Task

@github-actions

github-actions Bot commented Jun 6, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://ParamThakkar123.github.io/torchwm/pr-preview/pr-171/

Built to branch gh-pages at 2026-06-07 06:39 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant