View source on GitHub |
Libraries for constructing federated aggregation.
For example uses of the symbols in this module, see Tuning recommended aggregations for learning tutorial, and for details of the design and how to implement new aggregations, see Implementing Custom Aggregations tutorial.
Classes
class DifferentiallyPrivateFactory
: UnweightedAggregationFactory
for tensorflow_privacy DPQueries.
class DiscreteFourierTransformFactory
: UnweightedAggregationFactory
for discrete Fourier transform.
class EncodedSumFactory
: UnweightedAggregationFactory
for encoded sum.
class HadamardTransformFactory
: UnweightedAggregationFactory
for fast Walsh-Hadamard transform.
class MeanFactory
: Aggregation factory for weighted mean.
class PrivateQuantileEstimationProcess
: A tff.templates.EstimationProcess
for estimating private quantiles.
class SecureModularSumFactory
: AggregationProcess
factory for securely summing values under a modulus.
class SecureSumFactory
: AggregationProcess
factory for securely summing values.
class SumFactory
: UnweightedAggregationFactory
for sum.
class UnweightedAggregationFactory
: Factory for creating tff.templates.AggregationProcess
without weights.
class UnweightedMeanFactory
: Aggregation factory for unweighted mean.
class UnweightedReservoirSamplingFactory
: An UnweightedAggregationFactory
for reservoir sampling values.
class WeightedAggregationFactory
: Factory for creating tff.templates.AggregationProcess
with weights.
Functions
add_measurements(...)
: Wraps AggregationFactory
to report additional measurements.
as_weighted_aggregator(...)
: Constructs a weighted wrapper for an unweighted aggregation factory.
clipping_factory(...)
: Creates an aggregation factory to perform L2 clipping.
concat_factory(...)
: Aggregation factory for concatenation of input to a single tensor.
federated_sample(...)
: Aggregation to produce uniform sample of at most max_num_samples
values.
secure_quantized_sum(...)
: Quantizes and sums values securely.
zeroing_factory(...)
: Creates an aggregation factory to perform zeroing.