ksuit.callbacks.online_callbacks.best_metric
============================================

.. py:module:: ksuit.callbacks.online_callbacks.best_metric


Classes
-------

.. autoapisummary::

   ksuit.callbacks.online_callbacks.best_metric.BestMetricCallback


Module Contents
---------------

.. py:class:: BestMetricCallback(callback_config, **kwargs)

   Bases: :py:obj:`ksuit.callbacks.base.PeriodicCallback`


   A callback that keeps track of the best metric value over a training run. For example, track the test loss of
   the epoch with the best validation loss to simulate early stopping.

   Initializes the BestMetricCallback

   :param callback_config: The configuration for the callback. Implements the BestMetricCallbackConfig schema.
   :param metric_property_provider: The metric property provider to determine whether higher values are better.
   :param \*\*kwargs: additional keyword arguments provided to the parent class.


   .. py:attribute:: source_metric_key


   .. py:attribute:: target_metric_keys


   .. py:attribute:: optional_target_metric_keys


   .. py:attribute:: higher_is_better


   .. py:attribute:: best_metric_value


   .. py:attribute:: previous_log_values
      :type:  dict[str, Any]