DataVarMuEffect

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

MuEffect that reads its data from the xarray Dataset.

Subclasses only need to implement create_effect. create_data and set_data are provided by default.

Parameters:

data_varslist[str]

Names of the data variables in mmm.xarray_dataset to register as PyMC data variables. At least one variable is required.

prefixstr

Prefix for effect variable names.

Methods

DataVarMuEffect.__init__(**data)	Create a new model by parsing and validating input data from keyword arguments.
DataVarMuEffect.construct([_fields_set])
DataVarMuEffect.copy(*[, include, exclude, ...])	Returns a copy of the model.
DataVarMuEffect.create_data(mmm)	Register each data variable as pm.Data.
DataVarMuEffect.create_effect(mmm)	Create the additive effect in the model.
DataVarMuEffect.dict(*[, include, exclude, ...])
DataVarMuEffect.from_dict(data)	Reconstruct from a dict via Pydantic model_validate.
DataVarMuEffect.from_orm(obj)
DataVarMuEffect.idata_groups()	Return supplementary data groups to store in DataTree.
DataVarMuEffect.json(*[, include, exclude, ...])
DataVarMuEffect.model_parametrized_name(params)	Compute the class name for parametrizations of generic classes.
DataVarMuEffect.parse_file(path, *[, ...])
DataVarMuEffect.parse_obj(obj)
DataVarMuEffect.parse_raw(b, *[, ...])
DataVarMuEffect.schema([by_alias, ref_template])
DataVarMuEffect.schema_json(*[, by_alias, ...])
DataVarMuEffect.set_data(mmm, model, X)	Update pm.Data variables from a new prediction dataset.
DataVarMuEffect.to_dict()	Serialize to a dict via Pydantic model_dump.
DataVarMuEffect.update_forward_refs(**localns)
DataVarMuEffect.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.
data_vars
prefix