Package ai.djl.training.tracker

Class CyclicalTracker

java.lang.Object

ai.djl.training.tracker.CyclicalTracker

All Implemented Interfaces:

ParameterTracker, Tracker

public class CyclicalTracker
extends Object
implements Tracker

CyclicalTracker is an implementation of Tracker which is a policy of learning rate adjustment that increases the learning rate off a base value in a cyclical nature, as detailed in the paper Cyclical Learning Rates for Training Neural Networks.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CyclicalTracker.Builder	The Builder to construct an CyclicalTracker object.
static enum	CyclicalTracker.CyclicalMode	CyclicalTracker provides three predefined cyclical modes and can be selected by this enum.
static interface	CyclicalTracker.ScaleFunction	ScaleFunction is an interface to implement a custom scale function.

Constructor Summary

Constructors

Constructor	Description
CyclicalTracker(CyclicalTracker.Builder builder)	Creates a new instance of CyclicalTracker.

Method Summary

Modifier and Type	Method	Description
static CyclicalTracker.Builder	builder()	Creates a new builder.
float	getNewValue(int numUpdate)	Fetches the value after the given number of steps/updates.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.djl.training.tracker.Tracker

getNewValue

Constructor Details

CyclicalTracker

public CyclicalTracker(CyclicalTracker.Builder builder)

Creates a new instance of CyclicalTracker.

Parameters:

builder - the builder to create a new instance of CyclicalTracker

Method Details

builder

public static CyclicalTracker.Builder builder()

Creates a new builder.

Returns:

a new builder

getNewValue

public float getNewValue(int numUpdate)

Fetches the value after the given number of steps/updates.

Specified by:

getNewValue in interface Tracker

Parameters:

numUpdate - the total number of steps/updates

Returns:

this Builder