Package io.github.kirstenali.deepj.publishing

Record Class ModelCard

java.lang.Object
java.lang.Record
io.github.kirstenali.deepj.publishing.ModelCard
public record ModelCard(String name, String summary, String license, String language, String trainingData, String limitations) extends Record
Descriptive metadata used to build a Hugging Face model card.

  • Constructor Details

    • ModelCard

      public ModelCard(String name, String summary, String license, String language, String trainingData, String limitations)
      Creates an instance of a ModelCard record class.
      Parameters:
      name - the value for the name record component
      summary - the value for the summary record component
      license - the value for the license record component
      language - the value for the language record component
      trainingData - the value for the trainingData record component
      limitations - the value for the limitations 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.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • summary

      public String summary()
      Returns the value of the summary record component.
      Returns:
      the value of the summary record component

    • license

      public String license()
      Returns the value of the license record component.
      Returns:
      the value of the license record component

    • language

      public String language()
      Returns the value of the language record component.
      Returns:
      the value of the language record component

    • trainingData

      public String trainingData()
      Returns the value of the trainingData record component.
      Returns:
      the value of the trainingData record component

    • limitations

      public String limitations()
      Returns the value of the limitations record component.
      Returns:
      the value of the limitations record component