Multiclassstatscores

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

# multiclassstatscores

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

## When to invoke this skill

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

## Reference signature

```python
from torchmetrics.classification import MulticlassStatScores

# MulticlassStatScores(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

```
Computes true positives, false positives, true negatives, false negatives and the support for multiclass tasks.

Related to `Type I and Type II errors`_.

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:

- ``mcss`` (:class:`~torch.Tensor`): A tensor of shape ``(..., 5)``, where the last dimension corresponds
  to ``[tp, fp, tn, fn, sup]`` (``sup`` stands for support and equals ``tp + fn``). The shape
  depends on ``average`` and ``multidim_average`` parameters:

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

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

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

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

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 applies no reduction
    top_k:
        Number of highest probability or logit score predictions considered to find the correct label.
        Only works when ``preds`` contain probabilities/logits.
    
```

## Quick recipe

```python
import torchmetrics.classification as _m
score = _m.MulticlassStatScores(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)`.