SensitivityAnalysis

class causalpy.steps.sensitivity.SensitivityAnalysis

Pipeline step that runs a suite of sensitivity / diagnostic checks.

Parameters:

checks (list[Any] | None) – The checks to run against the fitted experiment.

Examples

>>> import causalpy as cp
>>> step = cp.SensitivityAnalysis(
...     checks=[
...         cp.checks.PlaceboInTime(n_folds=4),
...         cp.checks.PriorSensitivity(priors=[...]),
...     ]
... )

Methods

SensitivityAnalysis.__init__([checks])
SensitivityAnalysis.default_for(method)	Create a SensitivityAnalysis pre-loaded with all registered default checks for method.
SensitivityAnalysis.run(context)	Run all checks against the fitted experiment.
SensitivityAnalysis.validate(context)	Validate that checks are well-formed.

__init__(checks=None)

Parameters:

checks (list[Any] | None)

Return type:

None

classmethod __new__(*args, **kwargs)