Spectraldistortionindex

spectraldistortionindex

Metric SpectralDistortionIndex from torchmetrics (torchmetrics.SpectralDistortionIndex)

When to invoke this skill

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

Reference signature

from torchmetrics import SpectralDistortionIndex

# _SpectralDistortionIndex(p: int = 1, reduction: Literal['elementwise_mean', 'sum', 'none'] = 'elementwise_mean', **kwargs: Any) -> None

Library docstring

Wrapper for deprecated import.

>>> from torch import rand
>>> preds = rand([16, 3, 16, 16])
>>> target = rand([16, 3, 16, 16])
>>> sdi = _SpectralDistortionIndex()
>>> sdi(preds, target)
tensor(0.0234)

Quick recipe

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