Cramersv

cramersv

Metric CramersV from torchmetrics (torchmetrics.CramersV)

When to invoke this skill

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

Reference signature

from torchmetrics import CramersV

# CramersV(num_classes: int, bias_correction: bool = True, nan_strategy: Literal['replace', 'drop'] = 'replace', nan_replace_value: Optional[float] = 0.0, **kwargs: Any) -> None

Library docstring

Compute `Cramer's V`_ statistic measuring the association between two categorical (nominal) data series.

.. math::
    V = \sqrt{\frac{\chi^2 / n}{\min(r - 1, k - 1)}}

where

.. math::
    \chi^2 = \sum_{i,j} \ frac{\left(n_{ij} - \frac{n_{i.} n_{.j}}{n}\right)^2}{\frac{n_{i.} n_{.j}}{n}}

where :math:`n_{ij}` denotes the number of times the values :math:`(A_i, B_j)` are observed with :math:`A_i, B_j`
represent frequencies of values in ``preds`` and ``target``, respectively. Cramer's V is a symmetric coefficient,
i.e. :math:`V(preds, target) = V(target, preds)`, so order of input arguments does not matter. The output values
lies in [0, 1] with 1 meaning the perfect association.

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

- ``preds`` (:class:`~torch.Tensor`): Either 1D or 2D tensor of categorical (nominal) data from the first data
  series with shape ``(batch_size,)`` or ``(batch_size, num_classes)``, respectively.
- ``target`` (:class:`~torch.Tensor`): Either 1D or 2D tensor of categorical (nominal) data from the second data
  series with shape ``(batch_size,)`` or ``(batch_size, num_classes)``, respectively.

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

- ``cramers_v`` (:class:`~torch.Tensor`): Scalar tensor containing the Cramer's V statistic.

Args:
    num_classes: Integer specifying the number of classes
    bias_correction: Indication of whether to use bias correction.
    nan_strategy: Indication of whether to replace or drop ``NaN`` values
    nan_replace_value: Value to replace ``NaN``s when ``nan_strategy = 'replace'``
    kwargs: Additional keyword arguments, see :ref:`Metric kwargs` for more info.

Raises:
    ValueError:
        If `nan_strategy` is not one of `'replace'` and `'drop'`
    ValueError:
        If `nan_strategy` is equal to `'replace'` and `nan_replace_value` is not an `int` or `float`

Example::

    >>> from torch import randint, randn
    >>> from torchmetrics.nominal import CramersV
    >>> preds = randint(0, 4, (100,))
    >>> target = (preds + randn(100)).round().clamp(0, 4)
    >>> cramers_v = CramersV(num_classes=5)
    >>> cramers_v(preds, target)
   

Quick recipe

import torchmetrics as _m
score = _m.CramersV(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).