Skip to navigation

API Reference

Language-by-language public surface for Dynamo, discovered from the source tree

View as Markdown
Python

Eleven modules: worker decorators, the HTTP frontend, planner, router and mocker configuration, and the Rust-backed runtime bindings.

Rust

Distributed runtime crates published on crates.io, pinned to the current release.

Kubernetes

Custom-resource fields for DynamoGraphDeployment, DynamoGraphDeploymentRequest and DynamoComponentDeployment.

The language and Kubernetes references are generated from Dynamo’s source tree. Each module page lists every class and function, expands into per-symbol signatures and public methods, and deep-links to the exact file and line on main.

For HTTP request contracts, see the frontend endpoints and the Image Edits API.

Coverage

  • Python — the Python API landing page indexes every curated module. Class methods and function signatures are pulled directly from the source; there are no hand-maintained tables.
  • Rust — see the published ai-dynamo crates on crates.io and the release artifact inventory for currently shipped crate versions.
  • Kubernetes — the Kubernetes API reference documents the full DynamoGraphDeployment / DynamoComponentDeployment custom-resource surface. Trimmed per-CRD references (DGD, DGDR, DCD) live as siblings under the same section so every deep link resolves.

These pages are generated and carry a do not edit marker. Python and Rust come from docstrings read by griffe: edit the source, then rerun gen_python_api.py or gen_rust_api.py in docs/fern/scripts/. Kubernetes takes one more hop — make generate-api-docs in deploy/operator/ turns the CRD Go types into api-reference-k8s.md, which gen_kubernetes_api.py then renders, so editing a Go type and rerunning the renderer alone changes nothing. The Python and Rust pages are not committed: the docs pipeline generates them at publish time, and the Generated API References pre-merge job reruns both generators to prove a source change cannot break them. Only the Kubernetes output stays committed, checked with --check scoped to the branch’s own changes on a pull request and strict on main.