wordinfopreserved
Metric
WordInfoPreservedfromtorchmetrics(torchmetrics.WordInfoPreserved)
When to invoke this skill
The user has predictions + ground truth and asks to evaluate with WordInfoPreserved, or
mentions torchmetrics.WordInfoPreserved directly, or wants the standard torchmetrics implementation.
Reference signature
from torchmetrics import WordInfoPreserved
# _WordInfoPreserved(**kwargs: Any) -> None
Library docstring
Wrapper for deprecated import.
>>> preds = ["this is the prediction", "there is an other sample"]
>>> target = ["this is the reference", "there is another one"]
>>> wip = WordInfoPreserved()
>>> wip(preds, target)
tensor(0.3472)
Quick recipe
import torchmetrics as _m
score = _m.WordInfoPreserved(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).