org.deeplearning4j.arbiter.conf.updater.schedule

Class StepScheduleSpace

java.lang.Object

org.deeplearning4j.arbiter.conf.updater.schedule.StepScheduleSpace

All Implemented Interfaces:

ParameterSpace<ISchedule>

public class StepScheduleSpace
extends Object
implements ParameterSpace<ISchedule>

Constructor Summary

Constructors

Constructor and Description
StepScheduleSpace(@NonNull ScheduleType scheduleType, @NonNull ParameterSpace<Double> initialValue, double decayRate, double step)
StepScheduleSpace(@NonNull ScheduleType scheduleType, @NonNull ParameterSpace<Double> initialValue, @NonNull ParameterSpace<Double> decayRate, @NonNull ParameterSpace<Double> step)

Method Summary

Modifier and Type	Method and Description
List<ParameterSpace>	collectLeaves() Collect a list of parameters, recursively.
Map<String,ParameterSpace>	getNestedSpaces() Get a list of nested parameter spaces by name.
ISchedule	getValue(double[] parameterValues) Generate a candidate given a set of values.
boolean	isLeaf() Is this ParameterSpace a leaf?
int	numParameters() Get the total number of parameters (hyperparameters) to be optimized.
void	setIndices(int... indices) For leaf ParameterSpaces: set the indices of the leaf ParameterSpace.

Methods inherited from class java.lang.Object

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

Constructor Detail

StepScheduleSpace

public StepScheduleSpace(@NonNull
                         @NonNull ScheduleType scheduleType,
                         @NonNull
                         @NonNull ParameterSpace<Double> initialValue,
                         double decayRate,
                         double step)

StepScheduleSpace

public StepScheduleSpace(@NonNull
                         @NonNull ScheduleType scheduleType,
                         @NonNull
                         @NonNull ParameterSpace<Double> initialValue,
                         @NonNull
                         @NonNull ParameterSpace<Double> decayRate,
                         @NonNull
                         @NonNull ParameterSpace<Double> step)

Method Detail

getValue

public ISchedule getValue(double[] parameterValues)

Description copied from interface: ParameterSpace

Generate a candidate given a set of values. These values are then mapped to a specific candidate, using some mapping function (such as the prior probability distribution)

Specified by:

getValue in interface ParameterSpace<ISchedule>

Parameters:

parameterValues - A set of values, each in the range [0,1], of length ParameterSpace.numParameters()

numParameters

public int numParameters()

Description copied from interface: ParameterSpace

Get the total number of parameters (hyperparameters) to be optimized. This includes optional parameters from different parameter subpaces. (Thus, not every parameter may be used in every candidate)

Specified by:

numParameters in interface ParameterSpace<ISchedule>

Returns:

Number of hyperparameters to be optimized

collectLeaves

public List<ParameterSpace> collectLeaves()

Description copied from interface: ParameterSpace

Collect a list of parameters, recursively. Note that leaf parameters are parameters that do not have any nested parameter spaces

Specified by:

collectLeaves in interface ParameterSpace<ISchedule>

getNestedSpaces

public Map<String,ParameterSpace> getNestedSpaces()

Description copied from interface: ParameterSpace

Get a list of nested parameter spaces by name. Note that the returned parameter spaces may in turn have further nested parameter spaces. The map should be empty for leaf parameter spaces

Specified by:

getNestedSpaces in interface ParameterSpace<ISchedule>

Returns:

A map of nested parameter spaces

isLeaf

public boolean isLeaf()

Description copied from interface: ParameterSpace

Is this ParameterSpace a leaf? (i.e., does it contain other ParameterSpaces internally?)

Specified by:

isLeaf in interface ParameterSpace<ISchedule>

setIndices

public void setIndices(int... indices)

Description copied from interface: ParameterSpace

For leaf ParameterSpaces: set the indices of the leaf ParameterSpace. Expects input of length ParameterSpace.numParameters(). Throws exception if ParameterSpace.isLeaf() is false.

Specified by:

setIndices in interface ParameterSpace<ISchedule>

Parameters:

indices - Indices to set. Length should equal ParameterSpace.numParameters()