Package Overview#
Synora is organized into focused modules so you can use only the pieces you need.
Quick Import (Public API)#
For applications and examples, prefer the installed package name, synora. It
mirrors the Synora implementation package and exposes the same lazy public
API without importing optional training backends until you use them.
import synora
print(synora.list_models())
agent = synora.create_model("dreamer", env="walker-walk", total_steps=1_000_000)
env = synora.make_env("CartPole-v1", backend="gym")
Use synora for direct component imports as well as factory helpers:
from synora import DreamerAgent, DreamerConfig
cfg = DreamerConfig()
cfg.env = "walker-walk"
agent = DreamerAgent(cfg)
Available Exports#
Category |
Exports |
|---|---|
Friendly factories |
|
Models / Agents |
|
State-space models |
|
Vision |
|
Quantization |
|
Configs |
|
Environments |
|
Memory |
|
Reward / Value |
|
Controllers |
|
Transformer blocks |
|
Diffusion |
|
Genie subcomponents |
|
Export |
|
Registry / plugins |
|
Deprecation |
|
Utilities |
|
Example usage:
import synora
# Training
agent = synora.create_model("dreamer", env="walker-walk", total_steps=1_000_000)
agent.train()
Core Modules#
The module paths below are the public synora.* surface
(from synora.models import Dreamer).
synora.models: High-level models and agents (Dreamer,DreamerAgent,Planet,JEPAAgent)synora.configs: Configuration containers for Dreamer, JEPA, and diffusion runssynora.training: Script-style training entrypoints for world models (VAE, MDNRNN, Controller, Planet, RSSM, JEPA)
Environment Integration#
synora.envs: DMC, Gym/Gymnasium, Atari, MuJoCo, Unity ML-Agents adapterssynora.envs.wrappers: Action repeat, normalization, time limits
World Model Building Blocks#
synora.models.dreamer_rssm: Recurrent state-space model used by Dreamersynora.models.modular_rssm: Modular RSSM with swappable encoder/decoder/backbone for research experimentssynora.vision: Encoders/decoders and action heads for latent dynamics modelssynora.reward: Reward and value prediction headssynora.observations: Symbolic and visual observation reconstruction modules
Representation Learning and Diffusion#
synora.models.vit: Vision Transformer and JEPA predictor componentssynora.models.diffusion: DDPM scheduler and DiT model implementationsynora.masks: Mask collators for JEPA-style context/target masking
Data and Memory#
synora.datasets: CIFAR-10, ImageNet-1K, and genericImageFolderdataset loaderssynora.memory: Replay buffers for Dreamer and episode-based memory for PlaNet/RSSM
Utilities#
synora.utils: Logging, parameter freezing, transformssynora.transforms: Data augmentation pipelinessynora.benchmarks: CLI and reporting utilities
Which API Should I Use?#
End-to-end Dreamer training:
DreamerAgentEnd-to-end JEPA training:
JEPAAgentWorld model training scripts:
synora.trainingmodules (e.g.,train_world_modelfor VAE+MDNRNN+Controller pipeline)Low-level model experimentation:
Dreamer,RSSM, decoder/encoder modulesCustom world model architectures:
ModularRSSMwith swappable encoder/decoder/backboneCustom data pipelines:
make_cifar10,make_imagenet1k,make_imagefolder