ump_spec.models.capability

module ump-spec

Capability manifest (spec §8) and capability lifecycle (§16).

Classes

class

class CalibrationSupport(StrictModel)

Fields

Name	Type	Default
`business_priors`	`bool`	`False`
`lift_tests`	`bool`	`False`
`interval_lift`	`bool`	`False`

Source: packages/ump-spec/src/ump_spec/models/capability.py, line 48

class

class CapabilityManifest(ArtifactDoc)

Fields

Name	Type	Default	Description
`engine`	`str`
`engine_version`	`str \| None`	`None`
`model_id`	`str \| None`	`None`
`version`	`str \| None`	`None`
`spec_version`	`str`	`SPEC_VERSION`
`supported_spec_versions`	`list[str] \| None`	`None`	Spec §21 Negotiation: spec versions the engine reads (exact values while the spec carries a pre-release tag). Left out of dumps when unset.
`family`	`ModelFamily`	`'media_mix'`
`tiers_produced`	`list[Tier]`	`list()`
`inference`	`Literal['mcmc', 'vi', 'map', 'smc', 'kalman', 'point', 'bootstrap', 'custom']`	`'custom'`
`representation`	`Representation`	`'draws'`
`dependence`	`DependenceDeclaration`	`lambda: DependenceDeclaration(kind='none')()`
`score_modes`	`list[Literal['predict', 'forecast', 'counterfactual', 'simulate', 'filter', 'evaluate']]`	`list()`
`decision`	`bool`	`False`
`calibration`	`CalibrationSupport`	`CalibrationSupport()`
`owns`	`list[str]`	`list()`
`deterministic_given_seed`	`bool`	`False`
`requests`	`dict[str, OperationSupport]`	`_all_unavailable()`
`family_requests`	`dict[str, OperationSupport]`	`dict()`
`estimands_supported`	`dict[str, Estimand]`	`dict()`
`lifecycle`	`CapabilityStatus`	`'sandbox'`
`stub`	`bool`	`False`
`input_schema`	`dict[str, Any] \| None`	`None`

Methods and properties (1)

supports method

def supports(self, op: str) -> OperationSupport

Source: packages/ump-spec/src/ump_spec/models/capability.py, line 54

function

def capability_transition_allowed(src: str, dst: str) -> bool

Source: packages/ump-spec/src/ump_spec/models/capability.py, line 40

Name	Type	Value	Description
`OperationSupport`		`Literal['built_in', 'computed_by_ump', 'unavailable']`
`STANDARD_REQUESTS`	`tuple[str, ...]`	`('score', 'response_curve', 'marginal_return', 'decompose', 'optimize', 'cali...`
`FAMILY_REQUESTS`	`dict[str, tuple[str, ...]]`	`{'media_mix': ('response_curve', 'decompose', 'optimize'), 'audience': ('rank...`
`CAPABILITY_LIFECYCLE`	`tuple[str, ...]`	`('sandbox', 'pilot', 'certified', 'restricted', 'withdrawn')`
`CAPABILITY_TRANSITIONS`	`dict[str, frozenset[str]]`	`{'sandbox': frozenset({'pilot', 'restricted', 'withdrawn'}), 'pilot': frozens...`	Any state may go to withdrawn immediately (§16).