Package org.tribuo.interop.modelcard

Class UsageDetails

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

  • Constructor Details

    • UsageDetails

      public UsageDetails(String intendedUse, String intendedUsers, List<String> outOfScopeUses, List<String> preProcessingSteps, List<String> considerations, List<String> factors, List<String> resources, String primaryContact, String modelCitation, String modelLicense)
      Creates an instance of UsageDetails.
      Parameters:
      intendedUse - A string specifying the intended use of the trained model.
      intendedUsers - A string specifying the intended users of the trained model.
      outOfScopeUses - The list of out-of-scope uses of the trained model.
      preProcessingSteps - The list of pre-processing steps for the trained model.
      considerations - The list of considerations for the trained model.
      factors - The list of factors to consider for the trained model.
      resources - The list of relevant resources for the trained model.
      primaryContact - A string specifying the primary contact person of the trained model.
      modelCitation - A string specifying the model citation of the trained model.
      modelLicense - A string specifying the model license of the trained model.

    • UsageDetails

      public UsageDetails(com.fasterxml.jackson.databind.JsonNode usageDetailsJson)
      Creates an instance of UsageDetails.

      Throws JsonProcessingException if a problem is encountered when processing Json content.

      Parameters:
      usageDetailsJson - The Json content corresponding to a serialized UsageDetails that will be used to recreate a new instance of a UsageDetails.

  • Method Details

    • getSchemaVersion

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

    • getIntendedUse

      public String getIntendedUse()
      Gets the intended use of the UsageDetails object.
      Returns:
      A string specifying the intended use of the UsageDetails object.

    • getIntendedUsers

      public String getIntendedUsers()
      Gets the intended users of the UsageDetails object.
      Returns:
      A string specifying the intended users of the UsageDetails object.

    • getOutOfScopeUses

      public List<String> getOutOfScopeUses()
      Gets the out-of-scope uses of the UsageDetails object.
      Returns:
      A list of out-of-scope uses for the UsageDetails object.

    • getPreProcessingSteps

      public List<String> getPreProcessingSteps()
      Gets the pre-processing steps of the UsageDetails object.
      Returns:
      A list of pre-processing steps for the UsageDetails object.

    • getConsiderations

      public List<String> getConsiderations()
      Gets the considerations of the UsageDetails object.
      Returns:
      A list of considerations for the UsageDetails object.

    • getFactors

      public List<String> getFactors()
      Gets the relevant factors of the UsageDetails object.
      Returns:
      A list of relevant factors for the UsageDetails object.

    • getResources

      public List<String> getResources()
      Gets the relevant resources of the UsageDetails object.
      Returns:
      A list of relevant resources for the UsageDetails object.

    • getPrimaryContact

      public String getPrimaryContact()
      Gets the primary contact person of the UsageDetails object.
      Returns:
      The primary contact person for the UsageDetails object.

    • getModelCitation

      public String getModelCitation()
      Gets the model citation of the UsageDetails object.
      Returns:
      The model citation for the UsageDetails object.

    • getModelLicense

      public String getModelLicense()
      Gets the model license of the UsageDetails object.
      Returns:
      The model license for the UsageDetails object.

    • toJson

      public com.fasterxml.jackson.databind.node.ObjectNode toJson()
      Creates a Json object corresponding this UsageDetails instance.
      Returns:
      The ObjectNode corresponding to this UsageDetails 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