Package com.oracle.bmc.datascience.model

Class ModelProvenance

java.lang.Object

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

com.oracle.bmc.datascience.model.ModelProvenance

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

Model provenance gives data scientists information about the origin of their model.

This information allows data scientists to reproduce the development environment in which the model was trained.
Note: Objects should always be created or deserialized using the ModelProvenance.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 ModelProvenance.Builder, which maintain a set of all explicitly set fields called ModelProvenance.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	Description
static class	ModelProvenance.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	Description
ModelProvenance(String repositoryUrl, String gitBranch, String gitCommit, String scriptDir, String trainingScript, String trainingId)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ModelProvenance.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getGitBranch()	For model reproducibility purposes.
String	getGitCommit()	For model reproducibility purposes.
String	getRepositoryUrl()	For model reproducibility purposes.
String	getScriptDir()	For model reproducibility purposes.
String	getTrainingId()	The OCID of a training session(Job or NotebookSession) in which the model was trained.
String	getTrainingScript()	For model reproducibility purposes.
int	hashCode()
ModelProvenance.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

ModelProvenance

@Deprecated
@ConstructorProperties({"repositoryUrl","gitBranch","gitCommit","scriptDir","trainingScript","trainingId"})
public ModelProvenance(String repositoryUrl,
                       String gitBranch,
                       String gitCommit,
                       String scriptDir,
                       String trainingScript,
                       String trainingId)

Deprecated.

Method Detail

builder

public static ModelProvenance.Builder builder()

Create a new builder.

toBuilder

public ModelProvenance.Builder toBuilder()

getRepositoryUrl

public String getRepositoryUrl()

For model reproducibility purposes.

URL of the git repository associated with model training.

Returns:

the value

getGitBranch

public String getGitBranch()

For model reproducibility purposes.

Branch of the git repository associated with model training.

Returns:

the value

getGitCommit

public String getGitCommit()

For model reproducibility purposes.

Commit ID of the git repository associated with model training.

Returns:

the value

getScriptDir

public String getScriptDir()

For model reproducibility purposes.

Path to model artifacts.

Returns:

the value

getTrainingScript

public String getTrainingScript()

For model reproducibility purposes.

Path to the python script or notebook in which the model was trained."

Returns:

the value

getTrainingId

public String getTrainingId()

The OCID of a training session(Job or NotebookSession) in which the model was trained.

It is used for model reproducibility purposes.

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