Retrievalhitrate

retrievalhitrate

Metric RetrievalHitRate from torchmetrics (torchmetrics.RetrievalHitRate)

When to invoke this skill

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

Reference signature

from torchmetrics import RetrievalHitRate

# _RetrievalHitRate(empty_target_action: str = 'neg', ignore_index: Optional[int] = None, top_k: Optional[int] = None, **kwargs: Any) -> None

Library docstring

Wrapper for deprecated import.

>>> from torch import tensor
>>> indexes = tensor([0, 0, 0, 1, 1, 1, 1])
>>> preds = tensor([0.2, 0.3, 0.5, 0.1, 0.3, 0.5, 0.2])
>>> target = tensor([True, False, False, False, True, False, True])
>>> hr2 = _RetrievalHitRate(top_k=2)
>>> hr2(preds, target, indexes=indexes)
tensor(0.5000)

Quick recipe

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