Package org.tribuo.classification.sgd.crf

Class SeqTest.CRFOptions

java.lang.Object

org.tribuo.classification.sgd.crf.SeqTest.CRFOptions

All Implemented Interfaces:

com.oracle.labs.mlrg.olcut.config.Options

Enclosing class:

SeqTest

public static class SeqTest.CRFOptions
extends Object
implements com.oracle.labs.mlrg.olcut.config.Options

Command line options.

Field Summary

Fields

Modifier and Type	Field	Description
String	datasetName	Name of the example dataset, options are {gorilla}.
int	epochs	Number of SGD epochs.
GradientOptimiserOptions	gradientOptions	Gradient descent options.
int	loggingInterval	Log the objective after n examples.
boolean	logModel	Print out feature, label and other model details.
HashingOptions.ModelHashingType	modelHashingAlgorithm	Hash the model during training.
String	modelHashingSalt	Salt for hashing the model.
Path	outputPath	Path to serialize model to.
boolean	protobufFormat	Load in the model in protobuf format.
long	seed	RNG seed.
boolean	shuffle	Shuffle the data each epoch (default: true).
Path	testDataset	Path to a serialised SequenceDataset used for testing.
Path	trainDataset	Path to a serialised SequenceDataset used for training.

Fields inherited from interface com.oracle.labs.mlrg.olcut.config.Options

header

Constructor Summary

Constructors

Constructor	Description
CRFOptions()

Method Summary

Modifier and Type	Method	Description
String	getOptionsDescription()

Methods inherited from class java.lang.Object

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

Field Details

gradientOptions

public GradientOptimiserOptions gradientOptions

Gradient descent options.

datasetName

@Option(charName='d',
        longName="dataset-name",
        usage="Name of the example dataset, options are {gorilla}.")
public String datasetName

Name of the example dataset, options are {gorilla}.

outputPath

@Option(charName='f',
        longName="output-path",
        usage="Path to serialize model to.")
public Path outputPath

Path to serialize model to.

epochs

@Option(charName='i',
        longName="epochs",
        usage="Number of SGD epochs.")
public int epochs

Number of SGD epochs.

logModel

@Option(charName='o',
        longName="print-model",
        usage="Print out feature, label and other model details.")
public boolean logModel

Print out feature, label and other model details.

loggingInterval

@Option(charName='p',
        longName="logging-interval",
        usage="Log the objective after <int> examples.")
public int loggingInterval

Log the objective after n examples.

seed

@Option(charName='r',
        longName="seed",
        usage="RNG seed.")
public long seed

RNG seed.

shuffle

@Option(longName="shuffle",
        usage="Shuffle the data each epoch (default: true).")
public boolean shuffle

Shuffle the data each epoch (default: true).

trainDataset

@Option(charName='u',
        longName="train-dataset",
        usage="Path to a serialised SequenceDataset used for training.")
public Path trainDataset

Path to a serialised SequenceDataset used for training.

testDataset

@Option(charName='v',
        longName="test-dataset",
        usage="Path to a serialised SequenceDataset used for testing.")
public Path testDataset

Path to a serialised SequenceDataset used for testing.

modelHashingAlgorithm

@Option(longName="model-hashing-algorithm",
        usage="Hash the model during training. Defaults to no hashing.")
public HashingOptions.ModelHashingType modelHashingAlgorithm

Hash the model during training. Defaults to no hashing.

modelHashingSalt

@Option(longName="model-hashing-salt",
        usage="Salt for hashing the model.")
public String modelHashingSalt

Salt for hashing the model.

protobufFormat

@Option(longName="protobuf-model",
        usage="Load the model from a protobuf. Optional")
public boolean protobufFormat

Load in the model in protobuf format.

Constructor Details

CRFOptions

public CRFOptions()

Method Details

getOptionsDescription

public String getOptionsDescription()

Specified by:

getOptionsDescription in interface com.oracle.labs.mlrg.olcut.config.Options