sensitivity_analysis#

pymc_marketing.mmm.summary.sensitivity.sensitivity_analysis(data, hdi_probs=(0.94,), dims=None, aggregation=None, x_sweep_axis='relative', apply_cost_per_unit=True, output_format='pandas')[source]#

Summarize raw sensitivity sweep results (sensitivity_analysis['x']).

Parameters:
dataMMMIDataWrapper

Fitted model data wrapper with sensitivity analysis results.

hdi_probssequence of float, default (0.94,)

HDI probability levels.

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”}, default “pandas”

Output DataFrame format.

Returns:
pd.DataFrame or pl.DataFrame

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