ChannelDependentEffect

class pymc_marketing.mmm.spend_reach.ChannelDependentEffect(contribution_var, label, declared_carryover_lags, declared_evaluation_mode)

A mu_effect whose contribution a spend counterfactual can reach.

Produced by resolve_channel_dependent_effects() for every effect that (a) has channel_data among the ancestors of its contribution variable and (b) opted in via incrementality_spec().

Parameters:

contribution_varstr

Name of the deterministic holding the term this effect adds to the linear predictor.

labelstr

Class name of the originating effect, for error messages.

declared_carryover_lagsint or None

Extra evaluation-window length declared by the effect’s IncrementalitySpec, or None to have it measured.

declared_evaluation_mode{“auto”, “window”, “full”}

The spec’s evaluation_mode.

Methods

ChannelDependentEffect.__init__(...)

Attributes

contribution_var
label
declared_carryover_lags
declared_evaluation_mode