File: exceptions.rst

package info (click to toggle)
optuna 4.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,784 kB
  • sloc: python: 40,634; sh: 97; makefile: 30
file content (16 lines) | stat: -rw-r--r-- 659 bytes parent folder | download | duplicates (2) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
.. module:: optuna.exceptions

optuna.exceptions
=================

The :mod:`~optuna.exceptions` module defines Optuna-specific exceptions deriving from a base :class:`~optuna.exceptions.OptunaError` class. Of special importance for library users is the :class:`~optuna.exceptions.TrialPruned` exception to be raised if :func:`optuna.trial.Trial.should_prune` returns ``True`` for a trial that should be pruned.

.. autosummary::
   :toctree: generated/
   :nosignatures:

   optuna.exceptions.OptunaError
   optuna.exceptions.TrialPruned
   optuna.exceptions.CLIUsageError
   optuna.exceptions.StorageInternalError
   optuna.exceptions.DuplicatedStudyError