src.core.model

Defines the core MMM class, integrating base functionality with validation.

Module Contents

class src.core.model.MMM(date_column: str, channel_columns: List[str] | Tuple[str, Ellipsis], model_config: Dict | None = None, sampler_config: Dict | None = None, **kwargs: Any)

Bases: src.core.base.BaseMMM, src.prepro.valid.ValidateTargetColumn, src.prepro.valid.ValidateDateColumn, src.prepro.valid.ValidateChannelColumns

Main MMM class inheriting base functionalities and validation mixins.

This class represents the primary MMM (Media Mix Modelling) implementation. It combines the core modelling logic from BaseMMM with specific validation checks for the target column, date column, and channel columns provided by the validation mixins (vd.ValidateTargetColumn, etc.).

Usage:

Instantiate this class to create and work with an MMM model. `python mmm = MMM(date_column='Date', channel_columns=['TV', 'Radio'], model_config={}, sampler_config={}) # ... further model setup and fitting ... `