# tff.learning.metrics.sum_then_finalize

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/federated/blob/v0.87.0 Version 2.0, January 2004 Licensed under the Apache License, Version 2.0 (the) |

Creates a TFF computation that aggregates metrics via `sum_then_finalize`.

    tff.learning.metrics.sum_then_finalize(
        metric_finalizers: Union[https://www.tensorflow.org/federated/api_docs/python/tff/learning/metrics/MetricFinalizersType, https://www.tensorflow.org/federated/api_docs/python/tff/learning/metrics/FunctionalMetricFinalizersType],
        local_unfinalized_metrics_type: Optional[https://www.tensorflow.org/federated/api_docs/python/tff/types/StructWithPythonType] = None
    ) -> https://www.tensorflow.org/federated/api_docs/python/tff/Computation

The returned federated TFF computation is a polymorphic computation that
accepts unfinalized client metrics, and returns finalized, summed metrics
placed at the server. Invoking the polymorphic computation will initiate
tracing on the argument and will raise a `ValueError` if the keys (i.e.,
metric names) in `metric_finalizers` are not the same as those of the argument
the polymorphic method is invoked on.

> [!NOTE]
> **Note:** invoking this computation outside of a federated context (a method decorated with [`tff.federated_computation`](https://www.tensorflow.org/federated/api_docs/python/tff/federated_computation)) will require first wrapping it in a concrete, non-polymorphic [`tff.Computation`](https://www.tensorflow.org/federated/api_docs/python/tff/Computation) with appropriate federated types.

<br />

<br />

<br />

| ## Args ||
|---|---|
| `metric_finalizers` | Either the result of [`tff.learning.models.VariableModel.metric_finalizers`](https://www.tensorflow.org/federated/api_docs/python/tff/learning/models/VariableModel#metric_finalizers) (an `OrderedDict` of callables) or the [`tff.learning.models.FunctionalModel.finalize_metrics`](https://www.tensorflow.org/federated/api_docs/python/tff/learning/models/FunctionalModel#finalize_metrics) method (a callable that takes an `OrderedDict` argument). If the former, the keys must be the same as the `OrderedDict` returned by [`tff.learning.models.VariableModel.report_local_unfinalized_metrics`](https://www.tensorflow.org/federated/api_docs/python/tff/learning/models/VariableModel#report_local_unfinalized_metrics). If the later, the callable must compute over the same keyspace of the result returned by [`tff.learning.models.FunctionalModel.update_metrics_state`](https://www.tensorflow.org/federated/api_docs/python/tff/learning/models/FunctionalModel#update_metrics_state). |
| `local_unfinalized_metrics_type` | Unused, will be removed from the API in the future. |

<br />

<br />

<br />

<br />

| ## Returns ||
|---|---|
| A federated TFF computation that sums the unfinalized metrics from `CLIENTS`, and applies the correponding finalizers at `SERVER`. ||

<br />

<br />

<br />

<br />

| ## Raises ||
|---|---|
| `TypeError` | If the inputs are of the wrong types. |

<br />