Commit 95138da6 authored by Yu Xiao's avatar Yu Xiao Committed by tensorflow-copybara
Browse files

Change the docstring of `federated_aggregate_keras_metric` as it can take...

Change the docstring of `federated_aggregate_keras_metric` as it can take either metrics or metric constructors now.

PiperOrigin-RevId: 413026905
parent f5ef56e0
......@@ -201,8 +201,10 @@ def federated_aggregate_keras_metric(
"""Aggregates variables a keras metric placed at CLIENTS to SERVER.
Args:
metrics: A single `tf.keras.metrics.Metric` or a `Sequence` of metrics . The
order must match the order of variables in `federated_values`.
metrics: A single or a `Sequence` of `tf.keras.metrics.Metric` objects, or
a single or a `Sequence` of no-arg callables that each constructs a
`tf.keras.metrics.Metric`. The order must match the order of variables in
`federated_values`.
federated_values: A single federated value, or a `Sequence` of federated
values. The values must all have `tff.CLIENTS` placement. If value is a
`Sequence` type, it must match the order of the sequence in `metrics.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment