Concatenation

Module Interface

class torchmetrics.CatMetric(nan_strategy='warn', **kwargs)

Concatenate a stream of values.

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 value

• kwargs (Dict[str, Any]) – Additional keyword arguments, see Advanced metric settings for more info.

Raises

ValueError – If nan_strategy is not one of error, warn, ignore or a float

Example

>>> from torchmetrics import CatMetric
>>> metric = CatMetric()
>>> metric.update(1)
>>> metric.update(torch.tensor([2, 3]))
>>> metric.compute()
tensor([1., 2., 3.])

Initializes internal Module state, shared by both nn.Module and ScriptModule.

compute()

Compute the aggregated value.

Return type

Tensor

update(value)

Update state with data.

Parameters

value (Union[float, Tensor]) – Either a float or tensor containing data. Additional tensor dimensions will be flattened

Return type

None