tff.federated_mean

Computes a tff.SERVER mean of value placed on tff.CLIENTS.

Used in the notebooks

Used in the tutorials

For values v_1, ..., v_k, and weights w_1, ..., w_k, this means sum_{i=1}^k (w_i * v_i) / sum_{i=1}^k w_i.

value The value of which the mean is to be computed. Must be of a TFF federated type placed at tff.CLIENTS. The value may be structured, e.g., its member constituents can be named tuples. The tensor types that the value is composed of must be floating-point or complex.
weight An optional weight, a TFF federated integer or floating-point tensor value, also placed at tff.CLIENTS.

A representation at the tff.SERVER of the mean of the member constituents of value, optionally weighted with weight if specified (otherwise, the member constituents contributed by all clients are equally weighted).

TypeError if value is not a federated TFF value placed at tff.CLIENTS, or if weight is not a federated integer or a floating-point tensor with the matching placement.