build_mmm_from_yaml

pymc_marketing.mmm.builders.yaml.build_mmm_from_yaml(config_path, *, X=None, y=None)

Build an MMM model from config_path.

The configuration keys:

• model (required): MMM initialization parameters

• effects (optional): list of additive effects in the model

• data (optional): paths to X and y data

• original_scale_vars (optional): list of original scale variables

• idata_path (optional): path to inference data

Parameters:

config_pathstr | Path

YAML file with model configuration.

Xpandas.DataFrame, optional

Pre-loaded covariate matrix. If omitted, the loader tries to read it from a path in the YAML under data.X_path.

ypandas.DataFrame | pandas.Series, optional

Pre-loaded target vector. If omitted, the loader tries to read it from a path in the YAML under data.y_path.

Returns:

modelMMM