meridian.analysis.review.checks.ROIConsistencyCheck

Checks if ROI posterior mean is in tails of ROI prior.

Inherits From: BaseROICheck, BaseCheck

meridian.analysis.review.checks.ROIConsistencyCheck(
    *,
    meridian: (Any | None) = None,
    model_context: (meridian.model.context.ModelContext | None) = None,
    inference_data: (az.InferenceData | None) = None,
    analyzer: meridian.analysis.analyzer.Analyzer,
    config: meridian.analysis.review.checks.ConfigType,
    selected_geos: (Sequence[str] | None) = None,
    selected_times: (Sequence[str] | None) = None
)

Methods

is_relevant

View source

@classmethod
is_relevant(
    model_context: meridian.model.context.ModelContext,
    inference_data: (az.InferenceData | None) = None
) -> bool

Checks if the check is relevant for the given model context.

run

View source

run() -> meridian.analysis.review.results.ROIConsistencyCheckResult

Executes the check.

The return type uses the generic ResultType, making it specific for each subclass.