Skip to content

Base FL Task Classes

Base FL Task

BaseFLTask

Bases: BaseModel, ABC

Source code in src/fed_rag/base/fl_task.py 
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
class BaseFLTask(BaseModel, ABC):
    model_config = ConfigDict(arbitrary_types_allowed=True)

    @property
    @abstractmethod
    def training_loop(self) -> Callable:
        ...

    @classmethod
    @abstractmethod
    def from_configs(
        cls, trainer_cfg: BaseFLTaskConfig, tester_cfg: Any
    ) -> Self:
        ...

    @classmethod
    @abstractmethod
    def from_trainer_and_tester(
        cls, trainer: Callable, tester: Callable
    ) -> Self:
        try:
            trainer_cfg = getattr(trainer, "__fl_task_trainer_config")
        except AttributeError:
            msg = (
                "`__fl_task_trainer_config` has not been set on training loop. Make "
                "sure to decorate your training loop with the appropriate "
                "decorator."
            )
            raise MissingFLTaskConfig(msg)

        try:
            tester_cfg = getattr(tester, "__fl_task_tester_config")
        except AttributeError:
            msg = (
                "`__fl_task_tester_config` has not been set on tester callable. Make "
                "sure to decorate your tester with the appropriate decorator."
            )
            raise MissingFLTaskConfig(msg)
        return cls.from_configs(trainer_cfg, tester_cfg)

    @abstractmethod
    def simulate(self, num_clients: int, **kwargs: Any) -> Any:
        """Simulate the FL task.

        Either use flwr's simulation tools, or create our own here.
        """
        ...

    @abstractmethod
    def server(self, **kwargs: Any) -> Server:
        """Create a flwr.Server object."""
        ...

    @abstractmethod
    def client(self, **kwargs: Any) -> Client:
        """Create a flwr.Client object."""
        ...

simulate abstractmethod 

simulate(num_clients, **kwargs)

Simulate the FL task.

Either use flwr's simulation tools, or create our own here.

Source code in src/fed_rag/base/fl_task.py 
58
59
60
61
62
63
64
@abstractmethod
def simulate(self, num_clients: int, **kwargs: Any) -> Any:
    """Simulate the FL task.

    Either use flwr's simulation tools, or create our own here.
    """
    ...

server abstractmethod 

server(**kwargs)

Create a flwr.Server object.

Source code in src/fed_rag/base/fl_task.py 
66
67
68
69
@abstractmethod
def server(self, **kwargs: Any) -> Server:
    """Create a flwr.Server object."""
    ...

client abstractmethod 

client(**kwargs)

Create a flwr.Client object.

Source code in src/fed_rag/base/fl_task.py 
71
72
73
74
@abstractmethod
def client(self, **kwargs: Any) -> Client:
    """Create a flwr.Client object."""
    ...

BaseFLTaskConfig

Bases: BaseModel

Source code in src/fed_rag/base/fl_task.py 
14
15
class BaseFLTaskConfig(BaseModel):
    pass