Skip to content

Commit

Permalink
DOC Add early stopping case to scoring glossary entry (scikit-learn…
Browse files Browse the repository at this point in the history
  • Loading branch information
lucyleeow authored Dec 30, 2024
1 parent 6385b7f commit 74775ca
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions doc/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1696,9 +1696,15 @@ functions or non-estimator constructors.
objects and avoid common pitfalls, you may refer to :ref:`randomness`.

``scoring``
Specifies the score function to be maximized (usually by :ref:`cross
validation <cross_validation>`), or -- in some cases -- multiple score
functions to be reported. The score function can be a string accepted
Depending on the object, can specify:

* the score function to be maximized (usually by
:ref:`cross validation <cross_validation>`),
* the multiple score functions to be reported,
* the score function to be used to check early stopping, or
* for visualization related objects, the score function to output or plot

The score function can be a string accepted
by :func:`metrics.get_scorer` or a callable :term:`scorer`, not to be
confused with an :term:`evaluation metric`, as the latter have a more
diverse API. ``scoring`` may also be set to None, in which case the
Expand All @@ -1711,7 +1717,6 @@ functions or non-estimator constructors.
this does *not* specify which score function is to be maximized, and
another parameter such as ``refit`` maybe used for this purpose.


The ``scoring`` parameter is validated and interpreted using
:func:`metrics.check_scoring`.

Expand Down

0 comments on commit 74775ca

Please sign in to comment.