Skip to content

Spec

uptimely.spec owns declarative documents, loading, conversion, semantic validation, serialization, and feature dependency inspection. Executable invocations and execution plans belong to the compiler.

The spec format reference describes the contract. See Python authoring for declarations that produce it, or feature graphs for dependency analysis.

Package map

Module or subpackage Purpose
api Load and convert spec with semantic validation.
model Define the spec document, datasets, bindings, and function metadata.
json Write spec documents as JSON.
validation Check document relationships and inspect structured validation errors.
python Author spec using Python declarations.
feature_graph Inspect feature dependencies and select subgraphs.

Working with spec

  1. Load a JSON document or convert Python declarations using api.
  2. Work with the document types defined in model.
  3. Inspect dependencies using feature graphs, or pass the document to the compiler to create executable invocations.
  4. Write the spec document using json. After editing a document directly, call validate_spec to check its semantics again.

Public convenience imports such as uptimely.spec.Spec and uptimely.spec.load_spec remain available. The reference pages document each interface in its defining module.