Source code for metaheuristic_designer.reporters.verbose_reporter

"""
Reporter that prints a text summary at regular intervals.
"""

from __future__ import annotations
import time
import logging
from typing import TYPE_CHECKING
from math import floor
from ..reporter import Reporter

if TYPE_CHECKING:
    from metaheuristic_designer.algorithm import Algorithm

logger = logging.getLogger(__name__)




class VerboseReporter(Reporter):
    """Reporter that prints a multi-line status block every `verbose_timer` seconds.

    Parameters
    ----------
    verbose_timer : float, optional
        Minimum interval (in seconds) between printed updates (default 0.5).
    """

    def __init__(self, verbose_timer=0.5, **kwargs):
        self.verbose_timer = verbose_timer
        self.verbose_start = time.time()



    def log_init(self, algorithm: Algorithm):
        """Print a header indicating the start of the optimisation."""
        self.verbose_start = time.time()

        objfunc_name = algorithm.objfunc.name
        alg_name = algorithm.name

        print(f'Initializing optimization of "{objfunc_name}" using "{alg_name}"')
        print(f"------------------------------{'-'*len(objfunc_name)}---------{'-'*len(alg_name)}-")
        print()




    def log_step(self, algorithm: Algorithm):
        """Print a status block if enough time has elapsed."""
        if time.time() - self.verbose_start < self.verbose_timer:
            return
        self.verbose_start = time.time()

        logger.debug("Finished iteration %d.", algorithm.iterations)
        objfunc_name = algorithm.objfunc.name
        alg_name = algorithm.name
        spent_time = algorithm.stopping_condition.real_time_spent
        spent_cpu_time = algorithm.stopping_condition.cpu_time_spent
        iterations = algorithm.iterations
        evaluations = algorithm.stopping_condition.evaluations
        patience_left = algorithm.stopping_condition.patience_left
        max_patience = algorithm.stopping_condition.max_patience
        iters_stuck = max_patience - patience_left
        progress = algorithm.stopping_condition.get_progress()

        _, best_fitness = algorithm.best_solution()
        print(f'Optimizing "{objfunc_name}" using "{alg_name}":')
        print(f"\tProgress:                 {floor(progress*100):d}%")
        print(f"\tReal time Spent:          {spent_time:.4f}s")
        print(f"\tCPU time Spent:           {spent_cpu_time:.4f}s")
        print(f"\tGeneration:               {iterations:,}")
        print(f"\tBest fitness:             {best_fitness:.6g}")
        print(f"\tEvaluations of fitness:   {evaluations:,}")
        print(f"\tIterations stuck:         {iters_stuck:,}")
        print()
        algorithm.search_strategy.extra_step_info()
        print()




    def log_end(self, algorithm: Algorithm):
        """Print a final summary of the completed run."""

        objfunc_name = algorithm.objfunc.name
        alg_name = algorithm.name
        iterations_accurate = len(algorithm.history_tracker.recorded_iterations)
        spent_time = algorithm.stopping_condition.real_time_spent
        spent_cpu_time = algorithm.stopping_condition.cpu_time_spent
        evaluations = algorithm.stopping_condition.evaluations
        patience_left = algorithm.stopping_condition.patience_left
        _, best_fitness = algorithm.best_solution()

        print(f"---------------------{'-'*len(objfunc_name)}---------{'-'*len(alg_name)}--")
        print(f'Finished optimizing "{objfunc_name}" using "{alg_name}":')
        print(f"\tReal time Spent:          {spent_time:.4f}s")
        print(f"\tCPU time Spent:           {spent_cpu_time:.4f}s")
        print(f"\tGenerations:              {iterations_accurate:,}")
        print(f"\tBest fitness:             {best_fitness:.6g}")
        print(f"\tEvaluations of fitness:   {evaluations:,}")
        print(f"\tConverged:                {patience_left == 0}")
        print()
        algorithm.search_strategy.extra_report()