contribution_var_name#

property EventAdditiveEffect.contribution_var_name: str[source]#

Name of the posterior deterministic holding this effect’s contribution.

Used by MMM.compute_counterfactual_contributions_dataset() to locate the effect’s linear-predictor contribution and include it in the decomposition. The default assumes the effect registers f"{self.prefix}_effect_contribution" (the convention used by LinearTrendEffect and EventEffect); effects that register a different name must override this property.

Raises:
NotImplementedError

If the effect has no prefix attribute and does not override this property.