Package io.github.kirstenali.deepj.training

Record Class CosineLearningRateSchedule

java.lang.Object
java.lang.Record
io.github.kirstenali.deepj.training.CosineLearningRateSchedule
public record CosineLearningRateSchedule(float peakLearningRate, float minimumLearningRate, int warmupSteps, int totalSteps) extends Record
Linear warmup followed by cosine decay.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CosineLearningRateSchedule(float peakLearningRate, float minimumLearningRate, int warmupSteps, int totalSteps)
    Creates an instance of a CosineLearningRateSchedule record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    float
    learningRate(int step)
     
    float
    minimumLearningRate()
    Returns the value of the minimumLearningRate record component.
    float
    peakLearningRate()
    Returns the value of the peakLearningRate record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    totalSteps()
    Returns the value of the totalSteps record component.
    int
    warmupSteps()
    Returns the value of the warmupSteps record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CosineLearningRateSchedule

      public CosineLearningRateSchedule(float peakLearningRate, float minimumLearningRate, int warmupSteps, int totalSteps)
      Creates an instance of a CosineLearningRateSchedule record class.
      Parameters:
      peakLearningRate - the value for the peakLearningRate record component
      minimumLearningRate - the value for the minimumLearningRate record component
      warmupSteps - the value for the warmupSteps record component
      totalSteps - the value for the totalSteps record component

  • Method Details

    • learningRate

      public float learningRate(int step)

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

    • peakLearningRate

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

    • minimumLearningRate

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

    • warmupSteps

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

    • totalSteps

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