:py:mod:`kosmos.ml.sl_result`
=============================

.. py:module:: kosmos.ml.sl_result







Classes
-------

.. py:class:: SLIterationResult

   Bases: :py:class:`abc.ABC`

   Result of a supervised learning iteration.

   .. attribute:: loss

      Mean loss value over the iteration.

      :type: float

   .. attribute:: metrics

      Evaluation metrics for the iteration.

      :type: SLMetrics







----

.. py:class:: SLTrainIterationResult

   Bases: :py:class:`SLIterationResult`

   Result of a supervised learning training iteration.

   .. attribute:: loss

      Mean loss value over the iteration.

      :type: float

   .. attribute:: metrics

      Evaluation metrics for the iteration.

      :type: SLMetrics

   .. attribute:: epoch

      Epoch index corresponding to this iteration.

      :type: int

   .. attribute:: fl_round

      Federated learning round index corresponding to this iteration.
      Defaults to None.

      :type: int | None

   .. attribute:: node

      The node corresponding to this iteration. Defaults to None.

      :type: Node | None







----

.. py:class:: SLTestIterationResult

   Bases: :py:class:`SLIterationResult`

   Result of a supervised learning test iteration.

   .. attribute:: loss

      Mean loss value over the iteration.

      :type: float

   .. attribute:: metrics

      Evaluation metrics for the iteration.

      :type: SLMetrics