ump_spec.rules.experiments
module ump-spec
Experiment rules that several gates and apps share (spec §9, §10, §25.10).
is_brand_family decides whether a calibration target is a brand-family quantity, the only kind a
class E result (survey brand lift) may calibrate (G-EXP-05, spec §10 check 2).
Functions
Section titled “Functions”is_brand_family
Section titled “is_brand_family”function
def is_brand_family(target: Estimand | Mapping[str, Any] | str | None) -> boolTrue when target names a brand metric family.
target is an Estimand (or its JSON dict), a metric family name, or an estimand registry ID.
An estimand’s own metric_family wins; without one, its registry_id is looked up in the
registry. Anything unknown or absent is not a brand family.
Source: packages/ump-spec/src/ump_spec/rules/experiments.py, line 25
Constants
Section titled “Constants”| Name | Type | Value | Description |
|---|---|---|---|
BRAND_METRIC_FAMILIES | frozenset[str] | frozenset({'brand_awareness', 'ad_recall', 'consideration'}) | Metric families of the estimand registry that are brand families (spec §5 metric_family, §25.10). |