Class UsageDetailsBuilder

java.lang.Object
org.tribuo.interop.modelcard.UsageDetailsBuilder
public final class UsageDetailsBuilder extends Object
A builder class for creating an instance of UsageDetails.

  • Constructor Details

    • UsageDetailsBuilder

      public UsageDetailsBuilder()
      Creates an instance of UsageDetails.

  • Method Details

    • getIntendedUse

      public String getIntendedUse()
      Gets the intended use of the model for which an instance of UsageDetails will be built.
      Returns:
      A string specifying the intended use of the model.

    • getIntendedUsers

      public String getIntendedUsers()
      Gets the intended users of the model for which an instance of UsageDetails will be built.
      Returns:
      A string specifying the intended users of the model.

    • getOutOfScopeUses

      public List<String> getOutOfScopeUses()
      Gets the out-of-scope uses of the model for which an instance of UsageDetails will be built.
      Returns:
      A list of out-of-scope uses for the model.

    • getPreProcessingSteps

      public List<String> getPreProcessingSteps()
      Gets the pre-processing steps of the model for which an instance of UsageDetails will be built.
      Returns:
      A list of pre-processing steps for the model.

    • getConsiderations

      public List<String> getConsiderations()
      Gets the considerations of the model for which an instance of UsageDetails will be built.
      Returns:
      A list of considerations for the model.

    • getFactors

      public List<String> getFactors()
      Gets the relevant factors of the model for which an instance of UsageDetails will be built.
      Returns:
      A list of relevant factors for the model.

    • getResources

      public List<String> getResources()
      Gets the relevant resources of the model for which an instance of UsageDetails will be built.
      Returns:
      A list of relevant resources for the model.

    • getPrimaryContact

      public String getPrimaryContact()
      Gets the primary contact person of the model for which an instance of UsageDetails will be built.
      Returns:
      A string specifying the primary contact person of the model.

    • getModelCitation

      public String getModelCitation()
      Gets the model citation of the model for which an instance of UsageDetails will be built.
      Returns:
      A string specifying the model citation of the model.

    • getModelLicense

      public String getModelLicense()
      Gets the model license of the model for which an instance of UsageDetails will be built.
      Returns:
      A string specifying the model license of the model.

    • intendedUse

      public UsageDetailsBuilder intendedUse(String intendedUse)
      Sets the intended use of the model for which an instance of UsageDetails will be built.
      Parameters:
      intendedUse - The intented use of the model.
      Returns:
      This instance of UsageDetailsBuilder.

    • intendedUsers

      public UsageDetailsBuilder intendedUsers(String intendedUsers)
      Sets the intended users of the model for which an instance of UsageDetails will be built.
      Parameters:
      intendedUsers - The intended users of the model.
      Returns:
      This instance of UsageDetailsBuilder.

    • outOfScopeUses

      public UsageDetailsBuilder outOfScopeUses(List<String> uses)
      Sets the out-of-scope uses of the model for which an instance of UsageDetails will be built.
      Parameters:
      uses - Out of scope uses of this model.
      Returns:
      This instance of UsageDetailsBuilder.

    • preProcessingSteps

      public UsageDetailsBuilder preProcessingSteps(List<String> steps)
      Sets the pre-processing steps of the model for which an instance of UsageDetails will be built.
      Parameters:
      steps - Pre-processing steps applied to the data before the model was built.
      Returns:
      This instance of UsageDetailsBuilder.

    • considerations

      public UsageDetailsBuilder considerations(List<String> considerations)
      Sets the considerations of the model for which an instance of UsageDetails will be built.
      Parameters:
      considerations - Considerations for using this model.
      Returns:
      This instance of UsageDetailsBuilder.

    • factors

      public UsageDetailsBuilder factors(List<String> factors)
      Sets the relevant factors of the model for which an instance of UsageDetails will be built.
      Parameters:
      factors - Relevant factors when considering this model.
      Returns:
      This instance of UsageDetailsBuilder.

    • resources

      public UsageDetailsBuilder resources(List<String> resources)
      Sets the relevant resources of the model for which an instance of UsageDetails will be built.
      Parameters:
      resources - Relevant resources when using this model.
      Returns:
      This instance of UsageDetailsBuilder.

    • primaryContact

      public UsageDetailsBuilder primaryContact(String primaryContact)
      Sets the primary contact person of the model for which an instance of UsageDetails will be built.
      Parameters:
      primaryContact - The primary contact for this model.
      Returns:
      This instance of UsageDetailsBuilder.

    • modelCitation

      public UsageDetailsBuilder modelCitation(String modelCitation)
      Sets the model citation of the model for which an instance of UsageDetails will be built.
      Parameters:
      modelCitation - A citation which can be used for this model.
      Returns:
      This instance of UsageDetailsBuilder.

    • modelLicense

      public UsageDetailsBuilder modelLicense(String modelLicense)
      Sets the model license of the model for which an instance of UsageDetails will be built.
      Parameters:
      modelLicense - The license for this model.
      Returns:
      This instance of UsageDetailsBuilder.

    • build

      public UsageDetails build()
      Builds an instance of UsageDetails using the recorded field values or their default values.
      Returns:
      An instance of UsageDetails.

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object