create_event_mu_effect#

pymc_marketing.mmm.additive_effect.create_event_mu_effect(df_events, prefix, effect)[source]#

Create an event effect for the MMM.

This class has the ability to create data and mean effects for the MMM model.

Parameters:
df_eventspd.DataFrame
The DataFrame containing the event data.
  • name: name of the event. Used as the model coordinates.

  • start_date: start date of the event

  • end_date: end date of the event

prefixstr

The prefix to use for the event effect and associated variables.

effectEventEffect

The event effect to apply.

Returns:
MuEffect

The event effect which is used in the MMM.