Package io.github.kirstenali.deepj.training

Record Class TrainingProgress

java.lang.Object
java.lang.Record
io.github.kirstenali.deepj.training.TrainingProgress
public record TrainingProgress(int completedSteps, float lastLoss, float emaLoss) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    TrainingProgress(int completedSteps, float lastLoss, float emaLoss)
    Creates an instance of a TrainingProgress record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    completedSteps()
    Returns the value of the completedSteps record component.
    float
    emaLoss()
    Returns the value of the emaLoss record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    static TrainingProgress
    initial()
     
    float
    lastLoss()
    Returns the value of the lastLoss record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • TrainingProgress

      public TrainingProgress(int completedSteps, float lastLoss, float emaLoss)
      Creates an instance of a TrainingProgress record class.
      Parameters:
      completedSteps - the value for the completedSteps record component
      lastLoss - the value for the lastLoss record component
      emaLoss - the value for the emaLoss record component

  • Method Details

    • initial

      public static TrainingProgress initial()

    • 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 '=='.
      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.

    • completedSteps

      public int completedSteps()
      Returns the value of the completedSteps record component.
      Returns:
      the value of the completedSteps record component

    • lastLoss

      public float lastLoss()
      Returns the value of the lastLoss record component.
      Returns:
      the value of the lastLoss record component

    • emaLoss

      public float emaLoss()
      Returns the value of the emaLoss record component.
      Returns:
      the value of the emaLoss record component