com.oracle.bmc.datascience.model

Class Metadata

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.datascience.model.Metadata

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190101")
public final class Metadata
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Defines properties of each model metadata.
Note: Objects should always be created or deserialized using the Metadata.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Metadata.Builder, which maintain a set of all explicitly set fields called Metadata.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Metadata.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
Metadata(String key, String value, String description, String category) Deprecated.

Method Summary

Modifier and Type	Method and Description
static Metadata.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getCategory() Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values “Performance,Training Profile,Training and Validation Datasets,Training Environment,other”.
String	getDescription() Description of model metadata
String	getKey() Key of the model Metadata.
String	getValue() Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other
int	hashCode()
Metadata.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

Metadata

@Deprecated
 @ConstructorProperties(value={"key","value","description","category"})
public Metadata(String key,
                                                                                                    String value,
                                                                                                    String description,
                                                                                                    String category)

Deprecated.

Method Detail

builder

public static Metadata.Builder builder()

Create a new builder.

toBuilder

public Metadata.Builder toBuilder()

getKey

public String getKey()

Key of the model Metadata. The key can either be user defined or OCI defined. List of OCI defined keys: * useCaseType * libraryName * libraryVersion * estimatorClass * hyperParameters

• testartifactresults

Returns:

the value

getValue

public String getValue()

Allowed values for useCaseType: binary_classification, regression, multinomial_classification, clustering, recommender, dimensionality_reduction/representation, time_series_forecasting, anomaly_detection, topic_modeling, ner, sentiment_analysis, image_classification, object_localization, other

Allowed values for libraryName: scikit-learn, xgboost, tensorflow, pytorch, mxnet, keras, lightGBM, pymc3, pyOD, spacy, prophet, sktime, statsmodels, cuml, oracle_automl, h2o, transformers, nltk, emcee, pystan, bert, gensim, flair, word2vec, ensemble, other

Returns:

the value

getDescription

public String getDescription()

Description of model metadata

Returns:

the value

getCategory

public String getCategory()

Category of model metadata which should be null for defined metadata.For custom metadata is should be one of the following values “Performance,Training Profile,Training and Validation Datasets,Training Environment,other”.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel