Multilabelhammingdistance

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

# multilabelhammingdistance

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

## When to invoke this skill

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

## Reference signature

```python
from torchmetrics.classification import MultilabelHammingDistance

# MultilabelHammingDistance(num_labels: int, threshold: float = 0.5, 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 the average `Hamming distance`_ (also known as Hamming loss) for multilabel tasks.

.. math::
    \text{Hamming distance} = \frac{1}{N \cdot L} \sum_i^N \sum_l^L 1(y_{il} \neq \hat{y}_{il})

Where :math:`y` is a tensor of target values, :math:`\hat{y}` is a tensor of predictions,
and :math:`\bullet_{il}` refers to the :math:`l`-th label of the :math:`i`-th sample of that
tensor.

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

- ``preds`` (:class:`~torch.Tensor`): An int tensor or float tensor of shape ``(N, C, ...)``. If preds is a
  floating point tensor with values outside [0,1] range we consider the input to be logits and will auto
  apply sigmoid per element. Additionally, we convert to int tensor with thresholding using the value in
  ``threshold``.
- ``target`` (:class:`~torch.Tensor`): An int tensor of shape ``(N, C, ...)``.

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

- ``mlhd`` (:class:`~torch.Tensor`): A tensor whose 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_labels: Integer specifying the number of labels
    threshold: Threshold for transforming probability to binary (0,1) predictions
    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
      
```

## Quick recipe

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