实施策略¶
策略抽象类可以实现完全定制的策略。策略基本上就是在服务器上运行的联邦学习算法。策略决定如何对客户端进行采样、如何配置客户端进行训练、如何聚合参数更新以及如何评估模型。Flower 提供了一些内置策略,这些策略基于下文所述的相同 API。
The Strategy
abstraction¶
All strategy implementation are derived from the abstract base class
flwr.server.strategy.Strategy
, both built-in implementations and third party
implementations. This means that custom strategy implementations have the exact same
capabilities at their disposal as built-in ones.
策略抽象定义了一些需要实现的抽象方法:
class Strategy(ABC):
"""Abstract base class for server strategy implementations."""
@abstractmethod
def initialize_parameters(
self, client_manager: ClientManager
) -> Optional[Parameters]:
"""Initialize the (global) model parameters."""
@abstractmethod
def configure_fit(
self, server_round: int, parameters: Parameters, client_manager: ClientManager
) -> List[Tuple[ClientProxy, FitIns]]:
"""Configure the next round of training."""
@abstractmethod
def aggregate_fit(
self,
server_round: int,
results: List[Tuple[ClientProxy, FitRes]],
failures: List[Union[Tuple[ClientProxy, FitRes], BaseException]],
) -> Tuple[Optional[Parameters], Dict[str, Scalar]]:
"""Aggregate training results."""
@abstractmethod
def configure_evaluate(
self, server_round: int, parameters: Parameters, client_manager: ClientManager
) -> List[Tuple[ClientProxy, EvaluateIns]]:
"""Configure the next round of evaluation."""
@abstractmethod
def aggregate_evaluate(
self,
server_round: int,
results: List[Tuple[ClientProxy, EvaluateRes]],
failures: List[Union[Tuple[ClientProxy, FitRes], BaseException]],
) -> Tuple[Optional[float], Dict[str, Scalar]]:
"""Aggregate evaluation results."""
@abstractmethod
def evaluate(
self, parameters: Parameters
) -> Optional[Tuple[float, Dict[str, Scalar]]]:
"""Evaluate the current model parameters."""
Creating a new strategy means implementing a new class
(derived from the abstract
base class Strategy
) that implements for the previously shown abstract methods:
class SotaStrategy(Strategy):
def initialize_parameters(self, client_manager):
# Your implementation here
pass
def configure_fit(self, server_round, parameters, client_manager):
# Your implementation here
pass
def aggregate_fit(self, server_round, results, failures):
# Your implementation here
pass
def configure_evaluate(self, server_round, parameters, client_manager):
# Your implementation here
pass
def aggregate_evaluate(self, server_round, results, failures):
# Your implementation here
pass
def evaluate(self, parameters):
# Your implementation here
pass
Flower 服务器按以下顺序调用这些方法:
下文将详细介绍每种方法。
The initialize_parameters
method¶
initialize_parameters
is called only once, at the very beginning of an execution. It
is responsible for providing the initial global model parameters in a serialized form
(i.e., as a Parameters
object).
Built-in strategies return user-provided initial parameters. The following example shows
how initial parameters can be passed to FedAvg
:
import flwr as fl
import tensorflow as tf
# Load model for server-side parameter initialization
model = tf.keras.applications.EfficientNetB0(
input_shape=(32, 32, 3), weights=None, classes=10
)
model.compile("adam", "sparse_categorical_crossentropy", metrics=["accuracy"])
# Get model weights as a list of NumPy ndarray's
weights = model.get_weights()
# Serialize ndarrays to `Parameters`
parameters = fl.common.ndarrays_to_parameters(weights)
# Use the serialized parameters as the initial global parameters
strategy = fl.server.strategy.FedAvg(
initial_parameters=parameters,
)
fl.server.start_server(config=fl.server.ServerConfig(num_rounds=3), strategy=strategy)
The Flower server will call initialize_parameters
, which either returns the
parameters that were passed to initial_parameters
, or None
. If no parameters are
returned from initialize_parameters
(i.e., None
), the server will randomly
select one client and ask it to provide its parameters. This is a convenience feature
and not recommended in practice, but it can be useful for prototyping. In practice, it
is recommended to always use server-side parameter initialization.
Note
服务器端参数初始化是一种强大的机制。例如,它可以用来从先前保存的检查点恢复训练。它也是实现混合方法所需的基本能力,例如,使用联邦学习对预先训练好的模型进行微调。
The configure_fit
method¶
configure_fit
is responsible for configuring the upcoming round of training. What
does configure mean in this context? Configuring a round means selecting clients and
deciding what instructions to send to these clients. The signature of configure_fit
makes this clear:
@abstractmethod
def configure_fit(
self, server_round: int, parameters: Parameters, client_manager: ClientManager
) -> List[Tuple[ClientProxy, FitIns]]:
"""Configure the next round of training."""
The return value is a list of tuples, each representing the instructions that will be
sent to a particular client. Strategy implementations usually perform the following
steps in configure_fit
:
Use the
client_manager
to randomly sample all (or a subset of) available clients (each represented as aClientProxy
object)Pair each
ClientProxy
with the sameFitIns
holding the current global modelparameters
andconfig
dict
More sophisticated implementations can use configure_fit
to implement custom client
selection logic. A client will only participate in a round if the corresponding
ClientProxy
is included in the list returned from configure_fit
.
Note
The structure of this return value provides a lot of flexibility to the user. Since
instructions are defined on a per-client basis, different instructions can be sent
to each client. This enables custom strategies to train, for example, different
models on different clients, or use different hyperparameters on different clients
(via the config
dict).
The aggregate_fit
method¶
aggregate_fit
is responsible for aggregating the results returned by the clients
that were selected and asked to train in configure_fit
.
@abstractmethod
def aggregate_fit(
self,
server_round: int,
results: List[Tuple[ClientProxy, FitRes]],
failures: List[Union[Tuple[ClientProxy, FitRes], BaseException]],
) -> Tuple[Optional[Parameters], Dict[str, Scalar]]:
"""Aggregate training results."""
Of course, failures can happen, so there is no guarantee that the server will get
results from all the clients it sent instructions to (via configure_fit
).
aggregate_fit
therefore receives a list of results
, but also a list of
failures
.
aggregate_fit
returns an optional Parameters
object and a dictionary of
aggregated metrics. The Parameters
return value is optional because
aggregate_fit
might decide that the results provided are not sufficient for
aggregation (e.g., too many failures).
The configure_evaluate
method¶
configure_evaluate
is responsible for configuring the upcoming round of evaluation.
What does configure mean in this context? Configuring a round means selecting clients
and deciding what instructions to send to these clients. The signature of
configure_evaluate
makes this clear:
@abstractmethod
def configure_evaluate(
self, server_round: int, parameters: Parameters, client_manager: ClientManager
) -> List[Tuple[ClientProxy, EvaluateIns]]:
"""Configure the next round of evaluation."""
The return value is a list of tuples, each representing the instructions that will be
sent to a particular client. Strategy implementations usually perform the following
steps in configure_evaluate
:
Use the
client_manager
to randomly sample all (or a subset of) available clients (each represented as aClientProxy
object)Pair each
ClientProxy
with the sameEvaluateIns
holding the current global modelparameters
andconfig
dict
More sophisticated implementations can use configure_evaluate
to implement custom
client selection logic. A client will only participate in a round if the corresponding
ClientProxy
is included in the list returned from configure_evaluate
.
Note
The structure of this return value provides a lot of flexibility to the user. Since
instructions are defined on a per-client basis, different instructions can be sent
to each client. This enables custom strategies to evaluate, for example, different
models on different clients, or use different hyperparameters on different clients
(via the config
dict).
The aggregate_evaluate
method¶
aggregate_evaluate
is responsible for aggregating the results returned by the
clients that were selected and asked to evaluate in configure_evaluate
.
@abstractmethod
def aggregate_evaluate(
self,
server_round: int,
results: List[Tuple[ClientProxy, EvaluateRes]],
failures: List[Union[Tuple[ClientProxy, FitRes], BaseException]],
) -> Tuple[Optional[float], Dict[str, Scalar]]:
"""Aggregate evaluation results."""
Of course, failures can happen, so there is no guarantee that the server will get
results from all the clients it sent instructions to (via configure_evaluate
).
aggregate_evaluate
therefore receives a list of results
, but also a list of
failures
.
aggregate_evaluate
returns an optional float
(loss) and a dictionary of
aggregated metrics. The float
return value is optional because
aggregate_evaluate
might decide that the results provided are not sufficient for
aggregation (e.g., too many failures).
The evaluate
method¶
evaluate
is responsible for evaluating model parameters on the server-side. Having
evaluate
in addition to configure_evaluate
/aggregate_evaluate
enables
strategies to perform both servers-side and client-side (federated) evaluation.
@abstractmethod
def evaluate(self, parameters: Parameters) -> Optional[Tuple[float, Dict[str, Scalar]]]:
"""Evaluate the current model parameters."""
The return value is again optional because the strategy might not need to implement
server-side evaluation or because the user-defined evaluate
method might not
complete successfully (e.g., it might fail to load the server-side evaluation data).