Package org.tribuo.interop.modelcard

Class ModelDetails

java.lang.Object
org.tribuo.interop.modelcard.ModelDetails
public final class ModelDetails extends Object
ModelDetails section of a ModelCard.

  • Constructor Details

    • ModelDetails

      public ModelDetails(Model<?> model)
      Creates an instance of ModelDetails.
      Parameters:
      model - The trained Model for which a ModelDetails will be built.

    • ModelDetails

      public ModelDetails(com.fasterxml.jackson.databind.JsonNode modelDetailsJson) throws com.fasterxml.jackson.core.JsonProcessingException
      Creates an instance of ModelDetails.
      Parameters:
      modelDetailsJson - The Json content corresponding to a serialized ModelDetails that will be used to recreate a new instance of a ModelDetails.
      Throws:
      com.fasterxml.jackson.core.JsonProcessingException - if a problem is encountered when processing Json content.

  • Method Details

    • getSchemaVersion

      public String getSchemaVersion()
      Gets the schema version of the ModelDetails object.
      Returns:
      A string specifying the schema version of the ModelDetails object.

    • getModelType

      public String getModelType()
      Gets the model type of the ModelDetails object.
      Returns:
      A string specifying the model type of the ModelDetails object.

    • getModelPackage

      public String getModelPackage()
      Gets the model package of the ModelDetails object.
      Returns:
      A string specifying the model package of the ModelDetails object.

    • getTribuoVersion

      public String getTribuoVersion()
      Gets the Tribuo version of the ModelDetails object.
      Returns:
      A string specifying the Tribuo version of the ModelDetails object.

    • getJavaVersion

      public String getJavaVersion()
      Gets the Java version of the ModelDetails object.
      Returns:
      A string specifying the Java version of the ModelDetails object.

    • getConfiguredParams

      public Map<String,Object> getConfiguredParams()
      Gets the configured parameters of the ModelDetails object.
      Returns:
      An unmodifiable map of the configured parameters of the ModelDetails object.

    • toJson

      public com.fasterxml.jackson.databind.node.ObjectNode toJson()
      Creates a Json object corresponding this ModelDetails instance.
      Returns:
      The ObjectNode corresponding to this ModelDetails instance.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object