Skip to content

Reference

This section provides reference documentation for the public interfaces of the project.

Reference docs answer questions like: - What are the supported API endpoints? - How do I run the pipelines? - Which configuration parameters exist and what do they do?

If you are new to the system, start with: - Home → Overview - Quickstart – Reproducible Golden Path - Architecture


What is considered "public API" in this project

  • Inference API (FastAPI endpoints and Pydantic schemas)
  • Pipeline entrypoints (CLI / python -m ...)
  • Configuration surface (Hydra configuration groups and defaults)

Reference index

  • API (FastAPI): request/response schemas, endpoints, example payloads
  • Pipelines: supported commands and typical workflows
  • Configuration (Hydra): config structure, key parameters, overrides