Class ScreenLogger

bayes_opt/logger.py:16–293

Logger that outputs text, e.g. to log to a terminal. Parameters ---------- verbose : int Verbosity level of the logger. is_constrained : bool Whether the logger is associated with a constrained optimization instance.

class ScreenLogger:
    """Logger that outputs text, e.g. to log to a terminal.

    Parameters
    ----------
    verbose : int
        Verbosity level of the logger.

    is_constrained : bool
        Whether the logger is associated with a constrained optimization
        instance.
    """

    _default_cell_size = 9
    _default_precision = 4
    _color_new_max = Fore.MAGENTA
    _color_regular_message = Fore.RESET
    _color_reset = Fore.RESET

    def __init__(self, verbose: int = 2, is_constrained: bool = False) -> None:
        self._verbose = verbose
        self._is_constrained = is_constrained
        self._header_length = None
        self._iterations = 0
        self._previous_max = None
        self._previous_max_params = None
        self._start_time = None
        self._previous_time = None

    @property
    def verbose(self) -> int:
        """Return the verbosity level."""
        return self._verbose

    @verbose.setter
    def verbose(self, v: int) -> None:
        """Set the verbosity level.

        Parameters
        ----------
        v : int
            New verbosity level of the logger.
        """
        self._verbose = v

    @property
    def is_constrained(self) -> bool:
        """Return whether the logger is constrained."""
        return self._is_constrained

    def _format_number(self, x: float) -> str:
        """Format a number.

        Parameters
        ----------
        x : number
            Value to format.