scenarioplanner.converters.dataframe.dataframe_model_converter.DataFrameModelConverter

Converts a bound Mmm model into denormalized flat data frame tables.

Inherits From: ModelConverter

scenarioplanner.converters.dataframe.dataframe_model_converter.DataFrameModelConverter(
    mmm_proto: pb.Mmm
)

The denormalized, two-dimensional data frame tables are intended to be directly compiled into sheets in a Google Sheets file to be used as a data source for a Looker Studio dashboard.

These data frame tables are:

  • "ModelDiagnostics"
  • "ModelFit"
  • "MediaOutcome"
  • "MediaSpend"
  • "MediaROI"
  • (Named Incremental Outcome Grids)
  • "budget_opt_specs"
  • "budget_opt_results"
  • "response_curves"
  • (Named R&F ROI Grids)
  • "rf_opt_specs"
  • "rf_opt_results"

mmm

Methods

__call__

View source

__call__(
    **kwargs
) -> Mapping[str, pd.DataFrame]

Converts bound Mmm model proto to named, flat data frame tables.