MMMSummaryFactory.sensitivity_uplift

MMMSummaryFactory.sensitivity_uplift(hdi_probs=None, dims=None, aggregation=None, x_sweep_axis='relative', apply_cost_per_unit=True, output_format=None)

Summarize uplift curves (sensitivity_analysis['uplift_curve']).

Requires SensitivityAnalysis.compute_uplift_curve_respect_to_base().

Parameters:

hdi_probssequence of float, optional

HDI probability levels (default: uses factory default).

dimsdict, optional

Dimension filters.

aggregationdict, optional

Aggregation spec before summarization.

x_sweep_axis{“relative”, “absolute”}, default “relative”

Sweep axis interpretation for sweep_x column.

apply_cost_per_unitbool, default True

Use spend for absolute x-axis when applicable.

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

Output DataFrame format (default: uses factory default).

Returns:

pd.DataFrame or pl.DataFrame

Summary with sweep, mean, median, HDI, and sweep_x columns.