NumPyClient¶
- class NumPyClient[source]¶
Bases:
ABC
使用 NumPy 的 Flower 客户端的抽象基类。
Methods
evaluate
(parameters, config)使用本地数据集评估所提供的参数。
fit
(parameters, config)使用本地数据集训练所提供的参数。
get_parameters
(config)返回当前本地模型参数。
get_properties
(config)返回客户端的属性集。
将对象转换为客户类型并返回。
- evaluate(parameters: list[ndarray[Any, dtype[Any]]], config: dict[str, bool | bytes | float | int | str]) tuple[float, int, dict[str, bool | bytes | float | int | str]] [source]¶
使用本地数据集评估所提供的参数。
- 参数:
parameters (NDArrays) -- 当前(全局)模型参数。
config (Dict[str, Scalar]) -- 允许服务器影响客户端评估的配置参数。它可用于将任意值从服务器传送到客户端,例如,影响用于评估的示例数量。
- 返回:
loss (float) -- 模型在本地数据集上的评估损失值。num_examples (int) -- 用于评估的示例数量。metrics (Dict[str, Scalar]) -- 将任意字符串键映射到 bool、bytes、float、int 或 str 类型值的字典。它可用于将任意值传回服务器。
Warning
自 Flower 0.19 起,之前的返回类型格式(int、float、float)和扩展格式(int、float、float、Dict[str, Scalar])已被弃用和移除。
- fit(parameters: list[ndarray[Any, dtype[Any]]], config: dict[str, bool | bytes | float | int | str]) tuple[list[ndarray[Any, dtype[Any]]], int, dict[str, bool | bytes | float | int | str]] [source]¶
使用本地数据集训练所提供的参数。
- 参数:
parameters (NDArrays) -- 当前(全局)模型参数。
config (Dict[str, Scalar]) -- 允许服务器影响客户端训练的配置参数。它可用于将任意值从服务器传送到客户端,例如设置(本地)训练遍历数。
- 返回:
parameters (NDArrays) -- 本地更新的模型参数。num_examples (int) -- 用于训练的示例数量。metrics (Dict[str, Scalar]) -- 将任意字符串键映射到 bool、bytes、float、int 或 str 类型值的字典。它可用于将任意值传回服务器。
- get_parameters(config: dict[str, bool | bytes | float | int | str]) list[ndarray[Any, dtype[Any]]] [source]¶
返回当前本地模型参数。
- 参数:
config (Config) -- 服务器请求的配置参数。这可以用来告诉客户端需要哪些参数以及一些标量属性。
- 返回:
parameters -- NumPy ndarrays 的本地模型参数列表。
- 返回类型:
NDArrays