FrequencyReachAdditiveEffect#

class pymc_marketing.mmm.additive_effect.frequency_reach_effect.FrequencyReachAdditiveEffect(**data)[source]#

Additive mu effect from frequency & reach observations.

Parameters:
df_frequency_reachpd.DataFrame

Long format DataFrame with columns at least: date, channel, frequency, reach. Additional columns matching mmm.dims (e.g. geo) are optional.

saturationSaturationTransformation

Saturation transformation applied after adstock.

adstockAdstockTransformation

Adstock transformation applied first to the effective exposure signal.

prefixstr, default “frequency_reach”

Variable name prefix for PyMC random/deterministic vars.

date_dim_namestr, default “date”

Name of the date coordinate in the target model.

channel_coord_namestr, default “channel”

Name of the channel coordinate used by the parent model.

Methods

FrequencyReachAdditiveEffect.__init__(**data)

Create a new model by parsing and validating input data from keyword arguments.

FrequencyReachAdditiveEffect.construct([...])

FrequencyReachAdditiveEffect.copy(*[, ...])

Returns a copy of the model.

FrequencyReachAdditiveEffect.create_data(mmm)

Register pm.Data nodes required for the effect.

FrequencyReachAdditiveEffect.create_effect(mmm)

Create transformed contribution (Meridian pipeline) and return aggregate effect.

FrequencyReachAdditiveEffect.dict(*[, ...])

FrequencyReachAdditiveEffect.from_orm(obj)

FrequencyReachAdditiveEffect.json(*[, ...])

FrequencyReachAdditiveEffect.model_construct([...])

Creates a new instance of the Model class with validated data.

FrequencyReachAdditiveEffect.model_copy(*[, ...])

!!! abstract "Usage Documentation"

FrequencyReachAdditiveEffect.model_dump(*[, ...])

!!! abstract "Usage Documentation"

FrequencyReachAdditiveEffect.model_dump_json(*)

!!! abstract "Usage Documentation"

FrequencyReachAdditiveEffect.model_json_schema([...])

Generates a JSON schema for a model class.

FrequencyReachAdditiveEffect.model_parametrized_name(params)

Compute the class name for parametrizations of generic classes.

FrequencyReachAdditiveEffect.model_post_init(...)

Model post initialization for a Pydantic model.

FrequencyReachAdditiveEffect.model_rebuild(*)

Try to rebuild the pydantic-core schema for the model.

FrequencyReachAdditiveEffect.model_validate(obj, *)

Validate a pydantic model instance.

FrequencyReachAdditiveEffect.model_validate_json(...)

!!! abstract "Usage Documentation"

FrequencyReachAdditiveEffect.model_validate_strings(obj, *)

Validate the given object with string data against the Pydantic model.

FrequencyReachAdditiveEffect.parse_file(path, *)

FrequencyReachAdditiveEffect.parse_obj(obj)

FrequencyReachAdditiveEffect.parse_raw(b, *)

FrequencyReachAdditiveEffect.schema([...])

FrequencyReachAdditiveEffect.schema_json(*)

FrequencyReachAdditiveEffect.set_data(mmm, ...)

Update reach & frequency raw data for prediction dates.

FrequencyReachAdditiveEffect.update_forward_refs(...)

FrequencyReachAdditiveEffect.validate(value)

Attributes

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.

df_frequency_reach

saturation

adstock

prefix

date_dim_name

channel_coord_name