tff.aggregators.SumFactory

UnweightedAggregationFactory for sum.

Inherits From: UnweightedAggregationFactory

Used in the notebooks

Used in the tutorials
Implementing Custom Aggregations

The created tff.templates.AggregationProcess sums values placed at CLIENTS, and outputs the sum placed at SERVER.

The process has empty state and returns no measurements. For summation, implementation delegates to the tff.federated_sum operator.

Methods

create

View source

create(
    value_type: factory.ValueType
) -> tff.templates.AggregationProcess

Creates a tff.aggregators.AggregationProcess without weights.

The provided value_type is a non-federated tff.Type, that is, not a tff.FederatedType.

The returned tff.aggregators.AggregationProcess will be created for aggregation of values matching value_type placed at tff.CLIENTS. That is, its next method will expect type <S@SERVER, {value_type}@CLIENTS>, where S is the unplaced return type of its initialize method.

Args
value_type	A non-federated tff.Type.

Returns
A tff.templates.AggregationProcess.