torcheval.metrics.MulticlassBinnedAUPRC

class torcheval.metrics.MulticlassBinnedAUPRC(*, num_classes: int, threshold: Union[int, List[float], Tensor] = 100, average: Optional[str] = 'macro', optimization: str = 'vectorized', device: Optional[device] = None)

Compute Binned AUPRC, which is the area under the binned version of the Precision Recall Curve, for multiclass classification. Its functional version is torcheval.metrics.functional.multiclass_binned_auprc().

Parameters:

• num_classes (int) – Number of classes.
• threshold (Tensor, int, List[float]) – Either an integer representing the number of bins, a list of thresholds, or a tensor of thresholds. The same thresholds will be used for all tasks. If threshold is a tensor, it must be 1D. If list or tensor is given, the first element must be 0 and the last must be 1.
• average (str, optional) –

  • 'macro' [default]:

    Calculate metrics for each class separately, and return their unweighted mean.

  • None:

    Calculate the metric for each class separately, and return the metric for every class.

• optimization (str) – Choose the optimization to use. Accepted values: “vectorized” and “memory”. The “vectorized” optimization makes more use of vectorization but uses more memory; the “memory” optimization uses less memory but takes more steps. Here are the tradeoffs between these two options: - “vectorized”: consumes more memory but is faster on some hardware, e.g. modern GPUs. - “memory”: consumes less memory but can be significantly slower on some hardware, e.g. modern GPUs Generally, on GPUs, the “vectorized” optimization requires more memory but is faster; the “memory” optimization requires less memory but is slower. On CPUs, the “memory” optimization is recommended in all cases; it uses less memory and is faster.

Examples:

>>> import torch
>>> from torcheval.metrics import MulticlassBinnedAUPRC
>>> input = torch.tensor([[0.1, 0.2, 0.1], [0.4, 0.2, 0.1], [0.6, 0.1, 0.2], [0.4, 0.2, 0.3], [0.6, 0.2, 0.4]])
>>> target = torch.tensor([0, 1, 2, 1, 0])
>>> metric = MulticlassBinnedAUPRC(num_classes=3, threshold=5, average='macro')
>>> metric.update(input, target)
>>> metric.compute()
tensor(0.35)
>>> metric = MulticlassBinnedAUPRC(num_classes=3, threshold=5, average=None)
>>> metric.update(input, target)
>>> metric.compute()
tensor([0.4500, 0.4000, 0.2000])
>>> input = torch.tensor([[0.1, 0.2, 0.1, 0.4], [0.4, 0.2, 0.1, 0.7], [0.6, 0.1, 0.2, 0.4], [0.4, 0.2, 0.3, 0.2], [0.6, 0.2, 0.4, 0.5]])
>>> target = torch.tensor([0, 1, 2, 1, 0])
>>> threshold = torch.tensor([0.0, 0.1, 0.4, 0.7, 0.8, 1.0])
>>> metric = MulticlassBinnedAUPRC(input, target, num_classes=4, threshold=threshold, average='macro')
>>> metric.update(input, target)
>>> metric.compute()
tensor(0.24375)
>>> metric = MulticlassBinnedAUPRC(input, target, num_classes=4, threshold=threshold, average='macro')
>>> metric.update(input, target)
>>> metric.compute()
tensor([0.3250, 0.2000, 0.2000, 0.2500])

__init__(*, num_classes: int, threshold: Union[int, List[float], Tensor] = 100, average: Optional[str] = 'macro', optimization: str = 'vectorized', device: Optional[device] = None) → None

Initialize a metric object and its internal states.

Use self._add_state() to initialize state variables of your metric class. The state variables should be either torch.Tensor, a list of torch.Tensor, or a dictionary with torch.Tensor as values

Methods

__init__(*, num_classes[, threshold, ...])	Initialize a metric object and its internal states.
compute()	Return Binned_AUPRC.
load_state_dict(state_dict[, strict])	Loads metric state variables from state_dict.
merge_state(metrics)	Implement this method to update the current metric's state variables to be the merged states of the current metric and input metrics.
reset()	Reset the metric state variables to their default value.
state_dict()	Save metric state variables in state_dict.
to(device, *args, **kwargs)	Move tensors in metric state variables to device.
update(input, target)	Update states with the ground truth labels and predictions.

Attributes

device

The last input device of Metric.to().