meridian.analysis.review.reviewer.ModelReviewer

Executes a series of quality checks on a Meridian model.

meridian.analysis.review.reviewer.ModelReviewer(
    meridian,
    post_convergence_checks: meridian.analysis.review.reviewer.ChecksBattery = _DEFAULT_POST_CONVERGENCE_CHECKS
)

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

The default battery of post-convergence checks includes: - BaselineCheck - BayesianPPPCheck - GoodnessOfFitCheck - PriorPosteriorShiftCheck - ROIConsistencyCheck Each with its default configuration.

This battery of checks can be customized by passing a dictionary to the post_convergence_checks argument of the constructor, mapping check classes to their configuration instances. For example, to run only the BaselineCheck with a non-default configuration:

  my_checks = {
      checks.BaselineCheck: configs.BaselineConfig(
          negative_baseline_prob_review_threshold=0.1,
          negative_baseline_prob_fail_threshold=0.5,
      )
  }
  reviewer = ModelReviewer(meridian_model, post_convergence_checks=my_checks)

Methods

run

View source

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

Executes all checks and generates the final summary.