Other¶

class bayes_opt.ScreenLogger(verbose: int = 2, is_constrained: bool = False) → None¶

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.

property is_constrained : bool¶

Return whether the logger is constrained.

log_optimization_end() → None¶

Log the end of the optimization process.

Return type:¶

None

log_optimization_start(keys: list[str]) → None¶

Log the start of the optimization process.

Parameters:¶

keys : list[str]¶

The parameter keys.

Return type:¶

None

log_optimization_step(keys: list[str], result: dict[str, Any], params_config: Mapping[str, ParameterConfig], current_max: dict[str, Any] | None) → None¶

Log an optimization step.

Parameters:¶

keys : list[str]¶

The parameter keys.

result : dict[str, Any]¶

The result dictionary for the most recent step.

params_config : Mapping[str, ParameterConfig]¶

The configuration to map the key to the parameter for correct formatting.

current_max : dict[str, Any] | None¶

The current maximum target value and its parameters.

Return type:¶

None

property verbose : int¶

Return the verbosity level.