org.nd4j.autodiff.listeners

Class BaseEvaluationListener

java.lang.Object

org.nd4j.autodiff.listeners.BaseListener

org.nd4j.autodiff.listeners.BaseEvaluationListener

All Implemented Interfaces:

Listener

Direct Known Subclasses:

HistoryListener

public abstract class BaseEvaluationListener
extends BaseListener

A base listener class that will preform the provided evaluations, and provide the results in epochEnd and validationDone Instead of overriding requiredVariables, epochStart, epochEnd, validationDone, and/or opExecution, override otherRequiredVariables, epochStartEvaluations, epochEndEvaluations, validationDoneEvaluations, and/or opExecutionEvaluations If you want to use Evaluations in your listener, extend this class

Constructor Summary

Constructors

Constructor and Description
BaseEvaluationListener()

Method Summary

Modifier and Type	Method and Description
void	activationAvailable(SameDiff sd, At at, MultiDataSet batch, SameDiffOp op, String varName, INDArray activation) Called when any activation becomes available.
void	activationAvailableEvaluations(SameDiff sd, At at, MultiDataSet batch, SameDiffOp op, String varName, INDArray activation) See Listener.activationAvailable(SameDiff, At, MultiDataSet, SameDiffOp, String, INDArray)
ListenerResponse	epochEnd(SameDiff sd, At at, LossCurve lossCurve, long epochTimeMillis) Called at the end of every epoch, when fitting from an iterator
ListenerResponse	epochEndEvaluations(SameDiff sd, At at, LossCurve lossCurve, long epochTimeMillis, EvaluationRecord evaluations) See Listener.epochEnd(SameDiff, At, LossCurve, long), also provided the requested evaluations
void	epochStart(SameDiff sd, At at) Called at the start of every epoch, when fitting from an iterator
void	epochStartEvaluations(SameDiff sd, At at) See Listener.epochStart(SameDiff, At)
abstract ListenerEvaluations	evaluations() Return the requested evaluations.
ListenerVariables	otherRequiredVariables(SameDiff sd) Return any requested variables that are not part of the evaluations
ListenerVariables	requiredVariables(SameDiff sd) Required variables for this listener.
ListenerResponse	validationDone(SameDiff sd, At at, long validationTimeMillis) Called after the end of every epoch, once validation evaluation is done, when training
ListenerResponse	validationDoneEvaluations(SameDiff sd, At at, long validationTimeMillis, EvaluationRecord evaluations) See Listener.validationDone(SameDiff, At, long), also provided the requested evaluations

Methods inherited from class org.nd4j.autodiff.listeners.BaseListener

iterationDone, iterationStart, operationEnd, operationStart, opExecution, preOpExecution, preUpdate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nd4j.autodiff.listeners.Listener

isActive

Constructor Detail

BaseEvaluationListener

public BaseEvaluationListener()

Method Detail

evaluations

public abstract ListenerEvaluations evaluations()

Return the requested evaluations. New instances of these evaluations will be made each time they are used

requiredVariables

public final ListenerVariables requiredVariables(SameDiff sd)

Description copied from interface: Listener

Required variables for this listener.

Used to ensure these variables end up in the minimum required subgraph calculated by InferenceSession. Otherwise, if the variables weren't required by a loss variable, they would not be calculated.

Any variables in here are guaranteed to have Listener.activationAvailable(SameDiff, At, MultiDataSet, SameDiffOp, String, INDArray) called for them, regardless of whether they would normally be calculated or not.

Specified by:

requiredVariables in interface Listener

Overrides:

requiredVariables in class BaseListener

otherRequiredVariables

public ListenerVariables otherRequiredVariables(SameDiff sd)

Return any requested variables that are not part of the evaluations

epochStart

public final void epochStart(SameDiff sd,
                             At at)

Description copied from interface: Listener

Called at the start of every epoch, when fitting from an iterator

Specified by:

epochStart in interface Listener

Overrides:

epochStart in class BaseListener

Parameters:

sd - The SameDiff instance

at - Current iteration/epoch etc

epochStartEvaluations

public void epochStartEvaluations(SameDiff sd,
                                  At at)

See Listener.epochStart(SameDiff, At)

epochEnd

public final ListenerResponse epochEnd(SameDiff sd,
                                       At at,
                                       LossCurve lossCurve,
                                       long epochTimeMillis)

Description copied from interface: Listener

Called at the end of every epoch, when fitting from an iterator

Specified by:

epochEnd in interface Listener

Overrides:

epochEnd in class BaseListener

Parameters:

sd - The SameDiff instance

at - Current iteration/epoch etc

lossCurve - The losses so far

epochTimeMillis - How long this epoch took

Returns:

ListenerResponse.STOP to stop training, CONTINUE or null to continue

epochEndEvaluations

public ListenerResponse epochEndEvaluations(SameDiff sd,
                                            At at,
                                            LossCurve lossCurve,
                                            long epochTimeMillis,
                                            EvaluationRecord evaluations)

See Listener.epochEnd(SameDiff, At, LossCurve, long), also provided the requested evaluations

validationDone

public final ListenerResponse validationDone(SameDiff sd,
                                             At at,
                                             long validationTimeMillis)

Description copied from interface: Listener

Called after the end of every epoch, once validation evaluation is done, when training

Specified by:

validationDone in interface Listener

Overrides:

validationDone in class BaseListener

Parameters:

sd - The SameDiff instance

at - Current iteration/epoch etc

validationTimeMillis - How long validation took for this epoch

Returns:

ListenerResponse.STOP to stop training, CONTINUE or null to continue

validationDoneEvaluations

public ListenerResponse validationDoneEvaluations(SameDiff sd,
                                                  At at,
                                                  long validationTimeMillis,
                                                  EvaluationRecord evaluations)

See Listener.validationDone(SameDiff, At, long), also provided the requested evaluations

activationAvailable

public final void activationAvailable(SameDiff sd,
                                      At at,
                                      MultiDataSet batch,
                                      SameDiffOp op,
                                      String varName,
                                      INDArray activation)

Description copied from interface: Listener

Called when any activation becomes available.

The activation will most likely be freed later, use detach() if you need to save it.

Note that this method will be called when any activation becomes available, not just ones from Listener.requiredVariables(SameDiff)
It is guaranteed to be called for variables from requiredVariables().

Note that the activations here overlap with Listener.opExecution(SameDiff, At, MultiDataSet, SameDiffOp, INDArray[]) - both contain the same information/arrays

Specified by:

activationAvailable in interface Listener

Overrides:

activationAvailable in class BaseListener

Parameters:

sd - The SameDiff instance

at - Current iteration/epoch etc

batch - The batch's input data. May be null if not called with a batch

op - Operation that has just been executed

varName - The name of the variable

activation - The variable's activation

activationAvailableEvaluations

public void activationAvailableEvaluations(SameDiff sd,
                                           At at,
                                           MultiDataSet batch,
                                           SameDiffOp op,
                                           String varName,
                                           INDArray activation)

See Listener.activationAvailable(SameDiff, At, MultiDataSet, SameDiffOp, String, INDArray)