ai.djl.training.optimizer.learningrate

Class FactorTracker.Builder

java.lang.Object

ai.djl.training.optimizer.learningrate.LearningRateTracker.LrBaseBuilder<FactorTracker.Builder>

ai.djl.training.optimizer.learningrate.FactorTracker.Builder

Enclosing class:

FactorTracker

public static final class FactorTracker.Builder
extends LearningRateTracker.LrBaseBuilder<FactorTracker.Builder>

The Builder to construct an FactorTracker object.

Method Summary

Modifier and Type	Method and Description
FactorTracker	build() Builds a FactorTracker block.
FactorTracker.Builder	optFactor(float factor) Sets the value of the multiplicative factor.
FactorTracker.Builder	optStopFactorLearningRate(float stopFactorLearningRate) Sets the stop value after which the learning rate should remain constant.
protected FactorTracker.Builder	self()
FactorTracker.Builder	setStep(int step) Sets the number of steps after which the multiplicative factor must be applied once.

Methods inherited from class ai.djl.training.optimizer.learningrate.LearningRateTracker.LrBaseBuilder

optBaseLearningRate, optWarmUpBeginLearningRate, optWarmUpMode, optWarmUpSteps

Methods inherited from class java.lang.Object

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

Method Detail

self

protected FactorTracker.Builder self()

Specified by:

self in class LearningRateTracker.LrBaseBuilder<FactorTracker.Builder>

setStep

public FactorTracker.Builder setStep(int step)

Sets the number of steps after which the multiplicative factor must be applied once.

Parameters:

step - the number of steps after which the multiplicative factor must be applied once

Returns:

this Builder

optFactor

public FactorTracker.Builder optFactor(float factor)

Sets the value of the multiplicative factor.

Parameters:

factor - the value of the multiplicative factor

Returns:

this Builder

optStopFactorLearningRate

public FactorTracker.Builder optStopFactorLearningRate(float stopFactorLearningRate)

Sets the stop value after which the learning rate should remain constant.

Parameters:

stopFactorLearningRate - the stop value after which the learning rate should remain constant

Returns:

this Builder

build

public FactorTracker build()

Builds a FactorTracker block.

Returns:

the FactorTracker block