org.deeplearning4j.earlystopping.termination

Class BestScoreEpochTerminationCondition

java.lang.Object

org.deeplearning4j.earlystopping.termination.BestScoreEpochTerminationCondition

All Implemented Interfaces:

java.io.Serializable, EpochTerminationCondition

public class BestScoreEpochTerminationCondition
extends java.lang.Object
implements EpochTerminationCondition

Created by Sadat Anwar on 3/26/16. Stop the training once we achieved an expected score. Normally this will stop if the current score is lower than the initialized score. If you want to stop the training once the score increases the defined score set the lesserBetter flag to false (feel free to give the flag a better name)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BestScoreEpochTerminationCondition(double bestExpectedScore)
BestScoreEpochTerminationCondition(double bestExpectedScore, boolean lesserBetter)

Method Summary

Modifier and Type	Method and Description
void	initialize() Initialize the epoch termination condition (often a no-op)
boolean	terminate(int epochNum, double score) Should the early stopping training terminate at this epoch, based on the calculated score and the epoch number? Returns true if training should terminated, or false otherwise
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BestScoreEpochTerminationCondition

public BestScoreEpochTerminationCondition(double bestExpectedScore)

BestScoreEpochTerminationCondition

public BestScoreEpochTerminationCondition(double bestExpectedScore,
                                          boolean lesserBetter)

Method Detail

initialize

public void initialize()

Description copied from interface: EpochTerminationCondition

Initialize the epoch termination condition (often a no-op)

Specified by:

initialize in interface EpochTerminationCondition

terminate

public boolean terminate(int epochNum,
                         double score)

Description copied from interface: EpochTerminationCondition

Should the early stopping training terminate at this epoch, based on the calculated score and the epoch number? Returns true if training should terminated, or false otherwise

Specified by:

terminate in interface EpochTerminationCondition

Parameters:

epochNum - Number of the last completed epoch (starting at 0)

score - Score calculate for this epoch

Returns:

Whether training should be terminated at this epoch

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object