io.datahubproject.openapi.generated

Class MLModelProperties

java.lang.Object

io.datahubproject.openapi.generated.MLModelProperties

All Implemented Interfaces:

OneOfEnvelopedAspectValue, OneOfGenericAspectValue, OneOfMLModelSnapshotAspectsItems, OneOfVersionedAspectAspect

@Validated
 @Generated(value="io.swagger.codegen.v3.generators.java.SpringCodegen",
           date="2022-09-21T05:34:26.783Z[Etc/UTC]")
public class MLModelProperties
extends java.lang.Object
implements OneOfEnvelopedAspectValue, OneOfGenericAspectValue, OneOfMLModelSnapshotAspectsItems, OneOfVersionedAspectAspect

Properties associated with a ML Model

Constructor Summary

Constructors

Constructor and Description
MLModelProperties()

Method Summary

Modifier and Type	Method and Description
MLModelProperties	addDeploymentsItem(java.lang.String deploymentsItem)
MLModelProperties	addDownstreamJobsItem(java.lang.String downstreamJobsItem)
MLModelProperties	addGroupsItem(java.lang.String groupsItem)
MLModelProperties	addHyperParamsItem(MLHyperParam hyperParamsItem)
MLModelProperties	addMlFeaturesItem(java.lang.String mlFeaturesItem)
MLModelProperties	addOnlineMetricsItem(MLMetric onlineMetricsItem)
MLModelProperties	addTagsItem(java.lang.String tagsItem)
MLModelProperties	addTrainingJobsItem(java.lang.String trainingJobsItem)
MLModelProperties	addTrainingMetricsItem(MLMetric trainingMetricsItem)
MLModelProperties	customProperties(java.util.Map<java.lang.String,java.lang.String> customProperties)
MLModelProperties	date(java.lang.Long date)
MLModelProperties	deployments(java.util.List<java.lang.String> deployments)
MLModelProperties	description(java.lang.String description)
MLModelProperties	downstreamJobs(java.util.List<java.lang.String> downstreamJobs)
boolean	equals(java.lang.Object o)
MLModelProperties	externalUrl(java.lang.String externalUrl)
@NotNull java.lang.String	get__type() Name of this subclass in SimpleClassName format
@NotNull java.util.Map<java.lang.String,java.lang.String>	getCustomProperties() Custom property bag.
@Min(value=-9223372036854775808L) @Max(value=9223372036854775807L) java.lang.Long	getDate() Date when the MLModel was developed minimum: -9223372036854775808 maximum: 9223372036854775807
java.util.List<java.lang.String>	getDeployments() Deployments for the MLModel
java.lang.String	getDescription() Documentation of the MLModel
java.util.List<java.lang.String>	getDownstreamJobs() List of jobs (if any) that use the model
java.lang.String	getExternalUrl() URL where the reference exist
java.util.List<java.lang.String>	getGroups() Groups the model belongs to
java.util.Map<java.lang.String,java.lang.String>	getHyperParameters() Hyper Parameters of the MLModel NOTE: these are deprecated in favor of hyperParams
@Valid java.util.List<MLHyperParam>	getHyperParams() Hyperparameters of the MLModel
java.util.List<java.lang.String>	getMlFeatures() List of features used for MLModel training
@Valid java.util.List<MLMetric>	getOnlineMetrics() Metrics of the MLModel used in production
@NotNull java.util.List<java.lang.String>	getTags() Tags for the MLModel
java.util.List<java.lang.String>	getTrainingJobs() List of jobs (if any) used to train the model
@Valid java.util.List<MLMetric>	getTrainingMetrics() Metrics of the MLModel used in training
java.lang.String	getType() Type of Algorithm or MLModel such as whether it is a Naive Bayes classifier, Convolutional Neural Network, etc
@Valid VersionTag	getVersion() Get version
MLModelProperties	groups(java.util.List<java.lang.String> groups)
int	hashCode()
MLModelProperties	hyperParameters(java.util.Map<java.lang.String,java.lang.String> hyperParameters)
MLModelProperties	hyperParams(java.util.List<MLHyperParam> hyperParams)
MLModelProperties	mlFeatures(java.util.List<java.lang.String> mlFeatures)
MLModelProperties	onlineMetrics(java.util.List<MLMetric> onlineMetrics)
MLModelProperties	putCustomPropertiesItem(java.lang.String key, java.lang.String customPropertiesItem)
MLModelProperties	putHyperParametersItem(java.lang.String key, java.lang.String hyperParametersItem)
void	setCustomProperties(java.util.Map<java.lang.String,java.lang.String> customProperties)
void	setDate(java.lang.Long date)
void	setDeployments(java.util.List<java.lang.String> deployments)
void	setDescription(java.lang.String description)
void	setDownstreamJobs(java.util.List<java.lang.String> downstreamJobs)
void	setExternalUrl(java.lang.String externalUrl)
void	setGroups(java.util.List<java.lang.String> groups)
void	setHyperParameters(java.util.Map<java.lang.String,java.lang.String> hyperParameters)
void	setHyperParams(java.util.List<MLHyperParam> hyperParams)
void	setMlFeatures(java.util.List<java.lang.String> mlFeatures)
void	setOnlineMetrics(java.util.List<MLMetric> onlineMetrics)
void	setTags(java.util.List<java.lang.String> tags)
void	setTrainingJobs(java.util.List<java.lang.String> trainingJobs)
void	setTrainingMetrics(java.util.List<MLMetric> trainingMetrics)
void	setType(java.lang.String type)
void	setVersion(VersionTag version)
MLModelProperties	tags(java.util.List<java.lang.String> tags)
java.lang.String	toString()
MLModelProperties	trainingJobs(java.util.List<java.lang.String> trainingJobs)
MLModelProperties	trainingMetrics(java.util.List<MLMetric> trainingMetrics)
MLModelProperties	type(java.lang.String type)
MLModelProperties	version(VersionTag version)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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)

date

public MLModelProperties date(java.lang.Long date)

getDate

@Min(value=-9223372036854775808L)
 @Max(value=9223372036854775807L)
public @Min(value=-9223372036854775808L) @Max(value=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)

version

public MLModelProperties version(VersionTag version)

getVersion

@Valid
public @Valid VersionTag getVersion()

Get version

Returns:

version

setVersion

public void setVersion(VersionTag version)

type

public MLModelProperties type(java.lang.String type)

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)

hyperParams

public MLModelProperties hyperParams(java.util.List<MLHyperParam> hyperParams)

addHyperParamsItem

public MLModelProperties addHyperParamsItem(MLHyperParam hyperParamsItem)

getHyperParams

@Valid
public @Valid java.util.List<MLHyperParam> getHyperParams()

Hyperparameters of the MLModel

Returns:

hyperParams

setHyperParams

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

trainingMetrics

public MLModelProperties trainingMetrics(java.util.List<MLMetric> trainingMetrics)

addTrainingMetricsItem

public MLModelProperties addTrainingMetricsItem(MLMetric trainingMetricsItem)

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)

onlineMetrics

public MLModelProperties onlineMetrics(java.util.List<MLMetric> onlineMetrics)

addOnlineMetricsItem

public MLModelProperties addOnlineMetricsItem(MLMetric onlineMetricsItem)

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)

tags

public MLModelProperties tags(java.util.List<java.lang.String> tags)

addTagsItem

public MLModelProperties addTagsItem(java.lang.String tagsItem)

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