OGB评估器

class OGBEvaluator(filtered: bool = False, **kwargs)[源代码]

基础类：SampledRankBasedEvaluator

一个基于排名的采样评估器，应用了自定义的OGB评估。

初始化评估器。

Parameters:

  • evaluation_factory – 包含评估三元组的工厂

  • additional_filter_triples – 用于过滤的额外真实三元组；仅在未给出显式负例时相关。 参见 pykeen.evaluation.rank_based_evaluator.sample_negatives()

  • num_negatives – 采样的负样本数量；仅在未给出显式负样本时相关。 参见 pykeen.evaluation.rank_based_evaluator.sample_negatives()

  • head_negatives – 形状: (num_triples, num_negatives) 每个评估三元组的头部预测的负样本的实体ID

  • tail_negatives – 形状: (num_triples, num_negatives) 每个评估三元组的尾部预测的负样本的实体ID

  • kwargs – 传递给 pykeen.evaluation.rank_based_evaluator.RankBasedEvaluator.__init__() 的额外基于关键字的参数

  • 已过滤 (bool)

Raises:

ValueError – 如果只给出了一侧的负值，或者负值的形状不正确

方法总结

evaluate(model, mapped_triples[, ...])

使用此评估器运行 evaluate_ogb()。

方法文档

evaluate(model: Model, mapped_triples: Tensor, batch_size: int | None = None, slice_size: int | None = None, device: device | None = None, use_tqdm: bool = True, tqdm_kwargs: Mapping[str, str] | None = None, restrict_entities_to: Collection[int] | None = None, restrict_relations_to: Collection[int] | None = None, do_time_consuming_checks: bool = True, additional_filter_triples: None | Tensor | list[Tensor] = None, pre_filtered_triples: bool = True, targets: Collection[Literal['head', 'relation', 'tail']] = ('head', 'tail')) → MetricResults[source]

使用此评估器运行 evaluate_ogb()。

Parameters:
Return type:

MetricResults