BudgetSummaryFactory.allocation_roas

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

Summarize per-channel ROAS from an optimised budget allocation.

Parameters:

samplesxr.Dataset

Output of sample_response_distribution(...) or equivalent. Must contain channel_contribution_original_scale, allocation, and total_allocation.

hdi_probssequence of float, default (0.94,)

HDI probability levels.

dimsdict, optional

Dimension filters, e.g. {"geo": ["CA"]}.

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

Output DataFrame format.

Returns:

pd.DataFrame or pl.DataFrame

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