noether.core.callbacks.online.update_output
===========================================

.. py:module:: noether.core.callbacks.online.update_output


Classes
-------

.. autoapisummary::

   noether.core.callbacks.online.update_output.UpdateOutputCallback


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

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

   Bases: :py:obj:`noether.core.callbacks.periodic.PeriodicCallback`


   Callback that is invoked during training after every gradient step to track certain outputs from the update step.

   The provided `update_outputs` are assumed to be a dictionary and outputs that match keys or patterns are tracked.
   An update output matches if either the key matches exactly, e.g. {"some_output": ...} and keys["some_output"];
   or if one of the patterns is contained in the update key name, e.g. {"some_loss": ...} and patterns = ["loss"].

   Initializes the UpdateOutputCallback class.

   :param callback_config: The configuration for the callback. Implements the UpdateOutputCallbackConfig schema.
   :param \*\*kwargs: additional keyword arguments provided to the parent cla


   .. py:attribute:: out
      :type:  pathlib.Path | None


   .. py:attribute:: patterns


   .. py:attribute:: keys


   .. py:attribute:: verbose


   .. py:attribute:: tracked_values
      :type:  collections.defaultdict[str, list]


   .. py:attribute:: reduce


   .. py:attribute:: log_output


   .. py:attribute:: save_output