ControlMuEffect

class pymc_marketing.mmm.additive_effect.ControlMuEffect(**data)

Effect that applies a user-configurable prior to each control variable.

Parameters:

data_varslist[str]

Names of the control data variables in mmm.xarray_dataset.

prefixstr

Prefix for effect variable names.

priorPrior, optional

Prior distribution for the control coefficients. Default is Prior("Normal", mu=0, sigma=2).

Methods

ControlMuEffect.__init__(**data)	Create a new model by parsing and validating input data from keyword arguments.
ControlMuEffect.construct([_fields_set])
ControlMuEffect.copy(*[, include, exclude, ...])	Returns a copy of the model.
ControlMuEffect.create_data(mmm)	Register each data variable as pm.Data.
ControlMuEffect.create_effect(mmm)	Create coefficients for each control variable and sum contributions.
ControlMuEffect.dict(*[, include, exclude, ...])
ControlMuEffect.from_dict(data)	Reconstruct from a dict.
ControlMuEffect.from_orm(obj)
ControlMuEffect.idata_groups()	Return supplementary data groups to store in DataTree.
ControlMuEffect.json(*[, include, exclude, ...])
ControlMuEffect.model_parametrized_name(params)	Compute the class name for parametrizations of generic classes.
ControlMuEffect.parse_file(path, *[, ...])
ControlMuEffect.parse_obj(obj)
ControlMuEffect.parse_raw(b, *[, ...])
ControlMuEffect.schema([by_alias, ref_template])
ControlMuEffect.schema_json(*[, by_alias, ...])
ControlMuEffect.set_data(mmm, model, X)	Update pm.Data variables from a new prediction dataset.
ControlMuEffect.to_dict([_orig])	Serialize to a dict via Pydantic model_dump.
ControlMuEffect.update_forward_refs(**localns)
ControlMuEffect.validate(value)

Attributes

contribution_var_name	Name of the posterior deterministic holding this effect's contribution.
model_computed_fields
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_extra	Get extra fields set during validation.
model_fields
model_fields_set	Returns the set of fields that have been explicitly set on this model instance.
prior
data_vars
prefix