ksuit.callbacks.default_callbacks.peak_memory
=============================================

.. py:module:: ksuit.callbacks.default_callbacks.peak_memory


Classes
-------

.. autoapisummary::

   ksuit.callbacks.default_callbacks.peak_memory.PeakMemoryCallback


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

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

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


   Callback to log the peak memory usage of the model.

   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.