FrequencyReachAdditiveEffect.create_effect#

FrequencyReachAdditiveEffect.create_effect(mmm)[source]#

Build the Meridian-style R&F pipeline and return the aggregate effect.

Transformation steps:

  1. Saturate frequency: frequency_sat = saturation(frequency_raw)

  2. Effective exposure: effective_exposure_raw = reach_raw × frequency_sat

  3. Adstock: effective_exposure_adstocked = adstock(effective_exposure_raw)

  4. Scale: channel_contribution = beta × effective_exposure_adstocked

  5. Sum: total_effect = Σ_channel channel_contribution

Parameters:
mmmModel

The parent MMM instance.

Returns:
tensor

Tensor with dims (date, *mmm.dims) to be added to mu.