:py:mod:`kosmos.ml.fl.fl_manager`
=================================

.. py:module:: kosmos.ml.fl.fl_manager







Classes
-------

.. py:class:: FLManager(config: kosmos.ml.config.sl_train.FLTrainConfig, client_nodes: list[kosmos.topology.node.Node], server_node: kosmos.topology.node.Node)


   Federated learning manager for supervised learning classification tasks.

   Initialize the federated learning manager.

   :param config: Federated learning training configuration.
   :type config: FLTrainConfig
   :param client_nodes: The nodes representing federated clients.
   :type client_nodes: list[Node]
   :param server_node: The node representing the federated server.
   :type server_node: Node





   |

   .. rubric:: Methods

   .. py:method:: train() -> collections.abc.Iterator[kosmos.ml.sl_result.SLTrainIterationResult]

      Run federated training across all configured rounds.

      :returns:

                An iterator yielding one training result per epoch
                                                  for all rounds.
      :rtype: Iterator[SLTrainIterationResult]


   .. py:method:: test() -> kosmos.ml.sl_result.SLTestIterationResult

      Evaluate the global model on the test dataset.

      :returns: The result of the global model evaluation.
      :rtype: SLTrainIterationResult