flwr 1.16.0__py3-none-any.whl → 1.18.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- flwr/__init__.py +1 -1
- flwr/cli/__init__.py +1 -1
- flwr/cli/app.py +21 -2
- flwr/cli/build.py +1 -1
- flwr/cli/cli_user_auth_interceptor.py +1 -1
- flwr/cli/config_utils.py +53 -17
- flwr/cli/example.py +1 -1
- flwr/cli/install.py +1 -1
- flwr/cli/log.py +1 -1
- flwr/cli/login/__init__.py +1 -1
- flwr/cli/login/login.py +12 -1
- flwr/cli/ls.py +1 -1
- flwr/cli/new/__init__.py +1 -1
- flwr/cli/new/new.py +4 -4
- flwr/cli/new/templates/__init__.py +1 -1
- flwr/cli/new/templates/app/__init__.py +1 -1
- flwr/cli/new/templates/app/code/__init__.py +1 -1
- flwr/cli/new/templates/app/code/flwr_tune/__init__.py +1 -1
- flwr/cli/new/templates/app/code/flwr_tune/client_app.py.tpl +5 -5
- flwr/cli/new/templates/app/code/task.sklearn.py.tpl +1 -1
- flwr/cli/new/templates/app/pyproject.baseline.toml.tpl +1 -1
- flwr/cli/new/templates/app/pyproject.flowertune.toml.tpl +4 -4
- flwr/cli/new/templates/app/pyproject.huggingface.toml.tpl +1 -1
- flwr/cli/new/templates/app/pyproject.jax.toml.tpl +1 -1
- flwr/cli/new/templates/app/pyproject.mlx.toml.tpl +1 -1
- flwr/cli/new/templates/app/pyproject.numpy.toml.tpl +1 -1
- flwr/cli/new/templates/app/pyproject.pytorch.toml.tpl +1 -1
- flwr/cli/new/templates/app/pyproject.sklearn.toml.tpl +1 -1
- flwr/cli/new/templates/app/pyproject.tensorflow.toml.tpl +1 -1
- flwr/cli/run/__init__.py +1 -1
- flwr/cli/run/run.py +6 -10
- flwr/cli/stop.py +1 -1
- flwr/cli/utils.py +11 -12
- flwr/client/__init__.py +1 -1
- flwr/client/app.py +58 -56
- flwr/client/client.py +1 -1
- flwr/client/client_app.py +231 -166
- flwr/client/clientapp/__init__.py +1 -1
- flwr/client/clientapp/app.py +3 -3
- flwr/client/clientapp/clientappio_servicer.py +1 -1
- flwr/client/clientapp/utils.py +1 -1
- flwr/client/dpfedavg_numpy_client.py +1 -1
- flwr/client/grpc_adapter_client/__init__.py +1 -1
- flwr/client/grpc_adapter_client/connection.py +1 -1
- flwr/client/grpc_client/__init__.py +1 -1
- flwr/client/grpc_client/connection.py +37 -34
- flwr/client/grpc_rere_client/__init__.py +1 -1
- flwr/client/grpc_rere_client/client_interceptor.py +1 -1
- flwr/client/grpc_rere_client/connection.py +1 -1
- flwr/client/grpc_rere_client/grpc_adapter.py +1 -1
- flwr/client/heartbeat.py +1 -1
- flwr/client/message_handler/__init__.py +1 -1
- flwr/client/message_handler/message_handler.py +28 -28
- flwr/client/mod/__init__.py +3 -3
- flwr/client/mod/centraldp_mods.py +8 -8
- flwr/client/mod/comms_mods.py +17 -23
- flwr/client/mod/localdp_mod.py +10 -10
- flwr/client/mod/secure_aggregation/__init__.py +1 -1
- flwr/client/mod/secure_aggregation/secagg_mod.py +1 -1
- flwr/client/mod/secure_aggregation/secaggplus_mod.py +32 -32
- flwr/client/mod/utils.py +1 -1
- flwr/client/nodestate/__init__.py +1 -1
- flwr/client/nodestate/in_memory_nodestate.py +1 -1
- flwr/client/nodestate/nodestate.py +1 -1
- flwr/client/nodestate/nodestate_factory.py +1 -1
- flwr/client/numpy_client.py +1 -1
- flwr/client/rest_client/__init__.py +1 -1
- flwr/client/rest_client/connection.py +1 -1
- flwr/client/run_info_store.py +3 -3
- flwr/client/supernode/__init__.py +1 -1
- flwr/client/supernode/app.py +1 -1
- flwr/client/typing.py +1 -1
- flwr/common/__init__.py +13 -5
- flwr/common/address.py +1 -1
- flwr/common/args.py +1 -1
- flwr/common/auth_plugin/__init__.py +1 -1
- flwr/common/auth_plugin/auth_plugin.py +1 -1
- flwr/common/config.py +5 -5
- flwr/common/constant.py +7 -7
- flwr/common/context.py +5 -5
- flwr/common/date.py +1 -1
- flwr/common/differential_privacy.py +1 -1
- flwr/common/differential_privacy_constants.py +1 -1
- flwr/common/dp.py +1 -1
- flwr/common/event_log_plugin/event_log_plugin.py +3 -3
- flwr/common/exit/exit.py +6 -6
- flwr/common/exit_handlers.py +1 -1
- flwr/common/grpc.py +1 -1
- flwr/common/logger.py +3 -3
- flwr/common/message.py +344 -102
- flwr/common/object_ref.py +1 -1
- flwr/common/parameter.py +1 -1
- flwr/common/pyproject.py +1 -1
- flwr/common/record/__init__.py +9 -5
- flwr/common/record/arrayrecord.py +626 -0
- flwr/common/record/{configsrecord.py → configrecord.py} +83 -37
- flwr/common/record/conversion_utils.py +2 -2
- flwr/common/record/{metricsrecord.py → metricrecord.py} +90 -44
- flwr/common/record/recorddict.py +337 -0
- flwr/common/record/typeddict.py +1 -1
- flwr/common/recorddict_compat.py +410 -0
- flwr/common/retry_invoker.py +10 -10
- flwr/common/secure_aggregation/__init__.py +1 -1
- flwr/common/secure_aggregation/crypto/__init__.py +1 -1
- flwr/common/secure_aggregation/crypto/shamir.py +52 -30
- flwr/common/secure_aggregation/crypto/symmetric_encryption.py +1 -1
- flwr/common/secure_aggregation/ndarrays_arithmetic.py +1 -1
- flwr/common/secure_aggregation/quantization.py +1 -1
- flwr/common/secure_aggregation/secaggplus_constants.py +2 -2
- flwr/common/secure_aggregation/secaggplus_utils.py +1 -1
- flwr/common/serde.py +67 -72
- flwr/common/telemetry.py +2 -2
- flwr/common/typing.py +9 -9
- flwr/common/version.py +1 -1
- flwr/proto/__init__.py +1 -1
- flwr/proto/exec_pb2.py +3 -3
- flwr/proto/exec_pb2.pyi +3 -3
- flwr/proto/message_pb2.py +12 -12
- flwr/proto/message_pb2.pyi +9 -9
- flwr/proto/recorddict_pb2.py +70 -0
- flwr/proto/{recordset_pb2.pyi → recorddict_pb2.pyi} +35 -35
- flwr/proto/run_pb2.py +31 -31
- flwr/proto/run_pb2.pyi +3 -3
- flwr/server/__init__.py +4 -2
- flwr/server/app.py +67 -12
- flwr/server/client_manager.py +1 -1
- flwr/server/client_proxy.py +1 -1
- flwr/server/compat/__init__.py +3 -3
- flwr/server/compat/app.py +12 -12
- flwr/server/compat/app_utils.py +17 -17
- flwr/server/compat/{driver_client_proxy.py → grid_client_proxy.py} +39 -39
- flwr/server/compat/legacy_context.py +1 -1
- flwr/server/criterion.py +1 -1
- flwr/server/fleet_event_log_interceptor.py +94 -0
- flwr/server/{driver → grid}/__init__.py +8 -7
- flwr/server/{driver/driver.py → grid/grid.py} +48 -19
- flwr/server/{driver/grpc_driver.py → grid/grpc_grid.py} +87 -64
- flwr/server/{driver/inmemory_driver.py → grid/inmemory_grid.py} +24 -34
- flwr/server/history.py +1 -1
- flwr/server/run_serverapp.py +5 -5
- flwr/server/server.py +1 -1
- flwr/server/server_app.py +98 -71
- flwr/server/server_config.py +1 -1
- flwr/server/serverapp/__init__.py +1 -1
- flwr/server/serverapp/app.py +11 -11
- flwr/server/serverapp_components.py +1 -1
- flwr/server/strategy/__init__.py +1 -1
- flwr/server/strategy/aggregate.py +1 -1
- flwr/server/strategy/bulyan.py +2 -2
- flwr/server/strategy/dp_adaptive_clipping.py +17 -17
- flwr/server/strategy/dp_fixed_clipping.py +17 -17
- flwr/server/strategy/dpfedavg_adaptive.py +1 -1
- flwr/server/strategy/dpfedavg_fixed.py +1 -1
- flwr/server/strategy/fault_tolerant_fedavg.py +1 -1
- flwr/server/strategy/fedadagrad.py +1 -1
- flwr/server/strategy/fedadam.py +1 -1
- flwr/server/strategy/fedavg.py +1 -1
- flwr/server/strategy/fedavg_android.py +1 -1
- flwr/server/strategy/fedavgm.py +1 -1
- flwr/server/strategy/fedmedian.py +1 -1
- flwr/server/strategy/fedopt.py +1 -1
- flwr/server/strategy/fedprox.py +1 -1
- flwr/server/strategy/fedtrimmedavg.py +1 -1
- flwr/server/strategy/fedxgb_bagging.py +1 -1
- flwr/server/strategy/fedxgb_cyclic.py +1 -1
- flwr/server/strategy/fedxgb_nn_avg.py +3 -2
- flwr/server/strategy/fedyogi.py +1 -1
- flwr/server/strategy/krum.py +1 -1
- flwr/server/strategy/qfedavg.py +1 -1
- flwr/server/strategy/strategy.py +1 -1
- flwr/server/superlink/__init__.py +1 -1
- flwr/server/superlink/ffs/__init__.py +1 -1
- flwr/server/superlink/ffs/disk_ffs.py +1 -1
- flwr/server/superlink/ffs/ffs.py +1 -1
- flwr/server/superlink/ffs/ffs_factory.py +1 -1
- flwr/server/superlink/fleet/__init__.py +1 -1
- flwr/server/superlink/fleet/grpc_adapter/__init__.py +1 -1
- flwr/server/superlink/fleet/grpc_adapter/grpc_adapter_servicer.py +1 -1
- flwr/server/superlink/fleet/grpc_bidi/__init__.py +1 -1
- flwr/server/superlink/fleet/grpc_bidi/flower_service_servicer.py +1 -1
- flwr/server/superlink/fleet/grpc_bidi/grpc_bridge.py +1 -1
- flwr/server/superlink/fleet/grpc_bidi/grpc_client_proxy.py +1 -1
- flwr/server/superlink/fleet/grpc_bidi/grpc_server.py +13 -13
- flwr/server/superlink/fleet/grpc_rere/__init__.py +1 -1
- flwr/server/superlink/fleet/grpc_rere/fleet_servicer.py +1 -1
- flwr/server/superlink/fleet/grpc_rere/server_interceptor.py +1 -1
- flwr/server/superlink/fleet/message_handler/__init__.py +1 -1
- flwr/server/superlink/fleet/message_handler/message_handler.py +1 -1
- flwr/server/superlink/fleet/rest_rere/__init__.py +1 -1
- flwr/server/superlink/fleet/rest_rere/rest_api.py +1 -1
- flwr/server/superlink/fleet/vce/__init__.py +1 -1
- flwr/server/superlink/fleet/vce/backend/__init__.py +1 -1
- flwr/server/superlink/fleet/vce/backend/backend.py +3 -3
- flwr/server/superlink/fleet/vce/backend/raybackend.py +3 -3
- flwr/server/superlink/fleet/vce/vce_api.py +2 -4
- flwr/server/superlink/linkstate/__init__.py +1 -1
- flwr/server/superlink/linkstate/in_memory_linkstate.py +34 -9
- flwr/server/superlink/linkstate/linkstate.py +5 -5
- flwr/server/superlink/linkstate/linkstate_factory.py +1 -1
- flwr/server/superlink/linkstate/sqlite_linkstate.py +62 -28
- flwr/server/superlink/linkstate/utils.py +94 -28
- flwr/server/superlink/{driver → serverappio}/__init__.py +1 -1
- flwr/server/superlink/{driver → serverappio}/serverappio_grpc.py +1 -1
- flwr/server/superlink/{driver → serverappio}/serverappio_servicer.py +4 -4
- flwr/server/superlink/simulation/__init__.py +1 -1
- flwr/server/superlink/simulation/simulationio_grpc.py +1 -1
- flwr/server/superlink/simulation/simulationio_servicer.py +3 -3
- flwr/server/superlink/utils.py +1 -1
- flwr/server/typing.py +4 -4
- flwr/server/utils/__init__.py +1 -1
- flwr/server/utils/tensorboard.py +1 -1
- flwr/server/utils/validator.py +5 -5
- flwr/server/workflow/__init__.py +1 -1
- flwr/server/workflow/constant.py +1 -1
- flwr/server/workflow/default_workflows.py +49 -58
- flwr/server/workflow/secure_aggregation/__init__.py +1 -1
- flwr/server/workflow/secure_aggregation/secagg_workflow.py +1 -1
- flwr/server/workflow/secure_aggregation/secaggplus_workflow.py +49 -51
- flwr/simulation/__init__.py +1 -1
- flwr/simulation/app.py +3 -3
- flwr/simulation/legacy_app.py +1 -1
- flwr/simulation/ray_transport/__init__.py +1 -1
- flwr/simulation/ray_transport/ray_actor.py +5 -3
- flwr/simulation/ray_transport/ray_client_proxy.py +35 -33
- flwr/simulation/ray_transport/utils.py +1 -1
- flwr/simulation/run_simulation.py +17 -17
- flwr/simulation/simulationio_connection.py +1 -1
- flwr/superexec/__init__.py +1 -1
- flwr/superexec/app.py +1 -1
- flwr/superexec/deployment.py +5 -5
- flwr/superexec/exec_event_log_interceptor.py +135 -0
- flwr/superexec/exec_grpc.py +11 -5
- flwr/superexec/exec_servicer.py +3 -3
- flwr/superexec/exec_user_auth_interceptor.py +19 -3
- flwr/superexec/executor.py +4 -4
- flwr/superexec/simulation.py +4 -4
- {flwr-1.16.0.dist-info → flwr-1.18.0.dist-info}/METADATA +3 -3
- flwr-1.18.0.dist-info/RECORD +332 -0
- flwr/common/record/parametersrecord.py +0 -339
- flwr/common/record/recordset.py +0 -209
- flwr/common/recordset_compat.py +0 -418
- flwr/proto/recordset_pb2.py +0 -70
- flwr-1.16.0.dist-info/LICENSE +0 -202
- flwr-1.16.0.dist-info/RECORD +0 -331
- /flwr/proto/{recordset_pb2_grpc.py → recorddict_pb2_grpc.py} +0 -0
- /flwr/proto/{recordset_pb2_grpc.pyi → recorddict_pb2_grpc.pyi} +0 -0
- {flwr-1.16.0.dist-info → flwr-1.18.0.dist-info}/WHEEL +0 -0
- {flwr-1.16.0.dist-info → flwr-1.18.0.dist-info}/entry_points.txt +0 -0
flwr/server/server_app.py
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Copyright
|
|
1
|
+
# Copyright 2025 Flower Labs GmbH. All Rights Reserved.
|
|
2
2
|
#
|
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
# you may not use this file except in compliance with the License.
|
|
@@ -15,20 +15,18 @@
|
|
|
15
15
|
"""Flower ServerApp."""
|
|
16
16
|
|
|
17
17
|
|
|
18
|
+
import inspect
|
|
18
19
|
from collections.abc import Iterator
|
|
19
20
|
from contextlib import contextmanager
|
|
20
21
|
from typing import Callable, Optional
|
|
21
22
|
|
|
22
23
|
from flwr.common import Context
|
|
23
|
-
from flwr.common.logger import
|
|
24
|
-
warn_deprecated_feature_with_example,
|
|
25
|
-
warn_preview_feature,
|
|
26
|
-
)
|
|
24
|
+
from flwr.common.logger import warn_deprecated_feature_with_example
|
|
27
25
|
from flwr.server.strategy import Strategy
|
|
28
26
|
|
|
29
27
|
from .client_manager import ClientManager
|
|
30
|
-
from .compat import
|
|
31
|
-
from .
|
|
28
|
+
from .compat import start_grid
|
|
29
|
+
from .grid import Driver, Grid
|
|
32
30
|
from .server import Server
|
|
33
31
|
from .server_config import ServerConfig
|
|
34
32
|
from .typing import ServerAppCallable, ServerFn
|
|
@@ -46,6 +44,45 @@ SERVER_FN_USAGE_EXAMPLE = """
|
|
|
46
44
|
app = ServerApp(server_fn=server_fn)
|
|
47
45
|
"""
|
|
48
46
|
|
|
47
|
+
GRID_USAGE_EXAMPLE = """
|
|
48
|
+
app = ServerApp()
|
|
49
|
+
|
|
50
|
+
@app.main()
|
|
51
|
+
def main(grid: Grid, context: Context) -> None:
|
|
52
|
+
# Your existing ServerApp code ...
|
|
53
|
+
"""
|
|
54
|
+
|
|
55
|
+
BOTH_MAIN_FN_SERVER_FN_PROVIDED_ERROR_MSG = (
|
|
56
|
+
"Use either a custom main function or a `Strategy`, but not both."
|
|
57
|
+
"""
|
|
58
|
+
|
|
59
|
+
Use the `ServerApp` with an existing `Strategy`:
|
|
60
|
+
|
|
61
|
+
server_config = ServerConfig(num_rounds=3)
|
|
62
|
+
strategy = FedAvg()
|
|
63
|
+
|
|
64
|
+
app = ServerApp(
|
|
65
|
+
server_config=server_config,
|
|
66
|
+
strategy=strategy,
|
|
67
|
+
)
|
|
68
|
+
|
|
69
|
+
Use the `ServerApp` with a custom main function:
|
|
70
|
+
|
|
71
|
+
app = ServerApp()
|
|
72
|
+
|
|
73
|
+
@app.main()
|
|
74
|
+
def main(grid: Grid, context: Context) -> None:
|
|
75
|
+
print("ServerApp running")
|
|
76
|
+
"""
|
|
77
|
+
)
|
|
78
|
+
|
|
79
|
+
DRIVER_DEPRECATION_MSG = """
|
|
80
|
+
The `Driver` class is deprecated, it will be removed in a future release.
|
|
81
|
+
"""
|
|
82
|
+
DRIVER_EXAMPLE_MSG = """
|
|
83
|
+
Instead, use `Grid` in the signature of your `ServerApp`. For example:
|
|
84
|
+
"""
|
|
85
|
+
|
|
49
86
|
|
|
50
87
|
@contextmanager
|
|
51
88
|
def _empty_lifespan(_: Context) -> Iterator[None]:
|
|
@@ -57,25 +94,25 @@ class ServerApp: # pylint: disable=too-many-instance-attributes
|
|
|
57
94
|
|
|
58
95
|
Examples
|
|
59
96
|
--------
|
|
60
|
-
Use the
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
Use the
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
97
|
+
Use the ``ServerApp`` with an existing ``Strategy``::
|
|
98
|
+
|
|
99
|
+
def server_fn(context: Context):
|
|
100
|
+
server_config = ServerConfig(num_rounds=3)
|
|
101
|
+
strategy = FedAvg()
|
|
102
|
+
return ServerAppComponents(
|
|
103
|
+
strategy=strategy,
|
|
104
|
+
server_config=server_config,
|
|
105
|
+
)
|
|
106
|
+
|
|
107
|
+
app = ServerApp(server_fn=server_fn)
|
|
108
|
+
|
|
109
|
+
Use the ``ServerApp`` with a custom main function::
|
|
110
|
+
|
|
111
|
+
app = ServerApp()
|
|
112
|
+
|
|
113
|
+
@app.main()
|
|
114
|
+
def main(grid: Grid, context: Context) -> None:
|
|
115
|
+
print("ServerApp running")
|
|
79
116
|
"""
|
|
80
117
|
|
|
81
118
|
# pylint: disable=too-many-arguments,too-many-positional-arguments
|
|
@@ -114,7 +151,7 @@ class ServerApp: # pylint: disable=too-many-instance-attributes
|
|
|
114
151
|
self._main: Optional[ServerAppCallable] = None
|
|
115
152
|
self._lifespan = _empty_lifespan
|
|
116
153
|
|
|
117
|
-
def __call__(self,
|
|
154
|
+
def __call__(self, grid: Grid, context: Context) -> None:
|
|
118
155
|
"""Execute `ServerApp`."""
|
|
119
156
|
with self._lifespan(context):
|
|
120
157
|
# Compatibility mode
|
|
@@ -126,58 +163,47 @@ class ServerApp: # pylint: disable=too-many-instance-attributes
|
|
|
126
163
|
self._config = components.config
|
|
127
164
|
self._strategy = components.strategy
|
|
128
165
|
self._client_manager = components.client_manager
|
|
129
|
-
|
|
166
|
+
start_grid(
|
|
130
167
|
server=self._server,
|
|
131
168
|
config=self._config,
|
|
132
169
|
strategy=self._strategy,
|
|
133
170
|
client_manager=self._client_manager,
|
|
134
|
-
|
|
171
|
+
grid=grid,
|
|
135
172
|
)
|
|
136
173
|
return
|
|
137
174
|
|
|
138
175
|
# New execution mode
|
|
139
|
-
self._main(
|
|
176
|
+
self._main(grid, context)
|
|
140
177
|
|
|
141
178
|
def main(self) -> Callable[[ServerAppCallable], ServerAppCallable]:
|
|
142
179
|
"""Return a decorator that registers the main fn with the server app.
|
|
143
180
|
|
|
144
181
|
Examples
|
|
145
182
|
--------
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
183
|
+
::
|
|
184
|
+
|
|
185
|
+
app = ServerApp()
|
|
186
|
+
|
|
187
|
+
@app.main()
|
|
188
|
+
def main(grid: Grid, context: Context) -> None:
|
|
189
|
+
print("ServerApp running")
|
|
151
190
|
"""
|
|
152
191
|
|
|
153
192
|
def main_decorator(main_fn: ServerAppCallable) -> ServerAppCallable:
|
|
154
193
|
"""Register the main fn with the ServerApp object."""
|
|
155
194
|
if self._server or self._config or self._strategy or self._client_manager:
|
|
156
|
-
raise ValueError(
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
>>> strategy=strategy,
|
|
167
|
-
>>> )
|
|
168
|
-
|
|
169
|
-
Use the `ServerApp` with a custom main function:
|
|
170
|
-
|
|
171
|
-
>>> app = ServerApp()
|
|
172
|
-
>>>
|
|
173
|
-
>>> @app.main()
|
|
174
|
-
>>> def main(driver: Driver, context: Context) -> None:
|
|
175
|
-
>>> print("ServerApp running")
|
|
176
|
-
""",
|
|
195
|
+
raise ValueError(BOTH_MAIN_FN_SERVER_FN_PROVIDED_ERROR_MSG)
|
|
196
|
+
|
|
197
|
+
sig = inspect.signature(main_fn)
|
|
198
|
+
param = list(sig.parameters.values())[0]
|
|
199
|
+
# Check if parameter name or the annotation should be updated
|
|
200
|
+
if param.name == "driver" or param.annotation is Driver:
|
|
201
|
+
warn_deprecated_feature_with_example(
|
|
202
|
+
deprecation_message=DRIVER_DEPRECATION_MSG,
|
|
203
|
+
example_message=DRIVER_EXAMPLE_MSG,
|
|
204
|
+
code_example=GRID_USAGE_EXAMPLE,
|
|
177
205
|
)
|
|
178
206
|
|
|
179
|
-
warn_preview_feature("ServerApp-register-main-function")
|
|
180
|
-
|
|
181
207
|
# Register provided function with the ServerApp object
|
|
182
208
|
self._main = main_fn
|
|
183
209
|
|
|
@@ -198,24 +224,25 @@ class ServerApp: # pylint: disable=too-many-instance-attributes
|
|
|
198
224
|
|
|
199
225
|
Examples
|
|
200
226
|
--------
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
227
|
+
::
|
|
228
|
+
|
|
229
|
+
app = ServerApp()
|
|
230
|
+
|
|
231
|
+
@app.lifespan()
|
|
232
|
+
def lifespan(context: Context) -> None:
|
|
233
|
+
# Perform initialization tasks before the app starts
|
|
234
|
+
print("Initializing ServerApp")
|
|
235
|
+
|
|
236
|
+
yield # ServerApp is running
|
|
237
|
+
|
|
238
|
+
# Perform cleanup tasks after the app stops
|
|
239
|
+
print("Cleaning up ServerApp")
|
|
212
240
|
"""
|
|
213
241
|
|
|
214
242
|
def lifespan_decorator(
|
|
215
|
-
lifespan_fn: Callable[[Context], Iterator[None]]
|
|
243
|
+
lifespan_fn: Callable[[Context], Iterator[None]],
|
|
216
244
|
) -> Callable[[Context], Iterator[None]]:
|
|
217
245
|
"""Register the lifespan fn with the ServerApp object."""
|
|
218
|
-
warn_preview_feature("ServerApp-register-lifespan-function")
|
|
219
246
|
|
|
220
247
|
@contextmanager
|
|
221
248
|
def decorated_lifespan(context: Context) -> Iterator[None]:
|
flwr/server/server_config.py
CHANGED
flwr/server/serverapp/app.py
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Copyright
|
|
1
|
+
# Copyright 2025 Flower Labs GmbH. All Rights Reserved.
|
|
2
2
|
#
|
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
# you may not use this file except in compliance with the License.
|
|
@@ -60,7 +60,7 @@ from flwr.proto.serverappio_pb2 import ( # pylint: disable=E0611
|
|
|
60
60
|
PullServerAppInputsResponse,
|
|
61
61
|
PushServerAppOutputsRequest,
|
|
62
62
|
)
|
|
63
|
-
from flwr.server.
|
|
63
|
+
from flwr.server.grid.grpc_grid import GrpcGrid
|
|
64
64
|
from flwr.server.run_serverapp import run as run_
|
|
65
65
|
|
|
66
66
|
|
|
@@ -106,7 +106,7 @@ def run_serverapp( # pylint: disable=R0914, disable=W0212, disable=R0915
|
|
|
106
106
|
certificates: Optional[bytes] = None,
|
|
107
107
|
) -> None:
|
|
108
108
|
"""Run Flower ServerApp process."""
|
|
109
|
-
|
|
109
|
+
grid = GrpcGrid(
|
|
110
110
|
serverappio_service_address=serverappio_api_address,
|
|
111
111
|
root_certificates=certificates,
|
|
112
112
|
)
|
|
@@ -123,7 +123,7 @@ def run_serverapp( # pylint: disable=R0914, disable=W0212, disable=R0915
|
|
|
123
123
|
# Pull ServerAppInputs from LinkState
|
|
124
124
|
req = PullServerAppInputsRequest()
|
|
125
125
|
log(DEBUG, "[flwr-serverapp] Pull ServerAppInputs")
|
|
126
|
-
res: PullServerAppInputsResponse =
|
|
126
|
+
res: PullServerAppInputsResponse = grid._stub.PullServerAppInputs(req)
|
|
127
127
|
if not res.HasField("run"):
|
|
128
128
|
sleep(3)
|
|
129
129
|
run_status = None
|
|
@@ -135,14 +135,14 @@ def run_serverapp( # pylint: disable=R0914, disable=W0212, disable=R0915
|
|
|
135
135
|
|
|
136
136
|
hash_run_id = get_sha256_hash(run.run_id)
|
|
137
137
|
|
|
138
|
-
|
|
138
|
+
grid.set_run(run.run_id)
|
|
139
139
|
|
|
140
140
|
# Start log uploader for this run
|
|
141
141
|
log_uploader = start_log_uploader(
|
|
142
142
|
log_queue=log_queue,
|
|
143
143
|
node_id=0,
|
|
144
144
|
run_id=run.run_id,
|
|
145
|
-
stub=
|
|
145
|
+
stub=grid._stub,
|
|
146
146
|
)
|
|
147
147
|
|
|
148
148
|
log(DEBUG, "[flwr-serverapp] Start FAB installation.")
|
|
@@ -173,7 +173,7 @@ def run_serverapp( # pylint: disable=R0914, disable=W0212, disable=R0915
|
|
|
173
173
|
|
|
174
174
|
# Change status to Running
|
|
175
175
|
run_status_proto = run_status_to_proto(RunStatus(Status.RUNNING, "", ""))
|
|
176
|
-
|
|
176
|
+
grid._stub.UpdateRunStatus(
|
|
177
177
|
UpdateRunStatusRequest(run_id=run.run_id, run_status=run_status_proto)
|
|
178
178
|
)
|
|
179
179
|
|
|
@@ -182,9 +182,9 @@ def run_serverapp( # pylint: disable=R0914, disable=W0212, disable=R0915
|
|
|
182
182
|
event_details={"run-id-hash": hash_run_id},
|
|
183
183
|
)
|
|
184
184
|
|
|
185
|
-
# Load and run the ServerApp with the
|
|
185
|
+
# Load and run the ServerApp with the Grid
|
|
186
186
|
updated_context = run_(
|
|
187
|
-
|
|
187
|
+
grid=grid,
|
|
188
188
|
server_app_dir=app_path,
|
|
189
189
|
server_app_attr=server_app_attr,
|
|
190
190
|
context=context,
|
|
@@ -196,7 +196,7 @@ def run_serverapp( # pylint: disable=R0914, disable=W0212, disable=R0915
|
|
|
196
196
|
out_req = PushServerAppOutputsRequest(
|
|
197
197
|
run_id=run.run_id, context=context_proto
|
|
198
198
|
)
|
|
199
|
-
_ =
|
|
199
|
+
_ = grid._stub.PushServerAppOutputs(out_req)
|
|
200
200
|
|
|
201
201
|
run_status = RunStatus(Status.FINISHED, SubStatus.COMPLETED, "")
|
|
202
202
|
except RunNotRunningException:
|
|
@@ -221,7 +221,7 @@ def run_serverapp( # pylint: disable=R0914, disable=W0212, disable=R0915
|
|
|
221
221
|
# Update run status
|
|
222
222
|
if run_status:
|
|
223
223
|
run_status_proto = run_status_to_proto(run_status)
|
|
224
|
-
|
|
224
|
+
grid._stub.UpdateRunStatus(
|
|
225
225
|
UpdateRunStatusRequest(
|
|
226
226
|
run_id=run.run_id, run_status=run_status_proto
|
|
227
227
|
)
|
flwr/server/strategy/__init__.py
CHANGED
flwr/server/strategy/bulyan.py
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Copyright
|
|
1
|
+
# Copyright 2025 Flower Labs GmbH. All Rights Reserved.
|
|
2
2
|
#
|
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
# you may not use this file except in compliance with the License.
|
|
@@ -37,7 +37,7 @@ from .aggregate import aggregate_bulyan, aggregate_krum
|
|
|
37
37
|
from .fedavg import FedAvg
|
|
38
38
|
|
|
39
39
|
|
|
40
|
-
#
|
|
40
|
+
# noqa: E501
|
|
41
41
|
# pylint: disable=line-too-long
|
|
42
42
|
class Bulyan(FedAvg):
|
|
43
43
|
"""Bulyan strategy.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Copyright
|
|
1
|
+
# Copyright 2025 Flower Labs GmbH. All Rights Reserved.
|
|
2
2
|
#
|
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
# you may not use this file except in compliance with the License.
|
|
@@ -77,15 +77,15 @@ class DifferentialPrivacyServerSideAdaptiveClipping(Strategy):
|
|
|
77
77
|
|
|
78
78
|
Examples
|
|
79
79
|
--------
|
|
80
|
-
Create a strategy
|
|
80
|
+
Create a strategy::
|
|
81
81
|
|
|
82
|
-
|
|
82
|
+
strategy = fl.server.strategy.FedAvg( ... )
|
|
83
83
|
|
|
84
|
-
Wrap the strategy with the DifferentialPrivacyServerSideAdaptiveClipping wrapper
|
|
84
|
+
Wrap the strategy with the DifferentialPrivacyServerSideAdaptiveClipping wrapper::
|
|
85
85
|
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
86
|
+
dp_strategy = DifferentialPrivacyServerSideAdaptiveClipping(
|
|
87
|
+
strategy, cfg.noise_multiplier, cfg.num_sampled_clients, ...
|
|
88
|
+
)
|
|
89
89
|
"""
|
|
90
90
|
|
|
91
91
|
# pylint: disable=too-many-arguments,too-many-instance-attributes,too-many-positional-arguments
|
|
@@ -290,21 +290,21 @@ class DifferentialPrivacyClientSideAdaptiveClipping(Strategy):
|
|
|
290
290
|
|
|
291
291
|
Examples
|
|
292
292
|
--------
|
|
293
|
-
Create a strategy
|
|
293
|
+
Create a strategy::
|
|
294
294
|
|
|
295
|
-
|
|
295
|
+
strategy = fl.server.strategy.FedAvg(...)
|
|
296
296
|
|
|
297
|
-
Wrap the strategy with the `DifferentialPrivacyClientSideAdaptiveClipping` wrapper
|
|
297
|
+
Wrap the strategy with the `DifferentialPrivacyClientSideAdaptiveClipping` wrapper::
|
|
298
298
|
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
299
|
+
dp_strategy = DifferentialPrivacyClientSideAdaptiveClipping(
|
|
300
|
+
strategy, cfg.noise_multiplier, cfg.num_sampled_clients
|
|
301
|
+
)
|
|
302
302
|
|
|
303
|
-
On the client, add the `adaptiveclipping_mod` to the client-side mods
|
|
303
|
+
On the client, add the `adaptiveclipping_mod` to the client-side mods::
|
|
304
304
|
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
305
|
+
app = fl.client.ClientApp(
|
|
306
|
+
client_fn=client_fn, mods=[adaptiveclipping_mod]
|
|
307
|
+
)
|
|
308
308
|
"""
|
|
309
309
|
|
|
310
310
|
# pylint: disable=too-many-arguments,too-many-instance-attributes,too-many-positional-arguments
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Copyright
|
|
1
|
+
# Copyright 2025 Flower Labs GmbH. All Rights Reserved.
|
|
2
2
|
#
|
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
# you may not use this file except in compliance with the License.
|
|
@@ -64,15 +64,15 @@ class DifferentialPrivacyServerSideFixedClipping(Strategy):
|
|
|
64
64
|
|
|
65
65
|
Examples
|
|
66
66
|
--------
|
|
67
|
-
Create a strategy
|
|
67
|
+
Create a strategy::
|
|
68
68
|
|
|
69
|
-
|
|
69
|
+
strategy = fl.server.strategy.FedAvg( ... )
|
|
70
70
|
|
|
71
|
-
Wrap the strategy with the DifferentialPrivacyServerSideFixedClipping wrapper
|
|
71
|
+
Wrap the strategy with the DifferentialPrivacyServerSideFixedClipping wrapper::
|
|
72
72
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
73
|
+
dp_strategy = DifferentialPrivacyServerSideFixedClipping(
|
|
74
|
+
strategy, cfg.noise_multiplier, cfg.clipping_norm, cfg.num_sampled_clients
|
|
75
|
+
)
|
|
76
76
|
"""
|
|
77
77
|
|
|
78
78
|
# pylint: disable=too-many-arguments,too-many-instance-attributes
|
|
@@ -228,21 +228,21 @@ class DifferentialPrivacyClientSideFixedClipping(Strategy):
|
|
|
228
228
|
|
|
229
229
|
Examples
|
|
230
230
|
--------
|
|
231
|
-
Create a strategy
|
|
231
|
+
Create a strategy::
|
|
232
232
|
|
|
233
|
-
|
|
233
|
+
strategy = fl.server.strategy.FedAvg(...)
|
|
234
234
|
|
|
235
|
-
Wrap the strategy with the `DifferentialPrivacyClientSideFixedClipping` wrapper
|
|
235
|
+
Wrap the strategy with the `DifferentialPrivacyClientSideFixedClipping` wrapper::
|
|
236
236
|
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
237
|
+
dp_strategy = DifferentialPrivacyClientSideFixedClipping(
|
|
238
|
+
strategy, cfg.noise_multiplier, cfg.clipping_norm, cfg.num_sampled_clients
|
|
239
|
+
)
|
|
240
240
|
|
|
241
|
-
On the client, add the `fixedclipping_mod` to the client-side mods
|
|
241
|
+
On the client, add the `fixedclipping_mod` to the client-side mods::
|
|
242
242
|
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
243
|
+
app = fl.client.ClientApp(
|
|
244
|
+
client_fn=client_fn, mods=[fixedclipping_mod]
|
|
245
|
+
)
|
|
246
246
|
"""
|
|
247
247
|
|
|
248
248
|
# pylint: disable=too-many-arguments,too-many-instance-attributes
|
flwr/server/strategy/fedadam.py
CHANGED
flwr/server/strategy/fedavg.py
CHANGED
flwr/server/strategy/fedavgm.py
CHANGED
flwr/server/strategy/fedopt.py
CHANGED
flwr/server/strategy/fedprox.py
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Copyright
|
|
1
|
+
# Copyright 2025 Flower Labs GmbH. All Rights Reserved.
|
|
2
2
|
#
|
|
3
3
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
4
|
# you may not use this file except in compliance with the License.
|
|
@@ -44,7 +44,8 @@ class FedXgbNnAvg(FedAvg):
|
|
|
44
44
|
def __init__(self, *args: Any, **kwargs: Any) -> None:
|
|
45
45
|
"""Federated XGBoost [Ma et al., 2023] strategy.
|
|
46
46
|
|
|
47
|
-
Implementation based on
|
|
47
|
+
Implementation based on
|
|
48
|
+
https://arxiv.org/abs/2304.07537.
|
|
48
49
|
"""
|
|
49
50
|
super().__init__(*args, **kwargs)
|
|
50
51
|
warn_deprecated_feature("`FedXgbNnAvg` strategy")
|
flwr/server/strategy/fedyogi.py
CHANGED
flwr/server/strategy/krum.py
CHANGED
flwr/server/strategy/qfedavg.py
CHANGED
flwr/server/strategy/strategy.py
CHANGED