SensitivityAnalysis.compute_uplift_curve_respect_to_base

SensitivityAnalysis.compute_uplift_curve_respect_to_base(results, ref, extend_idata=False)

Return uplift curves referenced to a baseline.

Parameters:

results

Output from run_sweep(), typically with dims ("sample", "sweep", *extra_dims).

ref

Baseline to subtract from results. Can be a scalar (float or int) or an xarray.DataArray sharing a subset of the results dimensions (e.g. control, country). The coordinates for overlapping dimensions must match exactly so that the subtraction is well defined.

extend_idata

When True the uplift is also persisted under idata.sensitivity_analysis["uplift_curve"].