From 7ffed242a6797e5f267290f7b38de1c0191effd4 Mon Sep 17 00:00:00 2001 From: James Lamb Date: Sat, 1 Jul 2023 20:14:13 -0500 Subject: [PATCH] DOC Remove scikit-learn-only docs references related to metadata routing --- sklearn/metrics/_scorer.py | 16 ++++++++-------- sklearn/utils/_metadata_requests.py | 8 ++++---- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/sklearn/metrics/_scorer.py b/sklearn/metrics/_scorer.py index c8969acba1744..66fadfae2d33d 100644 --- a/sklearn/metrics/_scorer.py +++ b/sklearn/metrics/_scorer.py @@ -180,8 +180,8 @@ def _use_cache(self, estimator): def get_metadata_routing(self): """Get metadata routing of this object. - Please check :ref:`User Guide ` on how the routing - mechanism works. + Please see ``Metadata Routing`` in the ``scikit-learn`` User Guide on + how the routing mechanism works. .. versionadded:: 1.3 @@ -243,8 +243,8 @@ def __call__(self, estimator, X, y_true, sample_weight=None, **kwargs): Other parameters passed to the scorer. Refer to :func:`set_score_request` for more details. - Only available if `enable_metadata_routing=True`. See the - :ref:`User Guide `. + Only available if `enable_metadata_routing=True`. See ``Metadata Routing`` + in the ``scikit-learn`` User Guide. .. versionadded:: 1.3 @@ -285,8 +285,8 @@ def _warn_overlap(self, message, kwargs): def set_score_request(self, **kwargs): """Set requested parameters by the scorer. - Please see :ref:`User Guide ` on how the routing - mechanism works. + Please see ``Metadata Routing`` in the ``scikit-learn`` User Guide on + how the routing mechanism works. .. versionadded:: 1.3 @@ -529,8 +529,8 @@ def __call__(self, estimator, *args, **kwargs): def get_metadata_routing(self): """Get requested data properties. - Please check :ref:`User Guide ` on how the routing - mechanism works. + Please see ``Metadata Routing`` in the ``scikit-learn`` User Guide on + how the routing mechanism works. .. versionadded:: 1.3 diff --git a/sklearn/utils/_metadata_requests.py b/sklearn/utils/_metadata_requests.py index 3cd2452982af0..728005f784035 100644 --- a/sklearn/utils/_metadata_requests.py +++ b/sklearn/utils/_metadata_requests.py @@ -990,8 +990,8 @@ def get_routing_for_object(obj=None): Note that this method is only relevant if ``enable_metadata_routing=True`` (see :func:`sklearn.set_config`). - Please see :ref:`User Guide ` on how the routing - mechanism works. + Please see ``Metadata Routing`` in the ``scikit-learn`` User Guide on + how the routing mechanism works. The options for each parameter are: @@ -1287,8 +1287,8 @@ def _get_metadata_request(self): def get_metadata_routing(self): """Get metadata routing of this object. - Please check :ref:`User Guide ` on how the routing - mechanism works. + Please see ``Metadata Routing`` in the ``scikit-learn`` User Guide on + how the routing mechanism works. Returns -------