ai.djl.training.metrics

Class BoundingBoxError

java.lang.Object

ai.djl.training.metrics.TrainingMetric

ai.djl.training.metrics.BoundingBoxError

All Implemented Interfaces:

java.lang.Cloneable

public class BoundingBoxError
extends TrainingMetric

BoundingBoxError is a TrainingMetric that computes the error in the prediction of bounding boxes in SingleShotDetection model.

Constructor Summary

Constructors

Constructor and Description
BoundingBoxError(java.lang.String name) Creates an BoundingBoxError metric.

Method Summary

Modifier and Type	Method and Description
TrainingMetric	duplicate() Creates and returns a copy of this object.
float	getValue() Calculates metric values.
void	reset() Resets metric values.
void	update(NDList labels, NDList predictions) Computes and updates the detection bounding box prediction error based on NDList of labels and predictions.

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

checkLabelShapes, checkLabelShapes, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

BoundingBoxError

public BoundingBoxError(java.lang.String name)

Creates an BoundingBoxError metric.

Parameters:

name - the name of the metric.

Method Detail

update

public void update(NDList labels,
                   NDList predictions)

Computes and updates the detection bounding box prediction error based on NDList of labels and predictions.

First compute bounding box labels and bounding box masks using the MultiBoxTarget operator. Then compute bounding box error based on bounding box labels and predictions.

Specified by:

update in class TrainingMetric

Parameters:

labels - the NDList of labels

predictions - the NDList of predictions

duplicate

public TrainingMetric duplicate()

Description copied from class: TrainingMetric

Creates and returns a copy of this object.

Overrides:

duplicate in class TrainingMetric

Returns:

a copy of this TrainingMetric

reset

public void reset()

Resets metric values.

Specified by:

reset in class TrainingMetric

getValue

public float getValue()

Calculates metric values.

Specified by:

getValue in class TrainingMetric

Returns:

a Pair of metric name and value