Adjust and improve DOC add link to plot_covariance_estimation example in docstrings and userguide

stefanogaspari · stefanogaspari · commit e4a7eb2e7d07 · 2024-12-09T22:36:10.000+04:00
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,36 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.5.1
+    hooks:
+    -   id: ruff
+        args: ["--fix", "--output-format=full"]
+-   repo: https://github.com/psf/black
+    rev: 24.3.0
+    hooks:
+    -   id: black
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.9.0
+    hooks:
+     -  id: mypy
+        files: sklearn/
+        additional_dependencies: [pytest==6.2.4]
+-   repo: https://github.com/MarcoGorelli/cython-lint
+    rev: v0.15.0
+    hooks:
+    # TODO: add the double-quote-cython-strings hook when it's usability has improved:
+    # possibility to pass a directory and use it as a check instead of auto-formatter.
+    -   id: cython-lint
+-   repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v2.7.1
+    hooks:
+    -   id: prettier
+        files: ^doc/scss/|^doc/js/scripts/
+        exclude: ^doc/js/scripts/vendor/
+        types_or: ["scss", "javascript"]
diff --git a/doc/modules/covariance.rst b/doc/modules/covariance.rst
@@ -18,6 +18,12 @@ a population's covariance matrix under various settings.
 We assume that the observations are independent and identically
 distributed (i.i.d.).
 
+* See :ref:`sphx_glr_auto_examples_covariance_plot_covariance_estimation.py` for
+  an example on how to fit :class:`ShrunkCovariance` , :class:`LedoitWolf` and
+  :class:`OAS` objects to data and for visualizing their performances in terms of
+  likelihood.
+
+
 
 Empirical covariance
 ====================
@@ -42,8 +48,6 @@ by the user, and ``assume_centered=True`` should be used.
 
 .. rubric:: Examples
 
-* See :ref:`sphx_glr_auto_examples_covariance_plot_covariance_estimation.py` for
-  an example on how to fit an :class:`EmpiricalCovariance` object to data.
 
 
 .. _shrunk_covariance:
@@ -85,8 +89,6 @@ bias/variance trade-off, and is discussed below.
 
 .. rubric:: Examples
 
-* See :ref:`sphx_glr_auto_examples_covariance_plot_covariance_estimation.py` for
-  an example on how to fit a :class:`ShrunkCovariance` object to data.
 
 
 Ledoit-Wolf shrinkage
@@ -121,10 +123,6 @@ fitting a :class:`LedoitWolf` object to the same sample.
 
 .. rubric:: Examples
 
-* See :ref:`sphx_glr_auto_examples_covariance_plot_covariance_estimation.py` for
-  an example on how to fit a :class:`LedoitWolf` object to data and
-  for visualizing the performances of the Ledoit-Wolf estimator in
-  terms of likelihood.
 
 .. rubric:: References
 
@@ -165,10 +163,6 @@ object to the same sample.
 
 .. rubric:: Examples
 
-* See :ref:`sphx_glr_auto_examples_covariance_plot_covariance_estimation.py` for
-  an example on how to fit an :class:`OAS` object to data and
-  for visualizing the performances of the OAS estimator in
-  terms of likelihood.
 
 * See :ref:`sphx_glr_auto_examples_covariance_plot_lw_vs_oas.py` to visualize the
   Mean Squared Error difference between a :class:`LedoitWolf` and
diff --git a/sklearn/model_selection/_search.py b/sklearn/model_selection/_search.py
@@ -1531,11 +1531,6 @@ class GridSearchCV(BaseSearchCV):
      'rank_test_score', 'split0_test_score',...
      'split2_test_score', ...
      'std_fit_time', 'std_score_time', 'std_test_score']
-
-    * See also :ref:`sphx_glr_auto_examples_covariance_plot_covariance_estimation.py`
-    for an example on how to fit a :class:`GridSearchCV` object to data and
-    for visualizing the performances of the grid search cross-validation estimator in
-    terms of likelihood.
     """
 
     _parameter_constraints: dict = {
