Package io.github.kirstenali.deepj.tensor

Record Class CrossEntropyResult

java.lang.Object
java.lang.Record
io.github.kirstenali.deepj.tensor.CrossEntropyResult
public record CrossEntropyResult(Tensor loss, Tensor gradient) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    CrossEntropyResult(Tensor loss, Tensor gradient)
    Creates an instance of a CrossEntropyResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Tensor
    gradient()
    Returns the value of the gradient record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    Tensor
    loss()
    Returns the value of the loss record component.
    float
    meanLoss()
     
    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

    • CrossEntropyResult

      public CrossEntropyResult(Tensor loss, Tensor gradient)
      Creates an instance of a CrossEntropyResult record class.
      Parameters:
      loss - the value for the loss record component
      gradient - the value for the gradient record component

  • Method Details

    • meanLoss

      public float meanLoss()

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

    • loss

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

    • gradient

      public Tensor gradient()
      Returns the value of the gradient record component.
      Returns:
      the value of the gradient record component