torch_geometric.metrics.LinkPredHitRatio

class LinkPredHitRatio(k: int)[source]

Bases: LinkPredMetric

A link prediction metric to compute the hit ratio @ \(k\), i.e. the percentage of users for whom at least one relevant item is present within the top-\(k\) recommendations.

A high ratio signifies the model’s effectiveness in satisfying a broad range of user preferences.

update(pred_index_mat: Tensor, edge_label_index: Union[Tensor, Tuple[Tensor, Tensor]], edge_label_weight: Optional[Tensor] = None) → None

Updates the state variables based on the current mini-batch prediction.

update() can be repeated multiple times to accumulate the results of successive predictions, e.g., inside a mini-batch training or evaluation loop.

Parameters:

  • pred_index_mat (torch.Tensor) – The top-\(k\) predictions of every example in the mini-batch with shape [batch_size, k].

  • edge_label_index (torch.Tensor) – The ground-truth indices for every example in the mini-batch, given in COO format of shape [2, num_ground_truth_indices].

  • edge_label_weight (torch.Tensor, optional) – The weight of the ground-truth indices for every example in the mini-batch of shape [num_ground_truth_indices]. If given, needs to be a vector of positive values. Required for weighted metrics, ignored otherwise. (default: None)

Return type:

None

compute() → Tensor

Computes the final metric value.

Return type:

Tensor

reset() → None

Resets metric state variables to their default value.

Return type:

None