fl_server_ai.notification.training.start ¶
Classes:
| Name | Description |
|---|---|
TrainingStartNotification | Class representing a notification for the start of a training. |
Classes¶
TrainingStartNotification dataclass ¶
Bases: TrainingNotification['TrainingStartNotification.Body']
flowchart TD
fl_server_ai.notification.training.start.TrainingStartNotification[TrainingStartNotification]
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.start.TrainingStartNotification
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.start.TrainingStartNotification href "" "fl_server_ai.notification.training.start.TrainingStartNotification"
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"
Class representing a notification for the start of a training.
Classes:
| Name | Description |
|---|---|
Body | Inner class representing the body of the notification. |
Methods:
| Name | Description |
|---|---|
from_training | Create a |
Attributes:
| Name | Type | Description |
|---|---|---|
type | NotificationType | The type of the notification. |
Source code in fl_server_ai/notification/training/start.py
Attributes¶
type class-attribute instance-attribute ¶
type: NotificationType = TRAINING_START
The type of the notification.
Classes¶
Body dataclass ¶
Bases: Serializable
flowchart TD
fl_server_ai.notification.training.start.TrainingStartNotification.Body[Body]
fl_server_ai.notification.serializable.Serializable[Serializable]
fl_server_ai.notification.serializable.Serializable --> fl_server_ai.notification.training.start.TrainingStartNotification.Body
click fl_server_ai.notification.training.start.TrainingStartNotification.Body href "" "fl_server_ai.notification.training.start.TrainingStartNotification.Body"
click fl_server_ai.notification.serializable.Serializable href "" "fl_server_ai.notification.serializable.Serializable"
Inner class representing the body of the notification.
Methods:
| Name | Description |
|---|---|
__init__ | |
Attributes:
| Name | Type | Description |
|---|---|---|
global_model_uuid | UUID | The UUID of the global model. |
Source code in fl_server_ai/notification/training/start.py
Functions¶
from_training classmethod ¶
Create a TrainingStartNotification instance from a training object.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| Training | The training object to create the notification from. | required |
Returns:
| Name | Type | Description |
|---|---|---|
TrainingStartNotification | The created notification. |