ARankingPredictionPerformanceMeasure (jaicore-ml 0.2.5 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

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

Direct Known Subclasses:

KendallsTauDyadRankingLoss, KendallsTauOfTopK, NDCGLoss, TopKOfPredicted
```
public abstract class ARankingPredictionPerformanceMeasure
extends APredictionPerformanceMeasure<org.api4.java.ai.ml.ranking.IRanking<?>,org.api4.java.ai.ml.ranking.IRanking<?>>
implements org.api4.java.ai.ml.ranking.loss.IRankingPredictionPerformanceMeasure
```

Constructor Summary

Constructors
Constructor Description

ARankingPredictionPerformanceMeasure()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`loss(java.util.List<? extends org.api4.java.ai.ml.ranking.IRanking<?>> expected, java.util.List<? extends org.api4.java.ai.ml.ranking.IRanking<?>> actual)`	If this performance measure is originally a score function its score is transformed into a loss by multiplying the score with -1.
`abstract double`	`loss(org.api4.java.ai.ml.ranking.IRanking<?> expected, org.api4.java.ai.ml.ranking.IRanking<?> actual)`

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, score, score

- Constructor Detail
  - ARankingPredictionPerformanceMeasure
```
public ARankingPredictionPerformanceMeasure()
```
- Method Detail
  - loss
```
public double loss(java.util.List<? extends org.api4.java.ai.ml.ranking.IRanking<?>> expected,
                   java.util.List<? extends org.api4.java.ai.ml.ranking.IRanking<?>> actual)
```
    Description copied from class: APredictionPerformanceMeasure
    
    If this performance measure is originally a score function its score is transformed into a loss by multiplying the score with -1. (loss=-score).
    
    Specified by:
    
    loss in interface org.api4.java.ai.ml.core.evaluation.supervised.loss.IDeterministicPredictionPerformanceMeasure<org.api4.java.ai.ml.ranking.IRanking<?>,org.api4.java.ai.ml.ranking.IRanking<?>>
    
    Overrides:
    
    loss in class APredictionPerformanceMeasure<org.api4.java.ai.ml.ranking.IRanking<?>,org.api4.java.ai.ml.ranking.IRanking<?>>
  - loss
```
public abstract double loss(org.api4.java.ai.ml.ranking.IRanking<?> expected,
                            org.api4.java.ai.ml.ranking.IRanking<?> actual)
```