org.tribuo.interop.tensorflow

Class TensorflowCheckpointTrainer<T extends Output<T>>

java.lang.Object

org.tribuo.interop.tensorflow.TensorflowCheckpointTrainer<T>

All Implemented Interfaces:

com.oracle.labs.mlrg.olcut.config.Configurable, com.oracle.labs.mlrg.olcut.provenance.Provenancable<TrainerProvenance>, Trainer<T>

public final class TensorflowCheckpointTrainer<T extends Output<T>>
extends Object
implements Trainer<T>

Trainer for Tensorflow. Expects the underlying Tensorflow graph to have specific placeholders and targets listed below.

• TensorflowModel.INPUT_NAME - the input minibatch.
• TensorflowModel.OUTPUT_NAME - the predicted output.
• TensorflowTrainer.TARGET - the output to predict.
• TensorflowTrainer.TRAIN - the train function to run (usually a single step of SGD).
• TensorflowTrainer.TRAINING_LOSS - the loss tensor to extract for logging.
• TensorflowTrainer.EPOCH - the current epoch number, used for gradient scaling.
• TensorflowTrainer.IS_TRAINING - a boolean placeholder to turn on dropout or other training specific functionality.
• TensorflowTrainer.INIT - the function to initialise the graph.

This trainer only works with graphs setup for minibatches. To recover single example training just use a batch size of 1.

This trainer uses the native Tensorflow serialisation functionality and saves to a checkpoint on disk. It's much more fragile than the TensorflowTrainer.

N.B. Tensorflow support is experimental and may change without a major version bump.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TensorflowCheckpointTrainer.TensorflowCheckpointTrainerProvenance

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODEL_FILENAME

Fields inherited from interface org.tribuo.Trainer

DEFAULT_SEED

Constructor Summary

Constructors

Constructor and Description
TensorflowCheckpointTrainer(Path graphPath, Path checkpointRootPath, ExampleTransformer<T> exampleTransformer, OutputTransformer<T> outputTransformer, int minibatchSize, int epochs) Builds a trainer using the supplied graph and arguments.

Method Summary

Modifier and Type	Method and Description
int	getInvocationCount() The number of times this trainer instance has had it's train method invoked.
TrainerProvenance	getProvenance()
void	postConfig() Used by the OLCUT configuration system, and should not be called by external code.
String	toString()
Model<T>	train(Dataset<T> examples, Map<String,com.oracle.labs.mlrg.olcut.provenance.Provenance> runProvenance) Trains a predictive model using the examples in the given data set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tribuo.Trainer

train

Field Detail

MODEL_FILENAME

public static final String MODEL_FILENAME

See Also:

Constant Field Values

Constructor Detail

TensorflowCheckpointTrainer

public TensorflowCheckpointTrainer(Path graphPath,
                                   Path checkpointRootPath,
                                   ExampleTransformer<T> exampleTransformer,
                                   OutputTransformer<T> outputTransformer,
                                   int minibatchSize,
                                   int epochs)
                            throws IOException

Builds a trainer using the supplied graph and arguments.

Parameters:

graphPath - The graph to load.

checkpointRootPath - The checkpoint path to save to.

exampleTransformer - The feature transformer.

outputTransformer - The output transformer.

minibatchSize - The training batch size.

epochs - The number of training epochs.

Throws:

IOException - If the graph failed to load.

Method Detail

postConfig

public void postConfig()
                throws IOException

Used by the OLCUT configuration system, and should not be called by external code.

Specified by:

postConfig in interface com.oracle.labs.mlrg.olcut.config.Configurable

Throws:

IOException

train

public Model<T> train(Dataset<T> examples,
                      Map<String,com.oracle.labs.mlrg.olcut.provenance.Provenance> runProvenance)

Description copied from interface: Trainer

Trains a predictive model using the examples in the given data set.

Specified by:

train in interface Trainer<T extends Output<T>>

Parameters:

examples - the data set containing the examples.

runProvenance - Training run specific provenance (e.g., fold number).

Returns:

a predictive model that can be used to generate predictions for new examples.

getInvocationCount

public int getInvocationCount()

Description copied from interface: Trainer

The number of times this trainer instance has had it's train method invoked.

This is used to determine how many times the trainer's RNG has been accessed to ensure replicability in the random number stream.

Specified by:

getInvocationCount in interface Trainer<T extends Output<T>>

Returns:

The number of train invocations.

toString

public String toString()

Overrides:

toString in class Object

getProvenance

public TrainerProvenance getProvenance()

Specified by:

getProvenance in interface com.oracle.labs.mlrg.olcut.provenance.Provenancable<TrainerProvenance>