tff.federated_mean
Stay organized with collections
Save and categorize content based on your preferences.
Computes a tff.SERVER
mean of value
placed on tff.CLIENTS
.
tff.federated_mean(
value, weight=None
)
Used in the notebooks
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
.
Args |
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 .
|
Returns |
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).
|
Raises |
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-20 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2024-09-20 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-20 UTC."],[],[]]