org.nd4j.linalg.schedule

Class MapSchedule

java.lang.Object

org.nd4j.linalg.schedule.MapSchedule

All Implemented Interfaces:

Serializable, Cloneable, ISchedule

public class MapSchedule
extends Object
implements ISchedule

MapSchedule is a schedule based on specific values in a Map<Integer,Double>.
For example, if the map contains the following: (0,1.0), (10,0.5), (20, 0.2) then iteration/epoch 0 to 9 inclusive will have value 1.0, 10 to 19 will have 0.5, and 20+ will have value 0.2.
Note that the map MUST have a key for position 0 - this is the initial value.

Author:

Alex Black

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapSchedule.Builder DynamicCustomOpsBuilder for conveniently constructing map schedules

Constructor Summary

Constructors

Constructor and Description
MapSchedule(ScheduleType scheduleType, Map<Integer,Double> values)

Method Summary

Modifier and Type	Method and Description
ISchedule	clone()
double	valueAt(int iteration, int epoch)

Methods inherited from class java.lang.Object

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

Constructor Detail

MapSchedule

public MapSchedule(@NonNull
                   ScheduleType scheduleType,
                   @NonNull
                   Map<Integer,Double> values)

Method Detail

valueAt

public double valueAt(int iteration,
                      int epoch)

Specified by:

valueAt in interface ISchedule

Parameters:

iteration - Current iteration number. Starts at 0

epoch - Current epoch number. Starts at 0

Returns:

Value at the current iteration/epoch for this schedule

clone

public ISchedule clone()

Specified by:

clone in interface ISchedule

Overrides:

clone in class Object