Synora Documentation
======================

Synora is a modular PyTorch library for world models, latent-dynamics planning,
and representation learning. Train Dreamer, JEPA, IRIS, DiT, Genie, and DIAMOND
agents with a unified API.

.. code-block:: python

   import synora

   # Runs on ``pip install synora[gym]``.
   agent = synora.create_model(
       "dreamer", env="Pendulum-v1", env_backend="gym", total_steps=5_000
   )
   agent.train()

.. toctree::
   :maxdepth: 1
   :caption: Get Started

   getting_started
   installation

.. toctree::
   :maxdepth: 1
   :caption: User Guides

   public_api
   training_guide
   inference_guide
   deployment_guide
   evaluation_guide
   memory_guide
   environments_guide
   environments/index
   datasets/nuplan
   cli
   package_overview
   controllers_guide
   world_models_guide
   tutorials/world_model_env_rl_libraries
   modular_rssm_guide
   vision_guide
   datasets_guide
   losses_guide
   plugin_registry
   world_models_deep_dive

.. toctree::
   :maxdepth: 1
   :caption: Algorithms

   dreamer
   planet
   jepa
   iris
   dit
   diamond
   genie

.. toctree::
   :maxdepth: 1
   :caption: Reference

   api_reference
   api_exports
   configs_reference
   export_guide

.. toctree::
   :maxdepth: 1
   :caption: Development

   contributing
   benchmarks
   run_code_in_docs