Metrics

A module for PyKEEN ranking and classification metrics.

Classes

Metric()	A base class for metrics.
ValueRange([lower, lower_inclusive, upper, ...])	A value range description.
RankBasedMetric()	A base class for rank-based metrics.
ClassificationMetric()	A base class for classification metrics.

Class Inheritance Diagram

Ranking metrics.

Functions

generate_ranks(num_candidates[, ...])	Generate random ranks from a given array of the number of candidates for each ranking task.
generate_num_candidates_and_ranks(num_ranks, ...)	Generate random number of candidates, and coherent ranks.
generalized_harmonic_numbers(n[, p])	Calculate the generalized harmonic numbers from 1 to n (both inclusive).
harmonic_variances(n)	Pre-calculate variances of inverse rank distributions.

Classes

RankBasedMetric()	A base class for rank-based metrics.
DerivedRankBasedMetric([base_cls])	A derived rank-based metric.
ExpectationNormalizedMetric([base_cls])	An adjustment to create an expectation-normalized metric.
ReindexedMetric([base_cls])	A mixin to create an expectation normalized metric with max of 1 and expectation of 0.
ZMetric([base_cls])	A z-score adjusted metrics.
ArithmeticMeanRank()	The (arithmetic) mean rank.
AdjustedArithmeticMeanRank([base_cls])	The adjusted arithmetic mean rank (AMR).
AdjustedArithmeticMeanRankIndex([base_cls])	The adjusted arithmetic mean rank index (AMRI).
ZArithmeticMeanRank([base_cls])	The z-scored arithmetic mean rank.
InverseArithmeticMeanRank()	The inverse arithmetic mean rank.
GeometricMeanRank()	The geometric mean rank.
InverseGeometricMeanRank()	The inverse geometric mean rank.
HarmonicMeanRank()	The harmonic mean rank.
InverseHarmonicMeanRank()	The inverse harmonic mean rank.
AdjustedInverseHarmonicMeanRank([base_cls])	The adjusted MRR index.
ZInverseHarmonicMeanRank([base_cls])	The z-inverse harmonic mean rank (ZIHMR).
MedianRank()	The median rank.
InverseMedianRank()	The inverse median rank.
HitsAtK([k])	The Hits @ k.
AdjustedHitsAtK([base_cls])	The adjusted Hits at K (\(AH_k\)).
ZHitsAtK([base_cls])	The z-scored hits at k (\(ZAH_k\)).
StandardDeviation()	The ranks' standard deviation.
Variance()	The ranks' variance.
Count()	The ranks' count.
NoClosedFormError	The metric does not provide a closed-form implementation for the requested operation.
AffineTransformationParameters([scale, offset])	The parameters of an affine transformation.

Class Inheritance Diagram