TopKOfPredicted (jaicore-ml 0.2.0 API)

java.lang.Object
- ai.libs.jaicore.ml.classification.loss.dataset.APredictionPerformanceMeasure<org.api4.java.ai.ml.ranking.IRanking<?>,org.api4.java.ai.ml.ranking.IRanking<?>>
- - ai.libs.jaicore.ml.ranking.loss.ARankingPredictionPerformanceMeasure
  - - ai.libs.jaicore.ml.ranking.loss.TopKOfPredicted

All Implemented Interfaces:

org.api4.java.ai.ml.core.evaluation.supervised.loss.IDeterministicHomogeneousPredictionPerformanceMeasure<org.api4.java.ai.ml.ranking.IRanking<?>>, org.api4.java.ai.ml.core.evaluation.supervised.loss.IDeterministicPredictionPerformanceMeasure<org.api4.java.ai.ml.ranking.IRanking<?>,org.api4.java.ai.ml.ranking.IRanking<?>>, org.api4.java.ai.ml.ranking.loss.IRankingPredictionPerformanceMeasure
```
public class TopKOfPredicted
extends ARankingPredictionPerformanceMeasure
implements org.api4.java.ai.ml.ranking.loss.IRankingPredictionPerformanceMeasure
```
Calculates if the top-k dyads of the predicted ranking match the top-k dyads of the actual ranking. This ignores the rankings.

Constructor Summary

Constructors
Constructor Description

TopKOfPredicted(int k)
Specifies the amount of top rankings to consider.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`loss(org.api4.java.ai.ml.ranking.IRanking<?> actual, org.api4.java.ai.ml.ranking.IRanking<?> predicted)`

Methods inherited from class ai.libs.jaicore.ml.ranking.loss.ARankingPredictionPerformanceMeasure
loss

Methods inherited from class ai.libs.jaicore.ml.classification.loss.dataset.APredictionPerformanceMeasure
averageInstanceWiseLoss, averageInstanceWiseScore, checkConsistency, loss, score, score

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.api4.java.ai.ml.core.evaluation.supervised.loss.IDeterministicPredictionPerformanceMeasure
loss, loss, score, score

Constructor Detail
- TopKOfPredicted
```
public TopKOfPredicted(int k)
```
  Specifies the amount of top rankings to consider.
  
  Parameters:
  
  k -

Method Detail

loss

public double loss(org.api4.java.ai.ml.ranking.IRanking<?> actual,
                   org.api4.java.ai.ml.ranking.IRanking<?> predicted)

Specified by:: loss in class ARankingPredictionPerformanceMeasure