Retrieval Hit Rate

Module Interface

torchmetrics.RetrievalHitRate

alias of torchmetrics.retrieval._deprecated._RetrievalHitRate

Functional Interface

torchmetrics.functional.retrieval_hit_rate(preds, target, top_k=None)

Wrapper for deprecated import.

>>> from torch import tensor
>>> preds = tensor([0.2, 0.3, 0.5])
>>> target = tensor([True, False, True])
>>> _retrieval_hit_rate(preds, target, top_k=2)
tensor(1.)

Return type

Tensor