jina.executors.evaluators.rank

class jina.executors.evaluators.rank.BaseRankingEvaluator(eval_at, *args, **kwargs)[source]

Bases: jina.executors.evaluators.BaseEvaluator

A BaseRankingEvaluator evaluates the content of matches against the expected GroundTruth. It is used to evaluate messages coming out from Indexers and Rankers and compares matches with groundtruths

” :type eval_at: int :param eval_at: k at which evaluation is performed

evaluate(actual, desired, *args, **kwargs)[source]

” :type actual: Sequence[Any] :param actual: the matched document identifiers from the request as matched by jina indexers and rankers :type desired: Sequence[Any] :param desired: the expected documents matches ids sorted as they are expected :return the evaluation metric value for the request document

Return type

float