ClassificationEvaluator

class ClassificationEvaluator(**kwargs)

Bases: Evaluator[ClassificationMetricKey]

An evaluator that uses a classification metrics.

Initialize the evaluator.

Parameters:

kwargs – keyword-based parameters passed to Evaluator.__init__().

Methods Summary

clear()	Clear buffers and intermediate results.
finalize()	Compute the final results, and clear buffers.
process_scores_(hrt_batch, target, scores[, ...])	Process a batch of triples with their computed scores for all entities.

Methods Documentation

clear() → None

Clear buffers and intermediate results.

Return type:

None

finalize() → ClassificationMetricResults

Compute the final results, and clear buffers.

Return type:

ClassificationMetricResults

process_scores_(hrt_batch: Tensor, target: Literal['head', 'relation', 'tail'], scores: Tensor, true_scores: Tensor | None = None, dense_positive_mask: Tensor | None = None) → None

Process a batch of triples with their computed scores for all entities.

Parameters:

• hrt_batch (Tensor) – shape: (batch_size, 3)

• target (Literal['head', 'relation', 'tail']) – the prediction target

• scores (Tensor) – shape: (batch_size, num_entities)

• true_scores (Tensor | None) – shape: (batch_size, 1)

• dense_positive_mask (Tensor | None) – shape: (batch_size, num_entities) An optional binary (0/1) tensor indicating other true entities.

Return type:

None