Skip to content

Commit

Permalink
Clarify that pruners module does not support multi-objective optimiza…
Browse files Browse the repository at this point in the history
…tion (optuna#5270)
  • Loading branch information
nzw0301 authored Feb 26, 2024
1 parent 11721cc commit da8f74c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/source/reference/pruners.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ optuna.pruners

The :mod:`~optuna.pruners` module defines a :class:`~optuna.pruners.BasePruner` class characterized by an abstract :meth:`~optuna.pruners.BasePruner.prune` method, which, for a given trial and its associated study, returns a boolean value representing whether the trial should be pruned. This determination is made based on stored intermediate values of the objective function, as previously reported for the trial using :meth:`optuna.trial.Trial.report`. The remaining classes in this module represent child classes, inheriting from :class:`~optuna.pruners.BasePruner`, which implement different pruning strategies.

.. warning::
Currently :mod:`~optuna.pruners` module is expected to be used only for single-objective optimization.

.. seealso::
:ref:`pruning` tutorial explains the concept of the pruner classes and a minimal example.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
# ------------------
#
# ``Pruners`` automatically stop unpromising trials at the early stages of the training (a.k.a., automated early-stopping).
# Currently :mod:`~optuna.pruners` module is expected to be used only for single-objective optimization.
#
# Optuna provides the following pruning algorithms:
#
Expand Down

0 comments on commit da8f74c

Please sign in to comment.