ksuit.callbacks.default_callbacks.eta
=====================================

.. py:module:: ksuit.callbacks.default_callbacks.eta


Classes
-------

.. autoapisummary::

   ksuit.callbacks.default_callbacks.eta.EtaCallback


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

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

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


   Callback to print the progress and estimated duration until the `_periodic_callback` will be invoked. Also
   counts up the current epoch/update/samples and provides the average update duration. Only used in "unmanaged" runs,
   i.e., it is not used when the run was started via SLURM.

   Initializes the `PeriodicCallback`.

   :param callback_config: Configuration of the `PeriodicCallback`. Implements the `CallBackBaseConfig` schema.
   :param trainer: Trainer of the current run, subclass of `SgdTrainer`.
   :param model: Model of the current run.
   :param data_container: DataContainer instance that provides access to all datasets.
   :param tracker: Tracker instance to log metrics to stdout/disk/online platform.
   :param log_writer: LogWriter instance to log metrics.
   :param checkpoint_writer: CheckpointWriter instance to save checkpoints.
   :param metric_property_provider: MetricPropertyProvider instance to access properties of metrics.
   :param name: Name of the callback.


   .. py:class:: LoggerWasCalledHandler

      Bases: :py:obj:`logging.Handler`


      Handler instances dispatch logging events to specific destinations.

      The base handler class. Acts as a placeholder which defines the Handler
      interface. Handlers can optionally use Formatter instances to format
      records as desired. By default, no formatter is specified; in this case,
      the 'raw' message as determined by record.message is logged.

      Initializes the instance - basically setting the formatter to None
      and the filter list to empty.


      .. py:attribute:: was_called
         :value: False



      .. py:method:: emit(_)

         Do whatever it takes to actually log the specified logging record.

         This version is intended to be implemented by subclasses and so
         raises a NotImplementedError.




   .. py:attribute:: total_time
      :value: 0.0



   .. py:attribute:: time_since_last_log
      :value: 0.0



   .. py:attribute:: handler