meridian.analysis.review.reviewer.ModelReviewer

A tool for executing a series of quality checks on a Meridian model.

meridian.analysis.review.reviewer.ModelReviewer(
    meridian: (Any | None) = None,
    model_context: (meridian.model.context.ModelContext | None) = None,
    inference_data: (az.InferenceData | None) = None,
    convergence_check_config: (meridian.analysis.review.configs.ConvergenceConfig | None) = None,
    post_convergence_checks: (ChecksBattery | None) = None
)

The reviewer first runs a convergence check. If the model has converged, it proceeds to run a battery of post-convergence checks.

The battery of post-convergence checks includes: - BaselineCheck - BayesianPPPCheck - GoodnessOfFitCheck - PriorPosteriorShiftCheck - ROIConsistencyCheck

Methods

run

View source

run(
    *,
    selected_geos: (Sequence[str] | None) = None,
    selected_times: (Sequence[str] | None) = None
) -> meridian.analysis.review.results.ReviewSummary

Executes all checks and generates the final summary.