|View source on GitHub|
Computes a sum at
tff.SERVER of a
value placed on the
tff.federated_secure_sum( value, max_input )
This function computes a sum such that it should not be possible for the server to learn any clients individual value. The specific algorithm and mechanism used to compute the secure sum may vary depending on the target runtime environment the computation is compiled for or executed on. See https://research.google/pubs/pub47246/ for more information.
Not all executors support
tff.federated_secure_sum(); consult the
documentation for the specific executor or executor stack you plan on using
for the specific of how it's handled by that executor.
max_input argument is the maximum value (inclusive) that may appear in
value. Lower values may allow for improved communication efficiency.
Attempting to return a
value higher than
max_input is invalid, and will
result in a failure at the given client.
value = tff.federated_value(1, tff.CLIENTS) result = tff.federated_secure_sum(value, 1) value = tff.federated_value((1, 2), tff.CLIENTS) result = tff.federated_secure_sum(value, (1, 2))
An integer or nested structure of integers placed at
A Python integer or nested structure of integers matching the
A representation of the sum of the member constituents of
If the argument is not a federated TFF value placed at