ai.djl.training.optimizer.learningrate

Class LearningRateTracker

java.lang.Object

ai.djl.training.optimizer.learningrate.LearningRateTracker

Direct Known Subclasses:

FactorTracker, MultiFactorTracker

public abstract class LearningRateTracker
extends java.lang.Object

A LearningRateTracker tracks the evolution of the learning rate through the training process.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LearningRateTracker.LrBaseBuilder<T extends LearningRateTracker.LrBaseBuilder> The Builder to construct a LearningRateTracker.

Method Summary

Modifier and Type	Method and Description
static FactorTracker.Builder	factorTracker() Returns a new instance of FactorTracker.Builder that can build an FactorTracker.
static LearningRateTracker	fixedLearningRate(float learningRate) Returns a new instance of LearningRateTracker with the fixed learning rate.
abstract float	getNewLearningRate(int numUpdate) Fetches the value of the learning rate after the given number of steps/updates.
static MultiFactorTracker.Builder	multiFactorTracker() Returns a new instance of MultiFactorTracker.Builder that can build an MultiFactorTracker.

Methods inherited from class java.lang.Object

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

Method Detail

getNewLearningRate

public abstract float getNewLearningRate(int numUpdate)

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

Parameters:

numUpdate - the number of steps/updates

Returns:

this Builder

factorTracker

public static FactorTracker.Builder factorTracker()

Returns a new instance of FactorTracker.Builder that can build an FactorTracker.

Returns:

the FactorTracker FactorTracker.Builder

multiFactorTracker

public static MultiFactorTracker.Builder multiFactorTracker()

Returns a new instance of MultiFactorTracker.Builder that can build an MultiFactorTracker.

Returns:

the MultiFactorTracker MultiFactorTracker.Builder

fixedLearningRate

public static LearningRateTracker fixedLearningRate(float learningRate)

Returns a new instance of LearningRateTracker with the fixed learning rate.

Parameters:

learningRate - the fixed learning rate

Returns:

a instance of LearningRateTracker with the fixed learning rate