Package org.tribuo.multilabel.sgd.linear

Class LinearSGDOptions

java.lang.Object

org.tribuo.multilabel.sgd.linear.LinearSGDOptions

All Implemented Interfaces:

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

public class LinearSGDOptions
extends Object
implements com.oracle.labs.mlrg.olcut.config.Options

CLI options for training a linear classifier.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LinearSGDOptions.LossEnum	Available loss types.

Field Summary

Fields

Modifier and Type	Field	Description
int	sgdEpochs	Number of SGD epochs.
int	sgdLoggingInterval	Log the objective after n examples.
int	sgdMinibatchSize	Minibatch size.
LinearSGDOptions.LossEnum	sgdObjective	Loss function.
long	sgdSeed	Sets the random seed for the LinearSGDTrainer.
GradientOptimiserOptions	sgoOptions	The gradient descent optimiser options.

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

header

Constructor Summary

Constructors

Constructor	Description
LinearSGDOptions()

Method Summary

Modifier and Type	Method	Description
MultiLabelObjective	getLoss()	Returns the loss function specified in the arguments.
LinearSGDTrainer	getTrainer()	Gets the LinearSGDTrainer specified by the options in this object.

Methods inherited from class java.lang.Object

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

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

getOptionsDescription

Field Details

sgoOptions

public GradientOptimiserOptions sgoOptions

The gradient descent optimiser options.

sgdEpochs

@Option(longName="sgd-epochs",
        usage="Number of SGD epochs.")
public int sgdEpochs

Number of SGD epochs.

sgdObjective

@Option(longName="sgd-objective",
        usage="Loss function.")
public LinearSGDOptions.LossEnum sgdObjective

Loss function.

sgdLoggingInterval

@Option(longName="sgd-logging-interval",
        usage="Log the objective after <int> examples.")
public int sgdLoggingInterval

Log the objective after n examples.

sgdMinibatchSize

@Option(longName="sgd-minibatch-size",
        usage="Minibatch size.")
public int sgdMinibatchSize

Minibatch size.

sgdSeed

@Option(longName="sgd-seed",
        usage="Sets the random seed for the LinearSGDTrainer.")
public long sgdSeed

Sets the random seed for the LinearSGDTrainer.

Constructor Details

LinearSGDOptions

public LinearSGDOptions()

Method Details

getLoss

public MultiLabelObjective getLoss()

Returns the loss function specified in the arguments.

Returns:

The loss function.

getTrainer

public LinearSGDTrainer getTrainer()

Gets the LinearSGDTrainer specified by the options in this object.

Returns:

The configured trainer.