ai.djl.training.metrics

Class TopKAccuracy

java.lang.Object

ai.djl.training.metrics.TrainingMetric

ai.djl.training.metrics.Accuracy

ai.djl.training.metrics.TopKAccuracy

All Implemented Interfaces:

java.lang.Cloneable

public class TopKAccuracy
extends Accuracy

TopKAccuracy is a TrainingMetric that computes the accuracy of the top k predictions.

TopKAccuracy differs from Accuracy in that it considers the prediction to be `True` as long as the ground truth label is in the top K predicated labels. If `top_k = 1`, then TopKAccuracy is identical to Accuracy.

Field Summary

Fields inherited from class ai.djl.training.metrics.Accuracy

axis, index

Constructor Summary

Constructors

Constructor and Description
TopKAccuracy(int topK) Creates an instance of TopKAccuracy metric that computes topK accuracy across axis 1 along the 0th index.
TopKAccuracy(int index, int topK) Creates an instance of TopKAccuracy metric that computes topK accuracy across axis 1 along the given index.
TopKAccuracy(java.lang.String name, int index, int topK) Creates a TopKAccuracy instance.

Method Summary

Modifier and Type	Method and Description
void	update(NDArray labels, NDArray predictions) Computes and updates the accuracy based on the labels and predictions.

Methods inherited from class ai.djl.training.metrics.Accuracy

addCorrectInstances, addTotalInstances, getValue, reset, update

Methods inherited from class ai.djl.training.metrics.TrainingMetric

checkLabelShapes, checkLabelShapes, duplicate, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

TopKAccuracy

public TopKAccuracy(java.lang.String name,
                    int index,
                    int topK)

Creates a TopKAccuracy instance.

Parameters:

name - the accuracy name, default "Top_K_Accuracy"

index - the index of the NDArray in labels to compute topK accuracy for

topK - the value of K

TopKAccuracy

public TopKAccuracy(int index,
                    int topK)

Creates an instance of TopKAccuracy metric that computes topK accuracy across axis 1 along the given index.

Parameters:

index - the index of the NDArray in labels to compute topK accuracy for

topK - the value of K

TopKAccuracy

public TopKAccuracy(int topK)

Creates an instance of TopKAccuracy metric that computes topK accuracy across axis 1 along the 0th index.

Parameters:

topK - the value of K

Method Detail

update

public void update(NDArray labels,
                   NDArray predictions)

Computes and updates the accuracy based on the labels and predictions.

Overrides:

update in class Accuracy

Parameters:

labels - a NDList of labels

predictions - a NDList of predictions