Skip to content

API reference

This library reference is generated from Python signatures and docstrings on every documentation build. Changes to the library source, documentation, or build configuration rebuild and publish the site when merged to main; pull requests build and validate the reference before publication.

The API reference mirrors Altar's compatibility-controlled façade. External packages should import from these modules rather than from altar.plugins.* implementation paths.

Module Purpose
altar.models model bindings, requests, plans, and layouts
altar.scoring batch preparation and scoring orchestration
altar.execution tasks, backends, storage, task state, and dependency advancement
altar.results score stores, result records, schemas, and result assembly
altar.sources annotation and variant–gene relation sources
altar.predicates portable three-valued expressions
altar.registry generic extension registry
altar.variants canonical variant ingestion and validation
altar.access authentication-provider interface (provisional)
altar.testing reusable extension conformance suites
altar_identity variant, variant-file, and SHA-256 identity shared with model runtimes

The package root exports only __version__. See the compatibility policy for guarantees, provisional names, and experimental namespaces.