Module fl_server_ai.trainer.events.base¶

View Source

# SPDX-FileCopyrightText: 2024 Benedikt Franke <benedikt.franke@dlr.de>
# SPDX-FileCopyrightText: 2024 Florian Heinrich <florian.heinrich@dlr.de>
#
# SPDX-License-Identifier: Apache-2.0

from abc import ABC, abstractmethod
from logging import getLogger

from .. import model_trainer


class ModelTrainerEvent(ABC):
    """
    Abstract base class for a model trainer event.
    """

    _logger = getLogger("fl.server")

    def __init__(self, trainer: "model_trainer.ModelTrainer"):
        """
        Initialize the event with the given trainer.

        Args:
            trainer (model_trainer.ModelTrainer): The trainer that the event is associated with.
        """
        super().__init__()
        self.trainer = trainer
        """The trainer that the event is associated with."""
        self.training = trainer.training
        """The training that the event is associated with."""

    @abstractmethod
    def handle(self):
        """
        Handle the event.
        """
        pass

    @abstractmethod
    def next(self):
        """
        Proceed with the next event.
        """
        pass

Classes¶

ModelTrainerEvent¶

class ModelTrainerEvent(
    trainer: 'model_trainer.ModelTrainer'
)

Abstract base class for a model trainer event.

View Source

class ModelTrainerEvent(ABC):
    """
    Abstract base class for a model trainer event.
    """

    _logger = getLogger("fl.server")

    def __init__(self, trainer: "model_trainer.ModelTrainer"):
        """
        Initialize the event with the given trainer.

        Args:
            trainer (model_trainer.ModelTrainer): The trainer that the event is associated with.
        """
        super().__init__()
        self.trainer = trainer
        """The trainer that the event is associated with."""
        self.training = trainer.training
        """The training that the event is associated with."""

    @abstractmethod
    def handle(self):
        """
        Handle the event.
        """
        pass

    @abstractmethod
    def next(self):
        """
        Proceed with the next event.
        """
        pass

Ancestors (in MRO)¶

abc.ABC

Descendants¶

fl_server_ai.trainer.events.model_test_finished.ModelTestFinished
fl_server_ai.trainer.events.training_round_finished.TrainingRoundFinished

Methods¶

handle¶

def handle(
    self
)

Handle the event.

View Source

    @abstractmethod
    def handle(self):
        """
        Handle the event.
        """
        pass

next¶

def next(
    self
)

Proceed with the next event.

View Source

    @abstractmethod
    def next(self):
        """
        Proceed with the next event.
        """
        pass