ai.djl.training.tracker

Interface Tracker

All Known Implementing Classes:

CosineTracker, FactorTracker, LinearTracker, MultiFactorTracker, WarmUpTracker

public interface Tracker

A Tracker represents a hyper-parameter that changes gradually through the training process.

Method Summary

Modifier and Type	Method and Description
static CosineTracker.Builder	cosine() Returns a new instance of CosineTracker.Builder that can build an CosineTracker.
static FactorTracker.Builder	factor() Returns a new instance of FactorTracker.Builder that can build an FactorTracker.
static Tracker	fixed(float value) Returns a new instance of Tracker with a fixed value.
float	getNewValue(int numUpdate) Fetches the value after the given number of steps/updates.
static MultiFactorTracker.Builder	multiFactor() Returns a new instance of MultiFactorTracker.Builder that can build an MultiFactorTracker.
static WarmUpTracker.Builder	warmUp() Returns a new instance of WarmUpTracker.Builder that can build an WarmUpTracker.

Method Detail

getNewValue

float getNewValue(int numUpdate)

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

Parameters:

numUpdate - the total number of steps/updates

Returns:

this Builder

factor

static FactorTracker.Builder factor()

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

Returns:

the FactorTracker FactorTracker.Builder

warmUp

static WarmUpTracker.Builder warmUp()

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

Returns:

the WarmUpTracker WarmUpTracker.Builder

multiFactor

static MultiFactorTracker.Builder multiFactor()

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

Returns:

the MultiFactorTracker MultiFactorTracker.Builder

cosine

static CosineTracker.Builder cosine()

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

Returns:

the CosineTracker CosineTracker.Builder

fixed

static Tracker fixed(float value)

Returns a new instance of Tracker with a fixed value.

Parameters:

value - the fixed value

Returns:

a instance of Tracker with a fixed value