Package io.github.kirstenali.deepj.training

Record Class EvaluationResult

java.lang.Object
java.lang.Record
io.github.kirstenali.deepj.training.EvaluationResult
public record EvaluationResult(double loss, double perplexity, long tokens) extends Record
Aggregate causal language-model evaluation metrics.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EvaluationResult(double loss, double perplexity, long tokens)
    Creates an instance of a EvaluationResult 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.
    double
    loss()
    Returns the value of the loss record component.
    double
    perplexity()
    Returns the value of the perplexity record component.
    long
    tokens()
    Returns the value of the tokens 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

    • EvaluationResult

      public EvaluationResult(double loss, double perplexity, long tokens)
      Creates an instance of a EvaluationResult record class.
      Parameters:
      loss - the value for the loss record component
      perplexity - the value for the perplexity record component
      tokens - the value for the tokens 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 '=='.
      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.

    • loss

      public double loss()
      Returns the value of the loss record component.
      Returns:
      the value of the loss record component

    • perplexity

      public double perplexity()
      Returns the value of the perplexity record component.
      Returns:
      the value of the perplexity record component

    • tokens

      public long tokens()
      Returns the value of the tokens record component.
      Returns:
      the value of the tokens record component