ksuit.callbacks.default_callbacks.lr

Classes

LrCallback

Callback to log the learning rate of the optimizer.

Module Contents

class ksuit.callbacks.default_callbacks.lr.LrCallback(callback_config, trainer, model, data_container, tracker, log_writer, checkpoint_writer, metric_property_provider, name=None)

Bases: ksuit.callbacks.base.periodic_callback.PeriodicCallback

Callback to log the learning rate of the optimizer.

Initializes the PeriodicCallback.

Parameters:

  • callback_config (ksuit.schemas.callbacks.callbacks_config.CallBackBaseConfig) – Configuration of the PeriodicCallback. Implements the CallBackBaseConfig schema.

  • trainer (ksuit.trainers.BaseTrainer) – Trainer of the current run, subclass of SgdTrainer.

  • model (ksuit.models.model_base.ModelBase) – Model of the current run.

  • data_container (ksuit.utils.data.data_container.DataContainer) – DataContainer instance that provides access to all datasets.

  • tracker (ksuit.trackers.BaseTracker) – Tracker instance to log metrics to stdout/disk/online platform.

  • log_writer (ksuit.writers.LogWriter) – LogWriter instance to log metrics.

  • checkpoint_writer (ksuit.writers.CheckpointWriter) – CheckpointWriter instance to save checkpoints.

  • metric_property_provider (ksuit.providers.metric_property_provider.MetricPropertyProvider) – MetricPropertyProvider instance to access properties of metrics.

  • name (str | None) – Name of the callback.

should_log_after_update(training_iteration)

Checks after every update if the PeriodicCallback should be invoked.

Parameters:

training_iteration (ksuit.utils.training.training_iteration.TrainingIteration) – TrainingIteration to check.