BaseDelayedSaturatedMMM.__init__#

BaseDelayedSaturatedMMM.__init__(date_column, channel_columns, adstock_max_lag, model_config=None, sampler_config=None, validate_data=True, control_columns=None, yearly_seasonality=None, **kwargs)[source]#

Constructor method.

Parameters:
  • date_column (str) – Column name of the date variable.

  • channel_columns (List[str]) – Column names of the media channel variables.

  • model_config (Dictionary, optional) – dictionary of parameters that initialise model configuration. Class-default defined by the user default_model_config method.

  • sampler_config (Dictionary, optional) – dictionary of parameters that initialise sampler configuration. Class-default defined by the user default_sampler_config method.

  • validate_data (bool, optional) – Whether to validate the data before fitting to model, by default True.

  • control_columns (Optional[List[str]], optional) – Column names of control variables to be added as additional regressors, by default None

  • adstock_max_lag (int, optional) – Number of lags to consider in the adstock transformation, by default 4

  • yearly_seasonality (Optional[int], optional) – Number of Fourier modes to model yearly seasonality, by default None.