docs: Mark CrossValidationReporter as deprecated (#1186)

probabl-ai · Jan 21, 2025 · 84f54e3 · 84f54e3
1 parent 434340e
commit 84f54e3
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/examples/model_evaluation/plot_cross_validate.py b/examples/model_evaluation/plot_cross_validate.py
@@ -7,6 +7,11 @@
 
 This example illustrates the motivation and the use of skore's
 :class:`skore.CrossValidationReporter` to get assistance when developing ML/DS projects.
+
+.. warning ::
+
+    **Deprecation Notice**:
+    :class:`skore.CrossValidationReporter` is deprecated in favor of :class:`skore.CrossValidationReport`.
 """
 
 # %%

diff --git a/skore/src/skore/sklearn/cross_validation/cross_validation_reporter.py b/skore/src/skore/sklearn/cross_validation/cross_validation_reporter.py
@@ -3,6 +3,11 @@
 This class implements a wrapper over scikit-learn's
 `cross_validate <https://scikit-learn.org/stable/modules/generated/sklearn.model_selection.cross_validate.html#sklearn.model_selection.cross_validate>`_
 function in order to enrich it with more information and enable more analysis.
+
+.. warning ::
+
+    **Deprecation Notice**:
+    This class is deprecated in favor of :class:`skore.CrossValidationReport`.
 """
 
 from dataclasses import dataclass
@@ -30,6 +35,11 @@ class CrossValidationPlots:
 class CrossValidationReporter:
     """Evaluate estimator by cross-validation and output UI-friendly object.
 
+    .. warning ::
+
+        **Deprecation Notice**:
+        This class is deprecated in favor of :class:`skore.CrossValidationReport`.
+
     This class wraps scikit-learn's :func:`sklearn.model_selection.cross_validate`
     function, to provide more context and facilitate the analysis.
     As such, the arguments are the same as the

diff --git a/sphinx/api.rst b/sphinx/api.rst
@@ -35,7 +35,6 @@ These functions and classes enhance scikit-learn's ones.
     :caption: ML Assistance
 
     train_test_split
-    CrossValidationReporter
 
 Report for a single estimator
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -146,3 +145,15 @@ get the common performance metric representations.
     CrossValidationReport.metrics.plot.precision_recall
     CrossValidationReport.metrics.plot.prediction_error
     CrossValidationReport.metrics.plot.roc
+
+Deprecated
+----------
+
+These functions and classes are deprecated.
+
+.. autosummary::
+    :toctree: generated/
+    :template: base.rst
+    :caption: Deprecated
+
+    CrossValidationReporter