Package ai.djl.training.evaluator

Class IndexEvaluator

java.lang.Object

ai.djl.training.evaluator.Evaluator

ai.djl.training.evaluator.IndexEvaluator

public class IndexEvaluator
extends Evaluator

A wrapper for an Evaluator that evaluates on only a particular NDArray in the predictions and/or labels NDLists.

Field Summary

Fields inherited from class ai.djl.training.evaluator.Evaluator

totalInstances

Constructor Summary

Constructors

Constructor	Description
IndexEvaluator(Evaluator evaluator, int index)	Constructs an IndexEvaluator with the same index for both predictions and labels.
IndexEvaluator(Evaluator evaluator, Integer predictionsIndex, Integer labelsIndex)	Constructs an IndexEvaluator.

Method Summary

Modifier and Type	Method	Description
void	addAccumulator(String key)	Adds an accumulator for the results of the evaluation with the given key.
NDArray	evaluate(NDList labels, NDList predictions)	Calculates the evaluation between the labels and the predictions.
float	getAccumulator(String key)	Returns the accumulated evaluator value.
void	resetAccumulator(String key)	Resets the evaluator value with the given key.
void	updateAccumulator(String key, NDList labels, NDList predictions)	Updates the evaluator with the given key based on a NDList of labels and predictions.
void	updateAccumulators(String[] keys, NDList labels, NDList predictions)	Updates the evaluator with the given keys based on a NDList of labels and predictions.

Methods inherited from class ai.djl.training.evaluator.Evaluator

checkLabelShapes, checkLabelShapes, getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

IndexEvaluator

public IndexEvaluator(Evaluator evaluator,
 int index)

Constructs an IndexEvaluator with the same index for both predictions and labels.

Parameters:

evaluator - the base evaluator

index - the index for both predictions and labels

IndexEvaluator

public IndexEvaluator(Evaluator evaluator,
 Integer predictionsIndex,
 Integer labelsIndex)

Constructs an IndexEvaluator.

Parameters:

evaluator - the base evaluator

predictionsIndex - the predictions index

labelsIndex - the labels index

Method Details

evaluate

public NDArray evaluate(NDList labels,
 NDList predictions)

Calculates the evaluation between the labels and the predictions.

Specified by:

evaluate in class Evaluator

Parameters:

labels - the correct values

predictions - the predicted values

Returns:

the evaluation result

addAccumulator

public void addAccumulator(String key)

Adds an accumulator for the results of the evaluation with the given key.

Specified by:

addAccumulator in class Evaluator

Parameters:

key - the key for the new accumulator

updateAccumulator

public void updateAccumulator(String key,
 NDList labels,
 NDList predictions)

Updates the evaluator with the given key based on a NDList of labels and predictions.

This is a synchronized operation. You should only call it at the end of a batch or epoch.

Specified by:

updateAccumulator in class Evaluator

Parameters:

key - the key of the accumulator to update

labels - a NDList of labels

predictions - a NDList of predictions

updateAccumulators

public void updateAccumulators(String[] keys,
 NDList labels,
 NDList predictions)

Updates the evaluator with the given keys based on a NDList of labels and predictions.

This is a synchronized operation. You should only call it at the end of a batch or epoch.

This is an alternative to @{link Evaluator.updateAccumulator(String, NDList, NDList)} that may be more efficient when updating multiple accumulators at once.

Overrides:

updateAccumulators in class Evaluator

Parameters:

keys - the keys of all the accumulators to update

labels - a NDList of labels

predictions - a NDList of predictions

resetAccumulator

public void resetAccumulator(String key)

Resets the evaluator value with the given key.

Specified by:

resetAccumulator in class Evaluator

Parameters:

key - the key of the accumulator to reset

getAccumulator

public float getAccumulator(String key)

Returns the accumulated evaluator value.

Specified by:

getAccumulator in class Evaluator

Parameters:

key - the key of the accumulator to get

Returns:

the accumulated value