Package opennlp.tools.util

Record Class TrainingConfiguration

java.lang.Object
java.lang.Record
opennlp.tools.util.TrainingConfiguration
Record Components:
progMon - TrainingProgressMonitor used to monitor the training progress.
stopCriteria - StopCriteria used to abort training when the criteria is met.
public record TrainingConfiguration(TrainingProgressMonitor progMon, StopCriteria<Double> stopCriteria) extends Record
Configuration used for AbstractModel training.

  • Constructor Details

    • TrainingConfiguration

      public TrainingConfiguration(TrainingProgressMonitor progMon, StopCriteria<Double> stopCriteria)
      Creates an instance of a TrainingConfiguration record class.
      Parameters:
      progMon - the value for the progMon record component
      stopCriteria - the value for the stopCriteria record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • progMon

      public TrainingProgressMonitor progMon()
      Returns the value of the progMon record component.
      Returns:
      the value of the progMon record component

    • stopCriteria

      public StopCriteria<Double> stopCriteria()
      Returns the value of the stopCriteria record component.
      Returns:
      the value of the stopCriteria record component