Package ai.djl.training.tracker

Class FactorTracker.Builder

java.lang.Object

ai.djl.training.tracker.FactorTracker.Builder

Enclosing class:

FactorTracker

public static final class FactorTracker.Builder
extends Object

The Builder to construct an FactorTracker object.

Method Summary

Modifier and Type	Method	Description
FactorTracker	build()	Builds a FactorTracker block.
FactorTracker.Builder	optMaxUpdates(int maxUpdates)	Sets the maximum number of updates after which the value should remain constant.
FactorTracker.Builder	optMinValue(float min)	Sets the minimum value.
FactorTracker.Builder	setBaseValue(float baseValue)	Sets the initial value after no steps.
FactorTracker.Builder	setFactor(float factor)	Sets the value of the multiplicative factor.

Methods inherited from class java.lang.Object

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

Method Details

setBaseValue

public FactorTracker.Builder setBaseValue(float baseValue)

Sets the initial value after no steps.

Parameters:

baseValue - the initial value

Returns:

this Builder

setFactor

public FactorTracker.Builder setFactor(float factor)

Sets the value of the multiplicative factor.

Parameters:

factor - the value of the multiplicative factor

Returns:

this Builder

optMinValue

public FactorTracker.Builder optMinValue(float min)

Sets the minimum value.

This is equivalent to the max updates. Only one can be set.

Parameters:

min - the minimum value

Returns:

this Builder

optMaxUpdates

public FactorTracker.Builder optMaxUpdates(int maxUpdates)

Sets the maximum number of updates after which the value should remain constant.

Parameters:

maxUpdates - the maximum number of updates after which the value should remain constant

Returns:

this Builder

build

public FactorTracker build()

Builds a FactorTracker block.

Returns:

the FactorTracker block