API reference
Every public module, class and function of the six public packages, generated from the source by static analysis.
Start with a package guide when you want the main entry points with examples. Come here for exact signatures.
| Package | Import | Summary |
|---|---|---|
| ump-spec | ump_spec | ump_spec: the Universal Model Protocol contract library (POC). |
| ump-sdk | ump_sdk | ump_sdk: thin shared runtime for UMP POC services. |
| ump-intake | ump_intake | ump_intake: shared data intake for the UMP POC (spec §6, datasets, extraction and lineage). |
| ump-workflow | ump_workflow | UMP workflow bundles: save a fitted analyst workflow as a hashed folder of data and source, and rerun it on new data of the same necessary shape (score by default, a labelled refit or the Tier D summary otherwise). |
| babelfin | babelfin | Babelfin: the analyst-facing Python API for UMP. |
| finprint | finprint | finprint: record how a dataset was made in pandas, save the recipe beside the output, replay it to check, apply it to new data of the same shape. |
How these pages are made
site/tools-api/gen_api.py reads each package with griffe without importing it. A module documents its __all__ when it has one, else the public names it defines. Modules whose name starts with an underscore get no page; their names appear on the page that re-exports them. CI regenerates the pages and fails when the committed copy is out of date.
redacted-engine and redacted_engine stand in for one unpublished engine identifier. They are placeholders, not standard values.