常见

服务器和客户端共享的通用组件。

Functions

array_from_numpy(ndarray)

Create Array from NumPy ndarray.

bytes_to_ndarray(tensor)

从字节反序列化 NumPy ndarray。

configure(identifier[, filename, host])

配置将日志记录到文件和/或远程日志服务器。

event(event_type[, event_details])

Submit create_event to ThreadPoolExecutor to avoid blocking.

log(level, msg, *args, **kwargs)

以整数严重性 "级别 "记录 "msg % args"。

ndarray_to_bytes(ndarray)

将 NumPy ndarray 序列化为字节。

ndarrays_to_parameters(ndarrays)

将 NumPy ndarrays 转换为参数对象。

now()

从 time.time() 生成日期时间,时区设置为 UTC。

parameters_to_ndarrays(parameters)

将参数对象转换为 NumPy ndarrays。

Classes

Array(dtype, shape, stype, data)

Array type.

ClientMessage([get_properties_res, ...])

ClientMessage 是用于容纳一条结果信息的容器。

Code(value)

客户端状态代码。

Config

alias of dict[str, bool | bytes | float | int | str]

ConfigsRecord([configs_dict, keep_input])

Configs record.

Context(node_id, node_config, state, run_config)

Context of your run.

DisconnectRes(reason)

客户端向服务器发送 DisconnectRes 信息。

Error(code[, reason])

A dataclass that stores information about an error that occurred.

EvaluateIns(parameters, config)

评估客户端的指示。

EvaluateRes(status, loss, num_examples, metrics)

评估客户端的反应。

EventType(value)

遥测事件类型。

FitIns(parameters, config)

为客户提供安装说明。

FitRes(status, parameters, num_examples, metrics)

来自客户端的合适回复。

GetParametersIns(config)

客户端的参数请求。

GetParametersRes(status, parameters)

要求返回参数时的响应。

GetPropertiesIns(config)

客户端的属性请求。

GetPropertiesRes(status, properties)

来自客户端的属性响应。

Message(metadata[, content, error])

State of your application from the viewpoint of the entity using it.

MessageType()

Message type.

MessageTypeLegacy()

Legacy message type.

Metadata(run_id, message_id, src_node_id, ...)

A dataclass holding metadata associated with the current message.

Metrics

alias of dict[str, bool | bytes | float | int | str]

MetricsRecord([metrics_dict, keep_input])

Metrics recod.

NDArray

alias of ndarray[Any, dtype[Any]]

NDArrays

alias of list[ndarray[Any, dtype[Any]]]

Parameters(tensors, tensor_type)

模型参数。

ParametersRecord([array_dict, keep_input])

Parameters record.

Properties

alias of dict[str, bool | bytes | float | int | str]

ReconnectIns(seconds)

服务器发送给客户端的重新连接信息。

RecordSet([parameters_records, ...])

RecordSet stores groups of parameters, metrics and configs.

ServerMessage([get_properties_ins, ...])

ServerMessage 是用于容纳一条指令信息的容器。

Status(code, message)

客户端状态。