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.

In addition by default it collects the Java version, OS name and system architecture, along with the running Tribuo version.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ARCH_STRING
protected String	archString
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 static String	JAVA_VERSION_STRING
protected String	javaVersionString
protected static String	OS_STRING
protected String	osString
protected OffsetDateTime	time
protected static String	TRAINER
protected TrainerProvenance	trainerProvenance
protected static String	TRAINING_TIME
protected static String	TRIBUO_VERSION_STRING
protected static String	UNKNOWN_VERSION
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) Used by the provenance unmarshalling system.
ModelProvenance(String className, OffsetDateTime time, DatasetProvenance datasetProvenance, TrainerProvenance trainerProvenance) Creates a model provenance tracking the class name, creation time, dataset provenance and trainer provenance.
ModelProvenance(String className, OffsetDateTime time, DatasetProvenance datasetProvenance, TrainerProvenance trainerProvenance, Map<String,com.oracle.labs.mlrg.olcut.provenance.Provenance> instanceProvenance) Creates a model provenance tracking the class name, creation time, dataset provenance, trainer provenance and any instance specific provenance.
ModelProvenance(String className, OffsetDateTime time, DatasetProvenance datasetProvenance, TrainerProvenance trainerProvenance, Map<String,com.oracle.labs.mlrg.olcut.provenance.Provenance> instanceProvenance, boolean trackSystem) Creates a model provenance tracking the class name, creation time, dataset provenance, trainer provenance and any instance specific provenance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getArch() The CPU architecture used to create this model.
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.
String	getJavaVersion() The Java version used to create this model.
String	getOS() The name of the OS used to create this model.
TrainerProvenance	getTrainerProvenance() The trainer provenance.
OffsetDateTime	getTrainingTime() The training timestamp.
String	getTribuoVersion() The Tribuo version used to create this dataset.
int	hashCode()
protected List<com.oracle.labs.mlrg.olcut.util.Pair<String,com.oracle.labs.mlrg.olcut.provenance.Provenance>>	internalProvenances() Returns a list of all the provenances in this model provenance so subclasses can append to the list.
Iterator<com.oracle.labs.mlrg.olcut.util.Pair<String,com.oracle.labs.mlrg.olcut.provenance.Provenance>>	iterator() Calls internalProvenances() and returns the iterator from that list.
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, maybeExtractProvenance

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

TRIBUO_VERSION_STRING

protected static final String TRIBUO_VERSION_STRING

See Also:

Constant Field Values

JAVA_VERSION_STRING

protected static final String JAVA_VERSION_STRING

See Also:

Constant Field Values

OS_STRING

protected static final String OS_STRING

See Also:

Constant Field Values

ARCH_STRING

protected static final String ARCH_STRING

See Also:

Constant Field Values

UNKNOWN_VERSION

protected static final String UNKNOWN_VERSION

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

javaVersionString

protected final String javaVersionString

osString

protected final String osString

archString

protected final String archString

Constructor Detail

ModelProvenance

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

Creates a model provenance tracking the class name, creation time, dataset provenance and trainer provenance.

Also tracks system details like the os name, os architecture, java version, and Tribuo version.

Parameters:

className - The model class name.

time - The model creation time.

datasetProvenance - The dataset provenance.

trainerProvenance - The trainer provenance.

ModelProvenance

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

Creates a model provenance tracking the class name, creation time, dataset provenance, trainer provenance and any instance specific provenance.

Also tracks system details like the os name, os architecture, java version, and Tribuo version.

Parameters:

className - The model class name.

time - The model creation time.

datasetProvenance - The dataset provenance.

trainerProvenance - The trainer provenance.

instanceProvenance - Provenance for this specific model training run.

ModelProvenance

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

Creates a model provenance tracking the class name, creation time, dataset provenance, trainer provenance and any instance specific provenance.

Also optionally tracks system details like the os name, os architecture, java version, and Tribuo version.

Parameters:

className - The model class name.

time - The model creation time.

datasetProvenance - The dataset provenance.

trainerProvenance - The trainer provenance.

instanceProvenance - Provenance for this specific model training run.

trackSystem - If true then store the java version, os name and os arch in the provenance.

ModelProvenance

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

Used by the provenance unmarshalling system.

Throws ProvenanceException if there are missing fields.

Parameters:

map - The 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.

getJavaVersion

public String getJavaVersion()

The Java version used to create this model.

Returns:

The Java version.

getOS

public String getOS()

The name of the OS used to create this model.

Returns:

The OS name.

getArch

public String getArch()

The CPU architecture used to create this model.

Returns:

The CPU architecture.

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

internalProvenances

protected List<com.oracle.labs.mlrg.olcut.util.Pair<String,com.oracle.labs.mlrg.olcut.provenance.Provenance>> internalProvenances()

Returns a list of all the provenances in this model provenance so subclasses can append to the list.

Returns:

A list of all the provenances in this class.

iterator

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

Calls internalProvenances() and returns the iterator from that list.

Specified by:

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

Returns:

An iterator over all the provenances.