Class MLModelProperties

    • Constructor Detail

      • MLModelProperties

        public MLModelProperties()
    • Method Detail

      • get__type

        @NotNull
        public @NotNull java.lang.String get__type()
        Name of this subclass in SimpleClassName format
        Returns:
        __type
      • customProperties

        public MLModelProperties customProperties​(java.util.Map<java.lang.String,​java.lang.String> customProperties)
      • putCustomPropertiesItem

        public MLModelProperties putCustomPropertiesItem​(java.lang.String key,
                                                         java.lang.String customPropertiesItem)
      • getCustomProperties

        @NotNull
        public @NotNull java.util.Map<java.lang.String,​java.lang.String> getCustomProperties()
        Custom property bag.
        Returns:
        customProperties
      • setCustomProperties

        public void setCustomProperties​(java.util.Map<java.lang.String,​java.lang.String> customProperties)
      • externalUrl

        public MLModelProperties externalUrl​(java.lang.String externalUrl)
      • getExternalUrl

        public java.lang.String getExternalUrl()
        URL where the reference exist
        Returns:
        externalUrl
      • setExternalUrl

        public void setExternalUrl​(java.lang.String externalUrl)
      • description

        public MLModelProperties description​(java.lang.String description)
      • getDescription

        public java.lang.String getDescription()
        Documentation of the MLModel
        Returns:
        description
      • setDescription

        public void setDescription​(java.lang.String description)
      • getDate

        @Min(-9223372036854775808L)
        @Max(9223372036854775807L)
        public @Min(-9223372036854775808L) @Max(9223372036854775807L) java.lang.Long getDate()
        Date when the MLModel was developed minimum: -9223372036854775808 maximum: 9223372036854775807
        Returns:
        date
      • setDate

        public void setDate​(java.lang.Long date)
      • getVersion

        @Valid
        public @Valid VersionTag getVersion()
        Get version
        Returns:
        version
      • setVersion

        public void setVersion​(VersionTag version)
      • getType

        public java.lang.String getType()
        Type of Algorithm or MLModel such as whether it is a Naive Bayes classifier, Convolutional Neural Network, etc
        Returns:
        type
      • setType

        public void setType​(java.lang.String type)
      • hyperParameters

        public MLModelProperties hyperParameters​(java.util.Map<java.lang.String,​java.lang.String> hyperParameters)
      • putHyperParametersItem

        public MLModelProperties putHyperParametersItem​(java.lang.String key,
                                                        java.lang.String hyperParametersItem)
      • getHyperParameters

        public java.util.Map<java.lang.String,​java.lang.String> getHyperParameters()
        Hyper Parameters of the MLModel NOTE: these are deprecated in favor of hyperParams
        Returns:
        hyperParameters
      • setHyperParameters

        public void setHyperParameters​(java.util.Map<java.lang.String,​java.lang.String> hyperParameters)
      • getHyperParams

        @Valid
        public @Valid java.util.List<MLHyperParam> getHyperParams()
        Hyperparameters of the MLModel
        Returns:
        hyperParams
      • setHyperParams

        public void setHyperParams​(java.util.List<MLHyperParam> hyperParams)
      • getTrainingMetrics

        @Valid
        public @Valid java.util.List<MLMetric> getTrainingMetrics()
        Metrics of the MLModel used in training
        Returns:
        trainingMetrics
      • setTrainingMetrics

        public void setTrainingMetrics​(java.util.List<MLMetric> trainingMetrics)
      • getOnlineMetrics

        @Valid
        public @Valid java.util.List<MLMetric> getOnlineMetrics()
        Metrics of the MLModel used in production
        Returns:
        onlineMetrics
      • setOnlineMetrics

        public void setOnlineMetrics​(java.util.List<MLMetric> onlineMetrics)
      • mlFeatures

        public MLModelProperties mlFeatures​(java.util.List<java.lang.String> mlFeatures)
      • addMlFeaturesItem

        public MLModelProperties addMlFeaturesItem​(java.lang.String mlFeaturesItem)
      • getMlFeatures

        public java.util.List<java.lang.String> getMlFeatures()
        List of features used for MLModel training
        Returns:
        mlFeatures
      • setMlFeatures

        public void setMlFeatures​(java.util.List<java.lang.String> mlFeatures)
      • getTags

        @NotNull
        public @NotNull java.util.List<java.lang.String> getTags()
        Tags for the MLModel
        Returns:
        tags
      • setTags

        public void setTags​(java.util.List<java.lang.String> tags)
      • deployments

        public MLModelProperties deployments​(java.util.List<java.lang.String> deployments)
      • addDeploymentsItem

        public MLModelProperties addDeploymentsItem​(java.lang.String deploymentsItem)
      • getDeployments

        public java.util.List<java.lang.String> getDeployments()
        Deployments for the MLModel
        Returns:
        deployments
      • setDeployments

        public void setDeployments​(java.util.List<java.lang.String> deployments)
      • trainingJobs

        public MLModelProperties trainingJobs​(java.util.List<java.lang.String> trainingJobs)
      • addTrainingJobsItem

        public MLModelProperties addTrainingJobsItem​(java.lang.String trainingJobsItem)
      • getTrainingJobs

        public java.util.List<java.lang.String> getTrainingJobs()
        List of jobs (if any) used to train the model
        Returns:
        trainingJobs
      • setTrainingJobs

        public void setTrainingJobs​(java.util.List<java.lang.String> trainingJobs)
      • downstreamJobs

        public MLModelProperties downstreamJobs​(java.util.List<java.lang.String> downstreamJobs)
      • addDownstreamJobsItem

        public MLModelProperties addDownstreamJobsItem​(java.lang.String downstreamJobsItem)
      • getDownstreamJobs

        public java.util.List<java.lang.String> getDownstreamJobs()
        List of jobs (if any) that use the model
        Returns:
        downstreamJobs
      • setDownstreamJobs

        public void setDownstreamJobs​(java.util.List<java.lang.String> downstreamJobs)
      • groups

        public MLModelProperties groups​(java.util.List<java.lang.String> groups)
      • addGroupsItem

        public MLModelProperties addGroupsItem​(java.lang.String groupsItem)
      • getGroups

        public java.util.List<java.lang.String> getGroups()
        Groups the model belongs to
        Returns:
        groups
      • setGroups

        public void setGroups​(java.util.List<java.lang.String> groups)
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object