Package opennlp.tools.monitoring

# Class LogLikelihoodThresholdBreached

java.lang.Object
opennlp.tools.monitoring.LogLikelihoodThresholdBreached

All Implemented Interfaces:
  `Predicate<Double>`, `StopCriteria<Double>`

public class LogLikelihoodThresholdBreached extends Object implements StopCriteria<Double>
A `StopCriteria` implementation to identify whether the difference between the log likelihood of current and previous iteration is under the defined threshold.

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `static String`
  `STOP`

  ### Fields inherited from interface opennlp.tools.monitoring.StopCriteria

  `FINISHED`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `LogLikelihoodThresholdBreached(TrainingParameters trainingParameters)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `String`
  `getMessageIfSatisfied()`
  `boolean`
  `test(Double currVsPrevLLDiff)`

  ### Methods inherited from class java.lang.Object

  `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

  ### Methods inherited from interface java.util.function.Predicate

  `and, negate, or`

- ## Field Details

  - ### STOP

    public static String STOP

- ## Constructor Details

  - ### LogLikelihoodThresholdBreached

    public LogLikelihoodThresholdBreached(TrainingParameters trainingParameters)

- ## Method Details

  - ### getMessageIfSatisfied

    public String getMessageIfSatisfied()
    Specified by:
      `getMessageIfSatisfied` in interface `StopCriteria<Double>`
    Returns:
      A detailed message captured upon hitting the `StopCriteria` during model training.

  - ### test

    public boolean test(Double currVsPrevLLDiff)
    Specified by:
      `test` in interface `Predicate<Double>`