Skip to content

DOC Remove scikit-learn-only docs references related to metadata routing #26747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

DOC Remove scikit-learn-only docs references related to metadata routing #26747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions sklearn/metrics/_scorer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <metadata_routing>` 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

Expand Down Expand Up @@ -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 <metadata_routing>`.
Only available if `enable_metadata_routing=True`. See ``Metadata Routing``
in the ``scikit-learn`` User Guide.

.. versionadded:: 1.3

Expand Down Expand Up @@ -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 <metadata_routing>` 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

Expand Down Expand Up @@ -529,8 +529,8 @@ def __call__(self, estimator, *args, **kwargs):
def get_metadata_routing(self):
"""Get requested data properties.

Please check :ref:`User Guide <metadata_routing>` 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

Expand Down
8 changes: 4 additions & 4 deletions sklearn/utils/_metadata_requests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <metadata_routing>` 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:

Expand Down Expand Up @@ -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 <metadata_routing>` on how the routing
mechanism works.
Please see ``Metadata Routing`` in the ``scikit-learn`` User Guide on
how the routing mechanism works.

Returns
-------
Expand Down