Skip to content

fl_server_ai.trainer.options

Classes:

Name Description
TrainerOptions

Trainer options including their default values.

Classes

TrainerOptions dataclass

Trainer options including their default values.

Used by:

Methods:

Name Description
__init__

Attributes:

Name Type Description
delete_local_models_after_aggregation bool

Flag indicating if local models should be deleted after aggregation.
model_test_after_each_round bool

Flag indicating if a model test should be performed after each round.
skip_model_tests bool

Flag indicating if model tests should be skipped.
Source code in fl_server_ai/trainer/options.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
@dataclass
class TrainerOptions:
    """
    Trainer options including their default values.
    """

    skip_model_tests: bool = False
    """Flag indicating if model tests should be skipped."""
    model_test_after_each_round: bool = True
    """Flag indicating if a model test should be performed after each round."""
    delete_local_models_after_aggregation: bool = True
    """Flag indicating if local models should be deleted after aggregation."""

Attributes

delete_local_models_after_aggregation class-attribute instance-attribute 
delete_local_models_after_aggregation: bool = True

Flag indicating if local models should be deleted after aggregation.

model_test_after_each_round class-attribute instance-attribute 
model_test_after_each_round: bool = True

Flag indicating if a model test should be performed after each round.

skip_model_tests class-attribute instance-attribute 
skip_model_tests: bool = False

Flag indicating if model tests should be skipped.

Functions

__init__ 
__init__(skip_model_tests: bool = False, model_test_after_each_round: bool = True, delete_local_models_after_aggregation: bool = True) -> None