weka.dl4j.updater

Class Updater<T extends org.nd4j.linalg.learning.config.IUpdater>

java.lang.Object

weka.dl4j.updater.Updater<T>

All Implemented Interfaces:

java.io.Serializable, weka.core.OptionHandler, ApiWrapper<T>

Direct Known Subclasses:

AdaDelta, AdaGrad, Adam, AdaMax, Nadam, Nesterovs, NoOp, RmsProp, Sgd

public abstract class Updater<T extends org.nd4j.linalg.learning.config.IUpdater>
extends java.lang.Object
implements weka.core.OptionHandler, ApiWrapper<T>, java.io.Serializable

Default Updater that implements WEKA option handling.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Updater()

Method Summary

Modifier and Type	Method and Description
static Updater<? extends org.nd4j.linalg.learning.config.IUpdater>	create(org.nd4j.linalg.learning.config.IUpdater newBackend) Create an API wrapped updater from a given updater object.
T	getBackend() Access the DL4J backend.
double	getLearningRate() Get the learning rate
Schedule	getLearningRateSchedule() Get the learning rate schedule
java.lang.String[]	getOptions() Gets the current settings of the Classifier.
boolean	hasLearningRate()
java.util.Enumeration<weka.core.Option>	listOptions() Returns an enumeration describing the available options.
void	setBackend(T newBackend) Set the DL4J backend.
void	setLearningRate(double learningRate) Set the learning rate
void	setLearningRateSchedule(Schedule<? extends org.nd4j.linalg.schedule.ISchedule> learningRateSchedule) Set the learning rate schedule
void	setOptions(java.lang.String[] options) Parses a given list of options.

Methods inherited from class java.lang.Object

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

Methods inherited from interface weka.core.OptionHandler

makeCopy

Methods inherited from interface weka.dl4j.ApiWrapper

initializeBackend

Constructor Detail

Updater

public Updater()

Method Detail

create

public static Updater<? extends org.nd4j.linalg.learning.config.IUpdater> create(org.nd4j.linalg.learning.config.IUpdater newBackend)

Create an API wrapped updater from a given updater object.

Parameters:

newBackend - Backend object

Returns:

API wrapped object

hasLearningRate

@ProgrammaticProperty
public boolean hasLearningRate()

getLearningRate

@OptionMetadata(displayName="lr",
                description="The learning rate (default = 0.1).",
                commandLineParamName="lr",
                commandLineParamSynopsis="-lr <double>",
                displayOrder=1)
public double getLearningRate()

Get the learning rate

Returns:

Learning rate

setLearningRate

public void setLearningRate(double learningRate)

Set the learning rate

Parameters:

learningRate - Learning rate

getLearningRateSchedule

@OptionMetadata(displayName="lrSchedule",
                description="The learning rate schedule (default = ConstantScheduleImpl).",
                commandLineParamName="lrSchedule",
                commandLineParamSynopsis="-lrSchedule <Schedule>",
                displayOrder=1)
public Schedule getLearningRateSchedule()

Get the learning rate schedule

Returns:

Learning rate schedule

setLearningRateSchedule

public void setLearningRateSchedule(Schedule<? extends org.nd4j.linalg.schedule.ISchedule> learningRateSchedule)

Set the learning rate schedule

Parameters:

learningRateSchedule - Learning rate schedule

getBackend

public T getBackend()

Description copied from interface: ApiWrapper

Access the DL4J backend.

Specified by:

getBackend in interface ApiWrapper<T extends org.nd4j.linalg.learning.config.IUpdater>

Returns:

DL4J backend for this wrapper

setBackend

public void setBackend(T newBackend)

Description copied from interface: ApiWrapper

Set the DL4J backend.

Specified by:

setBackend in interface ApiWrapper<T extends org.nd4j.linalg.learning.config.IUpdater>

Parameters:

newBackend - Backend that should be wrapped by this class

listOptions

public java.util.Enumeration<weka.core.Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Returns:

an enumeration of all the available options.

getOptions

public java.lang.String[] getOptions()

Gets the current settings of the Classifier.

Specified by:

getOptions in interface weka.core.OptionHandler

Returns:

an array of strings suitable for passing to setOptions

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses a given list of options.

Specified by:

setOptions in interface weka.core.OptionHandler

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported