feat: Rename plot to "scores"

probabl-ai · Dec 20, 2024 · 91aa92f · 91aa92f
1 parent 46685f8
commit 91aa92f
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 7 deletions.
diff --git a/examples/diagnose/plot_cross_validate.py b/examples/diagnose/plot_cross_validate.py
@@ -120,7 +120,7 @@
 
 # %%
 reporter = skore.CrossValidationReporter(clf, X, y, cv=5)
-reporter.plots.compare_scores
+reporter.plots.scores
 
 # %%
 # Skore's :class:`~skore.CrossValidationReporter` advantages are the following:
@@ -152,7 +152,7 @@
 lasso = Lasso()
 
 reporter = skore.CrossValidationReporter(lasso, X, y, cv=5)
-reporter.plots.compare_scores
+reporter.plots.scores
 
 # %%
 # We can also access the plot after we have stored the ``CrossValidationReporter``:

diff --git a/examples/getting_started/plot_getting_started.py b/examples/getting_started/plot_getting_started.py
@@ -237,7 +237,7 @@
 
 cv_reporter = CrossValidationReporter(Ridge(), X, y, cv=5)
 my_project.put("cv_reporter", cv_reporter)
-cv_reporter.plots.compare_scores
+cv_reporter.plots.scores
 
 # %%
 # Hence:

diff --git a/skore/src/skore/item/cross_validation_item.py b/skore/src/skore/item/cross_validation_item.py
@@ -154,7 +154,7 @@ def factory(cls, reporter: CrossValidationReporter) -> CrossValidationItem:
         }
 
         humanized_plot_names = {
-            "compare_scores": "Scores",
+            "scores": "Scores",
             "timing": "Timings",
             "timing_normalized": "Normalized timings",
         }

diff --git a/skore/src/skore/sklearn/cross_validation/cross_validation_reporter.py b/skore/src/skore/sklearn/cross_validation/cross_validation_reporter.py
@@ -24,7 +24,7 @@
 class CrossValidationPlots:
     """Plots of the cross-validation results."""
 
-    compare_scores: plotly.graph_objects.Figure
+    scores: plotly.graph_objects.Figure
     timing: plotly.graph_objects.Figure
     timing_normalized: plotly.graph_objects.Figure
 
@@ -187,7 +187,7 @@ def __repr__(self):
     def plots(self) -> CrossValidationPlots:
         """Plots of the cross-validation results."""
         return CrossValidationPlots(
-            compare_scores=plot_cross_validation_compare_scores(self._cv_results),
+            scores=plot_cross_validation_compare_scores(self._cv_results),
             timing=plot_cross_validation_timing(self._cv_results),
             timing_normalized=plot_cross_validation_timing_normalized(self._cv_results),
         )
diff --git a/skore/tests/unit/item/test_cross_validation_item.py b/skore/tests/unit/item/test_cross_validation_item.py
@@ -30,7 +30,7 @@ class FakeCrossValidationReporter:
     X = numpy.array([[1.0]])
     y = numpy.array([1])
     plots = CrossValidationPlots(
-        compare_scores=plotly.graph_objects.Figure(),
+        scores=plotly.graph_objects.Figure(),
         timing=plotly.graph_objects.Figure(),
         timing_normalized=plotly.graph_objects.Figure(),
     )