All Superinterfaces:

ParameterTracker

All Known Implementing Classes:

CosineTracker, CyclicalTracker, FactorTracker, LinearTracker, MultiFactorTracker, PolynomialDecayTracker, WarmUpTracker
```
public interface Tracker
extends ParameterTracker
```
A Tracker represents a hyperparameter that changes gradually through the training process.

See Also:

For tracking learning rates, the D2L chapter on learning rate scheduling

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`static CosineTracker.Builder`	`cosine()`	Returns a new instance of `CosineTracker.Builder` that can build an `CosineTracker`.
`static CyclicalTracker.Builder`	`cyclical()`	Returns a new instance of `CyclicalTracker.Builder` that can build an `CyclicalTracker`.
`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.
`default float`	`getNewValue(java.lang.String parameterId, int numUpdate)`	Fetches the value after the given number of steps/updates for the parameter.
`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
  - getNewValue
```
default float getNewValue(java.lang.String parameterId,
                          int numUpdate)
```
    Fetches the value after the given number of steps/updates for the parameter.
    
    Specified by:
    
    getNewValue in interface ParameterTracker
    
    Parameters:
    
    parameterId - the id of the parameter to get the new value for
    
    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
  - cyclical
```
static CyclicalTracker.Builder cyclical()
```
    Returns a new instance of CyclicalTracker.Builder that can build an CyclicalTracker.
    
    Returns:
    
    the CyclicalTracker CyclicalTracker.Builder
  - fixed
```
static Tracker fixed(float value)
```
    Returns a new instance of Tracker with a fixed value.
    
    Parameters:
    
    value - the fixed value
    
    Returns:
    
    an instance of Tracker with a fixed value

Interface Tracker

Method Summary

Method Detail

getNewValue

getNewValue

factor

warmUp

multiFactor

cosine

cyclical

fixed