ai.djl.training.optimizer.learningrate

Class LearningRateTracker.LrBaseBuilder<T extends LearningRateTracker.LrBaseBuilder>

java.lang.Object

ai.djl.training.optimizer.learningrate.LearningRateTracker.LrBaseBuilder<T>

Direct Known Subclasses:

FactorTracker.Builder, MultiFactorTracker.Builder

Enclosing class:

LearningRateTracker

public abstract static class LearningRateTracker.LrBaseBuilder<T extends LearningRateTracker.LrBaseBuilder>
extends java.lang.Object

The Builder to construct a LearningRateTracker.

Constructor Summary

Constructors

Constructor and Description
LrBaseBuilder()

Method Summary

Modifier and Type	Method and Description
T	optBaseLearningRate(float baseLearningRate) Sets the base learning rate.
T	optWarmUpBeginLearningRate(float warmUpBeginLearningRate) Sets the value of the learning rate at the beginning of warm-up mode.
T	optWarmUpMode(WarmUpMode warmUpMode) Sets the WarmUpMode for the LearningRateTracker.
T	optWarmUpSteps(int warmUpSteps) Sets the number of steps until the point the learning rate is updated in warm-up mode.
protected abstract T	self()

Methods inherited from class java.lang.Object

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

Constructor Detail

LrBaseBuilder

public LrBaseBuilder()

Method Detail

optBaseLearningRate

public T optBaseLearningRate(float baseLearningRate)

Sets the base learning rate.

Parameters:

baseLearningRate - the base learning rate

Returns:

this Builder

optWarmUpSteps

public T optWarmUpSteps(int warmUpSteps)

Sets the number of steps until the point the learning rate is updated in warm-up mode.

Parameters:

warmUpSteps - the number of steps until the point the learning rate is updated in warm-up mode

Returns:

this Builder

optWarmUpBeginLearningRate

public T optWarmUpBeginLearningRate(float warmUpBeginLearningRate)

Sets the value of the learning rate at the beginning of warm-up mode.

Parameters:

warmUpBeginLearningRate - the value of the learning rate at the beginning of warm-up mode

Returns:

this Builder

optWarmUpMode

public T optWarmUpMode(WarmUpMode warmUpMode)

Sets the WarmUpMode for the LearningRateTracker.

Parameters:

warmUpMode - the WarmUpMode to be set

Returns:

this Builder

self

protected abstract T self()