weka.dl4j.schedules

Class Schedule<T extends org.nd4j.linalg.schedule.ISchedule>

java.lang.Object

weka.dl4j.schedules.Schedule<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

ConstantSchedule, ExponentialSchedule, InverseSchedule, MapSchedule, PolySchedule, SigmoidSchedule, StepSchedule

public abstract class Schedule<T extends org.nd4j.linalg.schedule.ISchedule>
extends java.lang.Object
implements weka.core.OptionHandler, ApiWrapper<T>, java.io.Serializable

Default schedule interface that implements WEKA option handling. Each class that implements Schedulers extending from this class must have a backing implementation of the referencing Dl4j scheduler since the scheduler in Dl4j do not allow access to their class members (private final).

SigmoidSchedule, StepSchedule)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Schedule()

Method Summary

Modifier and Type	Method and Description
static Schedule<? extends org.nd4j.linalg.schedule.ISchedule>	create(org.nd4j.linalg.schedule.ISchedule newBackend) Create an API wrapped schedule from a given ISchedule object.
T	getBackend() Access the DL4J backend.
double	getInitialValue()
java.lang.String[]	getOptions() Gets the current settings of the Classifier.
ScheduleType	getScheduleType()
java.util.Enumeration<weka.core.Option>	listOptions() Returns an enumeration describing the available options.
void	setInitialValue(double initialValue)
void	setOptions(java.lang.String[] options) Parses a given list of options.
void	setScheduleType(ScheduleType scheduleType)

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, setBackend

Constructor Detail

Schedule

public Schedule()

Method Detail

create

public static Schedule<? extends org.nd4j.linalg.schedule.ISchedule> create(org.nd4j.linalg.schedule.ISchedule newBackend)

Create an API wrapped schedule from a given ISchedule object.

Parameters:

newBackend - Backend object

Returns:

API wrapped object

getScheduleType

@OptionMetadata(displayName="scheduleType",
                description="The schedule type, one of {EPOCH,ITERATION} (default = EPOCH).",
                commandLineParamName="scheduleType",
                commandLineParamSynopsis="-scheduleType <string>",
                displayOrder=1)
public ScheduleType getScheduleType()

setScheduleType

public void setScheduleType(ScheduleType scheduleType)

getInitialValue

@ProgrammaticProperty
public double getInitialValue()

setInitialValue

@ProgrammaticProperty
public void setInitialValue(double initialValue)

getBackend

public T getBackend()

Description copied from interface: ApiWrapper

Access the DL4J backend.

Specified by:

getBackend in interface ApiWrapper<T extends org.nd4j.linalg.schedule.ISchedule>

Returns:

DL4J backend for this wrapper

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