optuna.study.StudySummary

class optuna.study.StudySummary(study_name, direction, best_trial, user_attrs, system_attrs, n_trials, datetime_start, study_id, *, directions=None)

Basic attributes and aggregated results of a Study.

See also optuna.study.get_all_study_summaries().

Parameters:

• study_name (str)

• direction (StudyDirection | None)

• best_trial (trial.FrozenTrial | None)

• user_attrs (dict[str, Any])

• system_attrs (dict[str, Any])

• n_trials (int)

• datetime_start (datetime.datetime | None)

• study_id (int)

• directions (Sequence[StudyDirection] | None)

study_name

Name of the Study.

direction

StudyDirection of the Study.

Note

This attribute is only available during single-objective optimization.

directions

A sequence of StudyDirection objects.

best_trial

optuna.trial.FrozenTrial with best objective value in the Study.

user_attrs

Dictionary that contains the attributes of the Study set with optuna.study.Study.set_user_attr().

system_attrs

Dictionary that contains the attributes of the Study internally set by Optuna.

Warning

Deprecated in v3.1.0. system_attrs argument will be removed in the future. The removal of this feature is currently scheduled for v5.0.0, but this schedule is subject to change. See https://github.com/optuna/optuna/releases/tag/v3.1.0.

n_trials

The number of trials ran in the Study.

datetime_start

Datetime where the Study started.

Attributes

direction
directions
system_attrs