import datetime
from typing import Any
from typing import Dict
from typing import Optional
from optuna._study_direction import StudyDirection
from optuna import logging
from optuna import trial
_logger = logging.get_logger(__name__)
[docs]class StudySummary(object):
"""Basic attributes and aggregated results of a :class:`~optuna.study.Study`.
See also :func:`optuna.study.get_all_study_summaries`.
Attributes:
study_name:
Name of the :class:`~optuna.study.Study`.
direction:
:class:`~optuna.study.StudyDirection` of the :class:`~optuna.study.Study`.
best_trial:
:class:`FrozenTrial` with best objective value in the :class:`~optuna.study.Study`.
user_attrs:
Dictionary that contains the attributes of the :class:`~optuna.study.Study` set with
:func:`optuna.study.Study.set_user_attr`.
system_attrs:
Dictionary that contains the attributes of the :class:`~optuna.study.Study` internally
set by Optuna.
n_trials:
The number of trials ran in the :class:`~optuna.study.Study`.
datetime_start:
Datetime where the :class:`~optuna.study.Study` started.
"""
[docs] def __init__(
self,
study_name: str,
direction: StudyDirection,
best_trial: Optional[trial.FrozenTrial],
user_attrs: Dict[str, Any],
system_attrs: Dict[str, Any],
n_trials: int,
datetime_start: Optional[datetime.datetime],
study_id: int,
):
self.study_name = study_name
self.direction = direction
self.best_trial = best_trial
self.user_attrs = user_attrs
self.system_attrs = system_attrs
self.n_trials = n_trials
self.datetime_start = datetime_start
self._study_id = study_id
def __eq__(self, other: Any) -> bool:
if not isinstance(other, StudySummary):
return NotImplemented
return other.__dict__ == self.__dict__
def __lt__(self, other: Any) -> bool:
if not isinstance(other, StudySummary):
return NotImplemented
return self._study_id < other._study_id
def __le__(self, other: Any) -> bool:
if not isinstance(other, StudySummary):
return NotImplemented
return self._study_id <= other._study_id