BudgetSummaryFactory#

class pymc_marketing.mmm.summary.budget.BudgetSummaryFactory[source]#

Factory for creating summary DataFrames from budget allocation samples.

Stateless namespace mirroring BudgetPlots but returning tabular summaries with HDI statistics.

Obtain via optimizer.summary on BudgetOptimizerWrapper or optimizer.plot.summary on BudgetPlots.

Examples

>>> samples = optimizer.allocate_budget(...)
>>> df = optimizer.summary.allocation_roas(samples=samples)
>>> records = df.to_dict(orient="records")

Methods

`BudgetSummaryFactory.__init__`(args, *kwargs)
`BudgetSummaryFactory.allocation_roas`(samples)	Summarize per-channel ROAS from an optimised budget allocation.
`BudgetSummaryFactory.contribution_over_time`(samples)	Summarize channel contributions over time from budget allocation.