ksuit.callbacks.default_callbacks.lr
====================================

.. py:module:: ksuit.callbacks.default_callbacks.lr


Classes
-------

.. autoapisummary::

   ksuit.callbacks.default_callbacks.lr.LrCallback


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

.. py:class:: LrCallback(callback_config, trainer, model, data_container, tracker, log_writer, checkpoint_writer, metric_property_provider, name = None)

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


   Callback to log the learning rate of the optimizer.

   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:method:: should_log_after_update(training_iteration)

      Checks after every update if the `PeriodicCallback` should be invoked.

      :param training_iteration: TrainingIteration to check.