rename hist_classified_stable_as_func_of_hull_dist() to hist_classified_stable_vs_hull_dist()

Author: janosh

matbench_discovery/plot_scripts/hist_classified_stable_as_func_of_hull_dist.py

@@ -8,7 +8,7 @@
 from matbench_discovery.plots import (
     StabilityCriterion,
     WhichEnergy,
-    hist_classified_stable_as_func_of_hull_dist,
+    hist_classified_stable_vs_hull_dist,
 )
 
 __author__ = "Rhys Goodall, Janosh Riebesell"
@@ -59,7 +59,7 @@
 pred_cols = df.filter(regex=r"_pred_\d").columns
 assert len(pred_cols) == 10
 
-ax, metrics = hist_classified_stable_as_func_of_hull_dist(
+ax, metrics = hist_classified_stable_vs_hull_dist(
     e_above_hull_pred=df[pred_cols].mean(axis=1) - df[target_col],
     e_above_hull_true=df.e_above_hull,
     which_energy=which_energy,

matbench_discovery/plot_scripts/hist_classified_stable_as_func_of_hull_dist_batches.py

@@ -9,7 +9,7 @@
 from matbench_discovery.plots import (
     StabilityCriterion,
     WhichEnergy,
-    hist_classified_stable_as_func_of_hull_dist,
+    hist_classified_stable_vs_hull_dist,
     plt,
 )
 
@@ -77,7 +77,7 @@
     batch_df = df[df.index.str.startswith(f"wbm-step-{batch_idx}-")]
     assert 1e4 < len(batch_df) < 1e5, print(f"{len(batch_df) = :,}")
 
-    ax, metrics = hist_classified_stable_as_func_of_hull_dist(
+    ax, metrics = hist_classified_stable_vs_hull_dist(
         e_above_hull_pred=batch_df.e_form_per_atom_pred - batch_df.e_form_per_atom,
         e_above_hull_true=batch_df.e_above_hull_mp,
         which_energy=which_energy,
@@ -92,7 +92,7 @@
     ax.set(title=title)
 
 
-ax, metrics = hist_classified_stable_as_func_of_hull_dist(
+ax, metrics = hist_classified_stable_vs_hull_dist(
     e_above_hull_pred=df.e_form_per_atom_pred - df.e_form_per_atom,
     e_above_hull_true=df.e_above_hull_mp,
     which_energy=which_energy,

matbench_discovery/plots.py

@@ -63,7 +63,7 @@
 # --- end global plot settings
 
 
-def hist_classified_stable_as_func_of_hull_dist(
+def hist_classified_stable_vs_hull_dist(
     e_above_hull_pred: pd.Series,
     e_above_hull_true: pd.Series,
     std_pred: pd.Series = None,

models/cgcnn/use_cgcnn_ensemble.py models/cgcnn/test_cgcnn_ensemble.py

@@ -12,7 +12,7 @@
     AxLine,
     StabilityCriterion,
     cumulative_clf_metric,
-    hist_classified_stable_as_func_of_hull_dist,
+    hist_classified_stable_vs_hull_dist,
     rolling_mae_vs_hull_dist,
 )
 
@@ -130,7 +130,7 @@ def test_rolling_mae_vs_hull_dist(
 @pytest.mark.parametrize("stability_threshold", (0.1, 0.01))
 @pytest.mark.parametrize("stability_crit", ("energy", "energy+std", "energy-std"))
 @pytest.mark.parametrize("x_lim", ((0, 0.6), (-0.2, 0.8)))
-def test_hist_classified_stable_as_func_of_hull_dist(
+def test_hist_classified_stable_vs_hull_dist(
     stability_threshold: float,
     stability_crit: StabilityCriterion,
     x_lim: tuple[float, float],
@@ -146,7 +146,7 @@ def test_hist_classified_stable_as_func_of_hull_dist(
     else:
         std_total = None
 
-    ax, metrics = hist_classified_stable_as_func_of_hull_dist(
+    ax, metrics = hist_classified_stable_vs_hull_dist(
         e_above_hull_pred=df.e_above_hull_pred,
         e_above_hull_true=df.e_above_hull_mp,
         ax=ax,