Merge pull request #516 from bayesflow-org/rename-summaries

Rename approximator.summaries to summarize with deprecation

Author: vpratz

bayesflow/approximators/continuous_approximator.py

@@ -3,6 +3,7 @@
 import numpy as np
 
 import keras
+import warnings
 
 from bayesflow.adapters import Adapter
 from bayesflow.networks import InferenceNetwork, SummaryNetwork
@@ -543,7 +544,7 @@ def _sample(
             batch_shape, conditions=inference_conditions, **filter_kwargs(kwargs, self.inference_network.sample)
         )
 
-    def summaries(self, data: Mapping[str, np.ndarray], **kwargs) -> np.ndarray:
+    def summarize(self, data: Mapping[str, np.ndarray], **kwargs) -> np.ndarray:
         """
         Computes the learned summary statistics of given summary variables.
 
@@ -574,6 +575,14 @@ def summaries(self, data: Mapping[str, np.ndarray], **kwargs) -> np.ndarray:
 
         return summaries
 
+    def summaries(self, data: Mapping[str, np.ndarray], **kwargs) -> np.ndarray:
+        """
+        .. deprecated:: 2.0.4
+            `summaries` will be removed in version 2.0.5, it was renamed to `summarize` which should be used instead.
+        """
+        warnings.warn("`summaries` was renamed to `summarize` and will be removed in version 2.0.5.", FutureWarning)
+        return self.summarize(data=data, **kwargs)
+
     def log_prob(self, data: Mapping[str, np.ndarray], **kwargs) -> np.ndarray:
         """
         Computes the log-probability of given data under the model. The `data` dictionary is preprocessed using the

bayesflow/approximators/model_comparison_approximator.py

@@ -2,6 +2,7 @@
 
 import keras
 import numpy as np
+import warnings
 
 from bayesflow.adapters import Adapter
 from bayesflow.datasets import OnlineDataset
@@ -407,7 +408,7 @@ def predict(
 
         return keras.ops.convert_to_numpy(output)
 
-    def summaries(self, data: Mapping[str, np.ndarray], **kwargs) -> np.ndarray:
+    def summarize(self, data: Mapping[str, np.ndarray], **kwargs) -> np.ndarray:
         """
         Computes the learned summary statistics of given summary variables.
 
@@ -438,6 +439,14 @@ def summaries(self, data: Mapping[str, np.ndarray], **kwargs) -> np.ndarray:
 
         return summaries
 
+    def summaries(self, data: Mapping[str, np.ndarray], **kwargs) -> np.ndarray:
+        """
+        .. deprecated:: 2.0.4
+            `summaries` will be removed in version 2.0.5, it was renamed to `summarize` which should be used instead.
+        """
+        warnings.warn("`summaries` was renamed to `summarize` and will be removed in version 2.0.5.", FutureWarning)
+        return self.summarize(data=data, **kwargs)
+
     def _compute_logits(self, classifier_conditions: Tensor) -> Tensor:
         """Helper to compute projected logits from the classifier network."""
         logits = self.classifier_network(classifier_conditions)

bayesflow/diagnostics/metrics/model_misspecification.py

@@ -142,8 +142,8 @@ def summary_space_comparison(
             "statistics, or want to compare raw data and not summary statistics, please use the "
             f"`bootstrap_comparison` function with `comparison_fn={comparison_fn_name}` on the respective arrays."
         )
-    observed_summaries = convert_to_numpy(approximator.summaries(observed_data))
-    reference_summaries = convert_to_numpy(approximator.summaries(reference_data))
+    observed_summaries = convert_to_numpy(approximator.summarize(observed_data))
+    reference_summaries = convert_to_numpy(approximator.summarize(reference_data))
 
     distance_observed, distance_null = bootstrap_comparison(
         observed_samples=observed_summaries,

tests/test_approximators/test_summaries.py renamed to tests/test_approximators/test_summarize.py

@@ -5,19 +5,19 @@
 
 def test_valid_summaries(approximator_with_summaries, mean_std_summary_network, monkeypatch):
     monkeypatch.setattr(approximator_with_summaries, "summary_network", mean_std_summary_network)
-    summaries = approximator_with_summaries.summaries({"summary_variables": keras.ops.ones((2, 3))})
+    summaries = approximator_with_summaries.summarize({"summary_variables": keras.ops.ones((2, 3))})
     assert_allclose(summaries, keras.ops.stack([keras.ops.ones((2,)), keras.ops.zeros((2,))], axis=-1))
 
 
 def test_no_summary_network(approximator_with_summaries, monkeypatch):
     monkeypatch.setattr(approximator_with_summaries, "summary_network", None)
 
     with pytest.raises(ValueError):
-        approximator_with_summaries.summaries({"summary_variables": keras.ops.ones((2, 3))})
+        approximator_with_summaries.summarize({"summary_variables": keras.ops.ones((2, 3))})
 
 
 def test_no_summary_variables(approximator_with_summaries, mean_std_summary_network, monkeypatch):
     monkeypatch.setattr(approximator_with_summaries, "summary_network", mean_std_summary_network)
 
     with pytest.raises(ValueError):
-        approximator_with_summaries.summaries({})
+        approximator_with_summaries.summarize({})