Method _is_new_max

bayes_opt/logger.py:205–224

Check if the step to log produced a new maximum. Parameters ---------- current_max : dict[str, Any] | None The current maximum target value and its parameters. Returns ------- boolean

(self, current_max: dict[str, Any] | None)

        return line + "\n" + ("-" * self._header_length)

    def _is_new_max(self, current_max: dict[str, Any] | None) -> bool:
        """Check if the step to log produced a new maximum.

        Parameters
        ----------
        current_max : dict[str, Any] | None
            The current maximum target value and its parameters.

        Returns
        -------
        boolean
        """
        if current_max is None:
            # During constrained optimization, there might not be a maximum
            # value since the optimizer might've not encountered any points
            # that fulfill the constraints.
            return False
        if self._previous_max is None:
            self._previous_max = current_max["target"]
        return current_max["target"] > self._previous_max

    def _update_tracker(self, current_max: dict[str, Any] | None) -> None:
        """Update the tracker.