tff.learning.framework.ClientOutput

Class ClientOutput

Defined in learning/framework/optimizer_utils.py.

Structure for outputs returned from clients during federated optimization.

Fields:

  • weights_delta: a dictionary of updates to the model's trainable variables.
  • weights_delta_weight: weight to use in a weighted mean when aggregating weights_delta.
  • model_output: a structure matching tff.learning.Model.report_local_outputs, reflecting the results of training on the input dataset.
  • optimizer_output: additional metrics or other outputs defined by the optimizer.

__new__

__new__(
    _cls,
    weights_delta,
    weights_delta_weight,
    model_output,
    optimizer_output
)

Create new instance of ClientOutput(weights_delta, weights_delta_weight, model_output, optimizer_output)

Properties

weights_delta

weights_delta_weight

model_output

optimizer_output