fl_server_ai.notification.training.finished ¶

Bases: TrainingNotification['TrainingFinishedNotification.Body']

              flowchart TD
              fl_server_ai.notification.training.finished.TrainingFinishedNotification[TrainingFinishedNotification]
              fl_server_ai.notification.training.training.TrainingNotification[TrainingNotification]
              fl_server_ai.notification.notification.Notification[Notification]
              fl_server_ai.notification.serializable.Serializable[Serializable]

                              fl_server_ai.notification.training.training.TrainingNotification --> fl_server_ai.notification.training.finished.TrainingFinishedNotification
                                fl_server_ai.notification.notification.Notification --> fl_server_ai.notification.training.training.TrainingNotification
                                fl_server_ai.notification.serializable.Serializable --> fl_server_ai.notification.notification.Notification
                




              click fl_server_ai.notification.training.finished.TrainingFinishedNotification href "" "fl_server_ai.notification.training.finished.TrainingFinishedNotification"
              click fl_server_ai.notification.training.training.TrainingNotification href "" "fl_server_ai.notification.training.training.TrainingNotification"
              click fl_server_ai.notification.notification.Notification href "" "fl_server_ai.notification.notification.Notification"
              click fl_server_ai.notification.serializable.Serializable href "" "fl_server_ai.notification.serializable.Serializable"
            

Notification that a training has finished.

Classes:

Methods:

Attributes:

14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

class TrainingFinishedNotification(TrainingNotification["TrainingFinishedNotification.Body"]):
    """
    Notification that a training has finished.
    """

    type: NotificationType = NotificationType.TRAINING_FINISHED
    """The type of the notification."""

    @dataclass
    class Body(Serializable):
        """
        Inner class representing the body of the notification.
        """
        global_model_uuid: UUID
        """The UUID of the global model."""

    @classmethod
    def from_training(cls, training: TrainingDB):
        """
        Create a `TrainingFinishedNotification` instance from a training object.

        Args:
            training (TrainingDB): The training object to create the notification from.

        Returns:
            TrainingFinishedNotification: The created notification.
        """
        receivers = list(training.participants.all())
        if not receivers.__contains__(training.actor):
            receivers.append(training.actor)
        return cls(
            receivers=receivers,
            body=cls.Body(
                global_model_uuid=training.model.id
            ),
            training_uuid=training.id
        )

type: NotificationType = TRAINING_FINISHED

              flowchart TD
              fl_server_ai.notification.training.finished.TrainingFinishedNotification.Body[Body]
              fl_server_ai.notification.serializable.Serializable[Serializable]

                              fl_server_ai.notification.serializable.Serializable --> fl_server_ai.notification.training.finished.TrainingFinishedNotification.Body
                


              click fl_server_ai.notification.training.finished.TrainingFinishedNotification.Body href "" "fl_server_ai.notification.training.finished.TrainingFinishedNotification.Body"
              click fl_server_ai.notification.serializable.Serializable href "" "fl_server_ai.notification.serializable.Serializable"
            

22
23
24
25
26
27
28

@dataclass
class Body(Serializable):
    """
    Inner class representing the body of the notification.
    """
    global_model_uuid: UUID
    """The UUID of the global model."""

global_model_uuid: UUID

__init__(global_model_uuid: UUID) -> None

from_training(training: Training)

30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

@classmethod
def from_training(cls, training: TrainingDB):
    """
    Create a `TrainingFinishedNotification` instance from a training object.

    Args:
        training (TrainingDB): The training object to create the notification from.

    Returns:
        TrainingFinishedNotification: The created notification.
    """
    receivers = list(training.participants.all())
    if not receivers.__contains__(training.actor):
        receivers.append(training.actor)
    return cls(
        receivers=receivers,
        body=cls.Body(
            global_model_uuid=training.model.id
        ),
        training_uuid=training.id
    )