org.tribuo.provenance

Class ModelProvenance

java.lang.Object

org.tribuo.provenance.ModelProvenance

All Implemented Interfaces:

com.oracle.labs.mlrg.olcut.provenance.ObjectProvenance, com.oracle.labs.mlrg.olcut.provenance.Provenance, Serializable, Iterable<com.oracle.labs.mlrg.olcut.util.Pair<String,com.oracle.labs.mlrg.olcut.provenance.Provenance>>

Direct Known Subclasses:

EnsembleModelProvenance

public class ModelProvenance
extends Object
implements com.oracle.labs.mlrg.olcut.provenance.ObjectProvenance

Contains provenance information for an instance of a Model.

Made up of the class name of the model object, the date and time it was trained, the provenance of the training data, and the provenance of the trainer.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	className
protected static String	DATASET
protected DatasetProvenance	datasetProvenance
protected static String	INSTANCE_VALUES
protected com.oracle.labs.mlrg.olcut.provenance.MapProvenance<? extends com.oracle.labs.mlrg.olcut.provenance.Provenance>	instanceProvenance
protected OffsetDateTime	time
protected static String	TRAINER
protected TrainerProvenance	trainerProvenance
protected static String	TRAINING_TIME
protected String	versionString

Fields inherited from interface com.oracle.labs.mlrg.olcut.provenance.ObjectProvenance

CLASS_NAME, DEFAULT_HASH_TYPE

Constructor Summary

Constructors

Constructor and Description
ModelProvenance(Map<String,com.oracle.labs.mlrg.olcut.provenance.Provenance> map)
ModelProvenance(String className, OffsetDateTime time, DatasetProvenance datasetProvenance, TrainerProvenance trainerProvenance)
ModelProvenance(String className, OffsetDateTime time, DatasetProvenance datasetProvenance, TrainerProvenance trainerProvenance, Map<String,com.oracle.labs.mlrg.olcut.provenance.Provenance> instanceProvenance)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getClassName()
DatasetProvenance	getDatasetProvenance() The training dataset provenance.
com.oracle.labs.mlrg.olcut.provenance.MapProvenance<? extends com.oracle.labs.mlrg.olcut.provenance.Provenance>	getInstanceProvenance() Provenance for the specific training run which created this model.
TrainerProvenance	getTrainerProvenance() The trainer provenance.
OffsetDateTime	getTrainingTime() The training timestamp.
String	getTribuoVersion() The Tribuo version used to create this dataset.
int	hashCode()
Iterator<com.oracle.labs.mlrg.olcut.util.Pair<String,com.oracle.labs.mlrg.olcut.provenance.Provenance>>	iterator()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.labs.mlrg.olcut.provenance.ObjectProvenance

checkAndExtractProvenance, generateString

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DATASET

protected static final String DATASET

See Also:

Constant Field Values

TRAINER

protected static final String TRAINER

See Also:

Constant Field Values

TRAINING_TIME

protected static final String TRAINING_TIME

See Also:

Constant Field Values

INSTANCE_VALUES

protected static final String INSTANCE_VALUES

See Also:

Constant Field Values

className

protected final String className

time

protected final OffsetDateTime time

datasetProvenance

protected final DatasetProvenance datasetProvenance

trainerProvenance

protected final TrainerProvenance trainerProvenance

instanceProvenance

protected final com.oracle.labs.mlrg.olcut.provenance.MapProvenance<? extends com.oracle.labs.mlrg.olcut.provenance.Provenance> instanceProvenance

versionString

protected final String versionString

Constructor Detail

ModelProvenance

public ModelProvenance(String className,
                       OffsetDateTime time,
                       DatasetProvenance datasetProvenance,
                       TrainerProvenance trainerProvenance)

ModelProvenance

public ModelProvenance(String className,
                       OffsetDateTime time,
                       DatasetProvenance datasetProvenance,
                       TrainerProvenance trainerProvenance,
                       Map<String,com.oracle.labs.mlrg.olcut.provenance.Provenance> instanceProvenance)

ModelProvenance

public ModelProvenance(Map<String,com.oracle.labs.mlrg.olcut.provenance.Provenance> map)

Method Detail

getTrainingTime

public OffsetDateTime getTrainingTime()

The training timestamp.

Returns:

The timestamp.

getDatasetProvenance

public DatasetProvenance getDatasetProvenance()

The training dataset provenance.

Returns:

The training dataset provenance.

getTrainerProvenance

public TrainerProvenance getTrainerProvenance()

The trainer provenance.

Returns:

The trainer provenance.

getInstanceProvenance

public com.oracle.labs.mlrg.olcut.provenance.MapProvenance<? extends com.oracle.labs.mlrg.olcut.provenance.Provenance> getInstanceProvenance()

Provenance for the specific training run which created this model.

Returns:

The instance provenance.

getTribuoVersion

public String getTribuoVersion()

The Tribuo version used to create this dataset.

Returns:

The Tribuo version.

toString

public String toString()

Overrides:

toString in class Object

getClassName

public String getClassName()

Specified by:

getClassName in interface com.oracle.labs.mlrg.olcut.provenance.ObjectProvenance

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

iterator

public Iterator<com.oracle.labs.mlrg.olcut.util.Pair<String,com.oracle.labs.mlrg.olcut.provenance.Provenance>> iterator()

Specified by:

iterator in interface Iterable<com.oracle.labs.mlrg.olcut.util.Pair<String,com.oracle.labs.mlrg.olcut.provenance.Provenance>>