BudgetSummaryFactory.contribution_over_time

static BudgetSummaryFactory.contribution_over_time(samples, hdi_probs=(0.94,), dims=None, output_format='pandas')

Summarize channel contributions over time from budget allocation.

Parameters:

samplesxr.Dataset

Output of allocate_budget_to_maximize_response(...) or equivalent. Must contain channel_contribution_original_scale with channel, date, and sample or (chain, draw) dimensions.

hdi_probssequence of float, default (0.94,)

HDI probability levels.

dimsdict, optional

Dimension filters.

output_format{“pandas”, “polars”}, default “pandas”

Output DataFrame format.

Returns:

pd.DataFrame or pl.DataFrame

Summary with date, channel, mean, median, and HDI columns.