Maximum¶
Module Interface¶
- class torchmetrics.MaxMetric(nan_strategy='warn', **kwargs)[source]
Aggregate a stream of value into their maximum value.
As input to
forward
andupdate
the metric accepts the following inputAs output of forward and compute the metric returns the following output
agg
(Tensor
): scalar float tensor with aggregated maximum value over all inputs received
- Parameters
nan_strategy¶ (
Union
[str
,float
]) – options: -'error'
: if any nan values are encounted will give a RuntimeError -'warn'
: if any nan values are encounted will give a warning and continue -'ignore'
: all nan values are silently removed - a float: if a float is provided will impude any nan values with this valuekwargs¶ (
Any
) – Additional keyword arguments, see Advanced metric settings for more info.
- Raises
ValueError – If
nan_strategy
is not one oferror
,warn
,ignore
or a float
Example
>>> import torch >>> from torchmetrics import MaxMetric >>> metric = MaxMetric() >>> metric.update(1) >>> metric.update(torch.tensor([2, 3])) >>> metric.compute() tensor(3.)
Initializes internal Module state, shared by both nn.Module and ScriptModule.