Skip to content

API reference

The API reference explains the contracts used by the framework subsystems. It is generated from the installed package with mkdocstrings, while each page adds curated context, configuration-to-object relationships, and links to task-oriented guidance.

Start with Core for Batch, ModelOutput, ExperimentConfig, and Registry. Then choose the subsystem that matches the component being built or configured.

Subsystems

  • Core: shared containers, configuration, and registry primitives.
  • Data: DataModule, collation, masks, and loader normalization.
  • Models: model contract and multimodal fusion implementations.
  • Training: Trainer, builders, BuildContext, and sweeps.
  • Inference: contexts, DAG pipelines, steps, and builders.
  • Callbacks: lifecycle extensions and artifact callbacks.
  • Losses: optimization objectives and registry factories.
  • Metrics: stateful epoch metrics and aggregation.
  • Logging: console/file and MLflow logger contracts.
  • Plugins: built-in and entry-point registration.

Use the User Guide when you need to accomplish a task; use these pages when you need exact signatures, accepted fields, return values, and extension contracts.