Multiclassrecall

---
name: multiclassrecall
description: Compute the MulticlassRecall metric — provided by torchmetrics. Use when the user has predictions and ground-truth and needs to compute MulticlassRecall, or asks how to score with MulticlassRecall.
metadata:
  skill_kind: metric
  source_lib: torchmetrics
  import_path: torchmetrics.classification.MulticlassRecall
  source: library_introspection
---

# multiclassrecall

> Metric `MulticlassRecall` from `torchmetrics` (torchmetrics.classification.MulticlassRecall)

## When to invoke this skill

The user has predictions + ground truth and asks to evaluate with MulticlassRecall, or
mentions `torchmetrics.classification.MulticlassRecall` directly, or wants the standard torchmetrics implementation.

## Reference signature

```python
from torchmetrics.classification import MulticlassRecall

# MulticlassRecall(num_classes: Optional[int] = None, top_k: int = 1, average: Optional[Literal['micro', 'macro', 'weighted', 'none']] = 'macro', multidim_average: Literal['global', 'samplewise'] = 'global', ignore_index: Optional[int] = None, validate_args: bool = True, **kwargs: Any) -> None
```

## Library docstring

```
Compute `Recall`_ for multiclass tasks.

.. math:: \text{Recall} = \frac{\text{TP}}{\text{TP} + \text{FN}}

Where :math:`\text{TP}` and :math:`\text{FN}` represent the number of true positives and false negatives
respectively. The metric is only proper defined when :math:`\text{TP} + \text{FN} \neq 0`. If this case is
encountered for any class, the metric for that class will be set to `zero_division` (0 or 1, default is 0) and
the overall metric may therefore be affected in turn.

As input to ``forward`` and ``update`` the metric accepts the following input:

- ``preds`` (:class:`~torch.Tensor`): An int tensor of shape ``(N, ...)`` or float tensor of shape ``(N, C, ..)``
  If preds is a floating point we apply ``torch.argmax`` along the ``C`` dimension to automatically convert
  probabilities/logits into an int tensor.
- ``target`` (:class:`~torch.Tensor`): An int tensor of shape ``(N, ...)``

As output to ``forward`` and ``compute`` the metric returns the following output:

- ``mcr`` (:class:`~torch.Tensor`): The returned shape depends on the ``average`` and ``multidim_average``
  arguments:

    - If ``multidim_average`` is set to ``global``:

      - If ``average='micro'/'macro'/'weighted'``, the output will be a scalar tensor
      - If ``average=None/'none'``, the shape will be ``(C,)``

    - If ``multidim_average`` is set to ``samplewise``:

      - If ``average='micro'/'macro'/'weighted'``, the shape will be ``(N,)``
      - If ``average=None/'none'``, the shape will be ``(N, C)``

If ``multidim_average`` is set to ``samplewise`` we expect at least one additional dimension ``...`` to be present,
which the reduction will then be applied over instead of the sample dimension ``N``.

Args:
    num_classes: Integer specifying the number of classes
    average:
        Defines the reduction that is applied over labels. Should be one of the following:

        - ``micro``: Sum statistics over all labels
        - ``macro``: Calculate statistics for each label and average them
        - ``weighted``: calculates statistics for each label and computes weighted average using their support
        - ``"none"`` or ``None``: calculates statistic for each label and app
```

## Quick recipe

```python
import torchmetrics.classification as _m
score = _m.MulticlassRecall(y_true, y_pred)
```

## Don'ts

- Don't reimplement when the library version handles edge cases (NaN, ties, empty inputs) better than a hand-rolled formula.
- Always check the library version's argument order — sklearn is `(y_true, y_pred)` while torchmetrics is `(preds, target)`.