ai.djl.training.tracker

Class WarmUpTracker

java.lang.Object

ai.djl.training.tracker.WarmUpTracker

All Implemented Interfaces:

Tracker

public final class WarmUpTracker
extends java.lang.Object
implements Tracker

A WarmUpTracker applies a simple warm-up before executing a main Tracker.

See Also:

For tracking learning rates, this section in the D2L chapter on learning rate scheduling

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WarmUpTracker.Builder The Builder to construct a WarmUpTracker.
static class	WarmUpTracker.Mode An enum that enumerates the types of warm-up modes for a WarmUpTracker.

Method Summary

Modifier and Type	Method and Description
static WarmUpTracker.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

cosine, factor, fixed, multiFactor, warmUp

Method Detail

builder

public static WarmUpTracker.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