Package ai.libs.jaicore.ml.core.evaluation.measure

Interface IMeasure<I,O>

Type Parameters:

I - The type of the input values (to be measured).

O - The type of output values describing the measurement results.

All Known Subinterfaces:

IMultilabelMeasure

All Known Implementing Classes:

ADecomposableDoubleMeasure, ADecomposableMeasure, ADecomposableMultilabelMeasure, ASquaredErrorLoss, AutoMEKAGGPFitnessMeasure, AutoMEKAGGPFitnessMeasureLoss, ExactMatchAccuracy, ExactMatchLoss, F1MacroAverageL, F1MacroAverageLLoss, HammingAccuracy, HammingLoss, InstanceWiseF1, InstanceWiseF1AsLoss, JaccardLoss, JaccardScore, LossScoreTransformer, MeanSquaredErrorLoss, PrecisionAsLoss, RankLoss, RankScore, RootMeanSquaredErrorLoss, ZeroOneLoss

public interface IMeasure<I,O>

The interface of a measure which compute a value of O from expected and actual values of I.

Method Summary

Modifier and Type	Method	Description
O	calculateAvgMeasure(java.util.List<I> actual, java.util.List<I> expected)	Computes the measure for lists of input actual and the expected outcome expected and aggregates the measured values with the mean, as this is the most frequently used aggregate function.
O	calculateMeasure(I actual, I expected)	Computes the measure for a measured input actual and the expected outcome expected.
java.util.List<O>	calculateMeasure(java.util.List<I> actual, java.util.List<I> expected)	Computes the measure for a lists of input actual and the expected outcome expected.
O	calculateMeasure(java.util.List<I> actual, java.util.List<I> expected, ai.libs.jaicore.basic.aggregate.IAggregateFunction<O> aggregateFunction)	Computes the measure for lists of input actual and the expected outcome expected and aggregates the measured values with the given aggregation.

Method Detail

calculateMeasure

O calculateMeasure(I actual,
                   I expected)

Computes the measure for a measured input actual and the expected outcome expected.

Parameters:

actual - The actually available values.

expected - The expected values to compare the actual values with.

Returns:

The return value of the measure.

calculateMeasure

java.util.List<O> calculateMeasure(java.util.List<I> actual,
                                   java.util.List<I> expected)

Computes the measure for a lists of input actual and the expected outcome expected.

Parameters:

actual - The list of actually available values.

expected - The list of expected values to compare the actual values with.

Returns:

The list of return values of the measure.

calculateMeasure

O calculateMeasure(java.util.List<I> actual,
                   java.util.List<I> expected,
                   ai.libs.jaicore.basic.aggregate.IAggregateFunction<O> aggregateFunction)

Computes the measure for lists of input actual and the expected outcome expected and aggregates the measured values with the given aggregation.

Parameters:

actual - The list of actually available values.

expected - The list of expected values to compare the actual values with.

aggregateFunction - The aggregate function to be used to aggregate all the measurements.

Returns:

The aggregated return value of the measure.

calculateAvgMeasure

O calculateAvgMeasure(java.util.List<I> actual,
                      java.util.List<I> expected)

Computes the measure for lists of input actual and the expected outcome expected and aggregates the measured values with the mean, as this is the most frequently used aggregate function.

Parameters:

actual - The list of actually available values.

expected - The list of expected values to compare the actual values with.

aggregateFunction - The aggregate function to be used to aggregate all the measurements.

Returns:

The mean of return values as output by the instance-wise measure.