# kd.metrics

[[[Source]]](https://github.com/google-research/kauldron/tree/main/kauldron/metrics/__init__.py)

```{eval-rst}
.. automodule:: kauldron.metrics
  :no-members:
```

## Symbols


### Class

|  |  |
--- | ---
[kd.metrics.Accuracy](Accuracy) | Classification Accuracy.
[kd.metrics.Ari](Ari) | Adjusted Rand Index (ARI) computed from predictions and labels.
[kd.metrics.AutoState](AutoState) | Flexible base class for conveniently defining custom states.
[kd.metrics.AverageState](AverageState) | Computes the average of a scalar or a batch of tensors.
[kd.metrics.BinaryAccuracy](BinaryAccuracy) | Classification Accuracy for Binary classification tasks.
[kd.metrics.CollectFirstState](CollectFirstState) | Get the first outputs (possibly) across multiple steps (no reducing).
[kd.metrics.CollectingState](CollectingState) | Accumulate outputs across multiple steps (without reducing).
[kd.metrics.EmptyState](EmptyState) | Empty state.
[kd.metrics.LpipsVgg](LpipsVgg) | VGG LPIPS.
[kd.metrics.Metric](Metric) | Base class for metrics.
[kd.metrics.NoopMetric](NoopMetric) | Metric that does nothing. Can be used in sweeps to remove a metric.
[kd.metrics.Norm](Norm) | Wraps jnp.linalg.norm to compute the average norm for given tensors.
[kd.metrics.Precision1](Precision1) | Precision@1 for multilabel classification.
[kd.metrics.Psnr](Psnr) | PSNR.
[kd.metrics.RocAuc](RocAuc) | Area Under the Receiver Operating Characteristic Curve (ROC AUC).
[kd.metrics.SingleDimension](SingleDimension) | Returns a single chosen dimension of the tensor.
[kd.metrics.SkipIfMissing](SkipIfMissing) | Skip this metric if any of the keys are missing.
[kd.metrics.Ssim](Ssim) | Structural similarity (SSIM).
[kd.metrics.State](State) | Base metric state class.
[kd.metrics.Std](Std) | Compute the standard deviation for float values.
[kd.metrics.TreeMap](TreeMap) | Maps an inner metric to a pytree and returns a pytree of results.
[kd.metrics.TreeReduce](TreeReduce) | Applies a metric to a pytree and returns the aggregated result.

### Function

|  |  |
--- | ---
[kd.metrics.concat_field](concat_field) | Defines a AutoState data-field that is merged by concatenation.
[kd.metrics.state_field](state_field) | Defines a AutoState data-field that is merged by calling its merge method.
[kd.metrics.static_field](static_field) | Define an AutoState static field.
[kd.metrics.sum_field](sum_field) | Define an AutoState data-field that is merged by summation (a + b).
[kd.metrics.truncate_field](truncate_field) | Defines a AutoState data-field that is merged by truncation.

```{toctree}
:hidden:

Accuracy
Ari
AutoState
AverageState
BinaryAccuracy
CollectFirstState
CollectingState
EmptyState
LpipsVgg
Metric
NoopMetric
Norm
Precision1
Psnr
RocAuc
SingleDimension
SkipIfMissing
Ssim
State
Std
TreeMap
TreeReduce
concat_field
state_field
static_field
sum_field
truncate_field
```