optuna.structs¶
-
class
optuna.structs.
TrialState
[source]¶ State of a
Trial
.-
PRUNED
¶ The
Trial
has been pruned withTrialPruned
.
Deprecated since version 1.4.0: This class is deprecated. Please use
TrialState
instead.-
-
class
optuna.structs.
StudyDirection
[source]¶ Direction of a
Study
.-
NOT_SET
¶ Direction has not been set.
Deprecated since version 1.4.0: This class is deprecated. Please use
StudyDirection
instead.-
-
class
optuna.structs.
FrozenTrial
(number, state, value, datetime_start, datetime_complete, params, distributions, user_attrs, system_attrs, intermediate_values, trial_id)[source]¶ Status and results of a
Trial
.Deprecated since version 1.4.0: This class was moved to
trial
. Please useFrozenTrial
instead.-
number
¶ Unique and consecutive number of
Trial
for eachStudy
. Note that this field uses zero-based numbering.
-
state
¶ TrialState
of theTrial
.
-
params
¶ Dictionary that contains suggested parameters.
-
user_attrs
¶ Dictionary that contains the attributes of the
Trial
set withoptuna.trial.Trial.set_user_attr()
.
-
intermediate_values
¶ Intermediate objective values set with
optuna.trial.Trial.report()
.
-
property
duration
¶ Return the elapsed time taken to complete the trial.
- Returns
The duration.
-
-
class
optuna.structs.
StudySummary
(study_name, direction, best_trial, user_attrs, system_attrs, n_trials, datetime_start, study_id)[source]¶ Basic attributes and aggregated results of a
Study
.Deprecated since version 1.4.0: This class was moved to
study
. Please useStudySummary
instead.See also
optuna.study.get_all_study_summaries()
.-
direction
¶ StudyDirection
of theStudy
.
-
best_trial
¶ FrozenTrial
with best objective value in theStudy
.
-
user_attrs
¶ Dictionary that contains the attributes of the
Study
set withoptuna.study.Study.set_user_attr()
.
-