Remove customization of quality checks.

PiperOrigin-RevId: 865047044

Author: lukmaz

meridian/analysis/review/reviewer.py

@@ -29,7 +29,7 @@
 ConfigInstance = configs.BaseConfig
 ChecksBattery = immutabledict.immutabledict[CheckType, ConfigInstance]
 
-_DEFAULT_POST_CONVERGENCE_CHECKS: ChecksBattery = immutabledict.immutabledict({
+_POST_CONVERGENCE_CHECKS: ChecksBattery = immutabledict.immutabledict({
     checks.BaselineCheck: configs.BaselineConfig(),
     checks.BayesianPPPCheck: configs.BayesianPPPConfig(),
     checks.GoodnessOfFitCheck: configs.GoodnessOfFitConfig(),
@@ -39,47 +39,29 @@
 
 
 class ModelReviewer:
-  """Executes a series of quality checks on a Meridian model.
+  """A tool for executing a series of quality checks on a Meridian model.
 
   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:
+  The 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:
-
-  ```python
-    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)
-  ```
   """
 
   def __init__(
       self,
       meridian,
-      post_convergence_checks: ChecksBattery = _DEFAULT_POST_CONVERGENCE_CHECKS,
   ):
     self._meridian = meridian
     self._results: list[results.CheckResult] = []
     self._analyzer = analyzer_module.Analyzer(
         model_context=meridian.model_context,
         inference_data=meridian.inference_data,
     )
-    self._post_convergence_checks = post_convergence_checks
 
   def _run_and_handle(self, check_class, config):
     instance = check_class(self._meridian, self._analyzer, config)  # pytype: disable=not-instantiable
@@ -139,7 +121,7 @@ def run(self) -> results.ReviewSummary:
       )
 
     # Run all other checks in sequence.
-    for check_class, config in self._post_convergence_checks.items():
+    for check_class, config in _POST_CONVERGENCE_CHECKS.items():
       if (
           check_class == checks.PriorPosteriorShiftCheck
           and not self._uses_roi_priors()

meridian/analysis/review/reviewer_test.py

@@ -140,13 +140,21 @@ def setUp(self):
     self._mock_pps_result.__class__ = results.PriorPosteriorShiftCheckResult
     self._mock_pps_check.run.return_value = self._mock_pps_result
 
-    self._default_post_convergence_checks = immutabledict.immutabledict({
-        self._mock_baseline_check_cls: configs.BaselineConfig(),
-        self._mock_bayesian_ppp_check_cls: configs.BayesianPPPConfig(),
-        self._mock_gof_check_cls: configs.GoodnessOfFitConfig(),
-        self._mock_pps_check_cls: configs.PriorPosteriorShiftConfig(),
-        self._mock_roi_consistency_check_cls: configs.ROIConsistencyConfig(),
-    })
+    patcher = mock.patch.object(
+        reviewer,
+        '_POST_CONVERGENCE_CHECKS',
+        new=immutabledict.immutabledict({
+            self._mock_baseline_check_cls: configs.BaselineConfig(),
+            self._mock_bayesian_ppp_check_cls: configs.BayesianPPPConfig(),
+            self._mock_gof_check_cls: configs.GoodnessOfFitConfig(),
+            self._mock_pps_check_cls: configs.PriorPosteriorShiftConfig(),
+            self._mock_roi_consistency_check_cls: (
+                configs.ROIConsistencyConfig()
+            ),
+        }),
+    )
+    patcher.start()
+    self.addCleanup(patcher.stop)
 
   def test_run_all_pass(self):
     self._mock_convergence_result.case = results.ConvergenceCases.CONVERGED
@@ -160,7 +168,6 @@ def test_run_all_pass(self):
 
     review = reviewer.ModelReviewer(
         meridian=self._meridian,
-        post_convergence_checks=self._default_post_convergence_checks,
     )
     summary = review.run()
 
@@ -195,7 +202,6 @@ def test_run_pass_with_roi_consistency_review(self):
 
     review = reviewer.ModelReviewer(
         meridian=self._meridian,
-        post_convergence_checks=self._default_post_convergence_checks,
     )
     summary = review.run()
 
@@ -229,7 +235,6 @@ def test_run_pass_with_gof_review(self):
 
     review = reviewer.ModelReviewer(
         meridian=self._meridian,
-        post_convergence_checks=self._default_post_convergence_checks,
     )
     summary = review.run()
 
@@ -265,7 +270,6 @@ def test_run_pass_with_pps_review(self):
 
     review = reviewer.ModelReviewer(
         meridian=self._meridian,
-        post_convergence_checks=self._default_post_convergence_checks,
     )
     summary = review.run()
 
@@ -292,7 +296,6 @@ def test_run_fail_not_converged_skips_other_checks(self):
 
     review = reviewer.ModelReviewer(
         meridian=self._meridian,
-        post_convergence_checks=self._default_post_convergence_checks,
     )
     summary = review.run()
 
@@ -324,7 +327,6 @@ def test_run_fail_not_fully_converged(self):
 
     review = reviewer.ModelReviewer(
         meridian=self._meridian,
-        post_convergence_checks=self._default_post_convergence_checks,
     )
     summary = review.run()
 
@@ -364,7 +366,6 @@ def test_run_fail_with_reviews(self):
 
     review = reviewer.ModelReviewer(
         meridian=self._meridian,
-        post_convergence_checks=self._default_post_convergence_checks,
     )
     summary = review.run()
 
@@ -403,7 +404,6 @@ def test_run_converged_with_fail_and_review(self):
 
     review = reviewer.ModelReviewer(
         meridian=self._meridian,
-        post_convergence_checks=self._default_post_convergence_checks,
     )
     summary = review.run()
 
@@ -436,7 +436,6 @@ def test_run_fail_baseline(self):
 
     review = reviewer.ModelReviewer(
         meridian=self._meridian,
-        post_convergence_checks=self._default_post_convergence_checks,
     )
     summary = review.run()
 
@@ -474,7 +473,6 @@ def test_run_pass_with_baseline_review(self):
 
     review = reviewer.ModelReviewer(
         meridian=self._meridian,
-        post_convergence_checks=self._default_post_convergence_checks,
     )
     summary = review.run()
 
@@ -508,7 +506,6 @@ def test_run_skip_checks_with_custom_roi_priors(self):
 
     review = reviewer.ModelReviewer(
         meridian=self._meridian,
-        post_convergence_checks=self._default_post_convergence_checks,
     )
     summary = review.run()
 
@@ -537,7 +534,6 @@ def test_run_skip_checks_with_non_roi_priors(self):
 
     review = reviewer.ModelReviewer(
         meridian=self._meridian,
-        post_convergence_checks=self._default_post_convergence_checks,
     )
     summary = review.run()
 
@@ -566,7 +562,6 @@ def test_run_with_default_configs(self):
 
     review = reviewer.ModelReviewer(
         meridian=self._meridian,
-        post_convergence_checks=self._default_post_convergence_checks,
     )
     review.run()
 
@@ -600,10 +595,12 @@ def test_run_with_custom_configs(self):
             prior_upper_quantile=0.95,
         ),
     })
-    review = reviewer.ModelReviewer(
-        meridian=self._meridian, post_convergence_checks=custom_checks
-    )
-    summary = review.run()
+
+    with mock.patch.object(
+        reviewer, '_POST_CONVERGENCE_CHECKS', new=custom_checks
+    ):
+      review = reviewer.ModelReviewer(meridian=self._meridian)
+      summary = review.run()
 
     self._mock_convergence_check_cls.assert_called_once_with(
         mock.ANY, mock.ANY, configs.ConvergenceConfig()
@@ -644,7 +641,6 @@ def test_run_twice_clears_results(self):
 
     review = reviewer.ModelReviewer(
         meridian=self._meridian,
-        post_convergence_checks=self._default_post_convergence_checks,
     )
     summary1 = review.run()
     summary2 = review.run()
@@ -668,7 +664,6 @@ def test_checks_status(self):
 
     review = reviewer.ModelReviewer(
         meridian=self._meridian,
-        post_convergence_checks=self._default_post_convergence_checks,
     )
     summary = review.run()