scenarioplanner.converters.dataframe.budget_opt_converters.BudgetOptimizationResultsConverter

Outputs a table of budget optimization results objectives.

Inherits From: Converter

scenarioplanner.converters.dataframe.budget_opt_converters.BudgetOptimizationResultsConverter(
    mmm_wrapper: scenarioplanner.converters.mmm.Mmm
)

When called, this converter returns a data frame with the columns:

  • "Group ID" A UUID generated for a budget optimization result present in the output.
  • "Channel"
  • "Is Revenue KPI" Whether the KPI is revenue or not.
  • "Optimal Spend"
  • "Optimal Spend Share"
  • "Optimal Impression Effectiveness"
  • "Optimal ROI"
  • "Optimal mROI"
  • "Optimal CPC"

Methods

__call__

View source

__call__() -> Iterator[tuple[str, pd.DataFrame]]

Call self as a function.