FactorTracker (Deep Java Library 0.24.0 API specification)

java.lang.Object
- ai.djl.training.tracker.FactorTracker

All Implemented Interfaces:

ParameterTracker, Tracker
```
public class FactorTracker
extends java.lang.Object
implements Tracker
```
FactorTracker is an implementation of Tracker which is updated by a multiplicative factor.

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 Description

static class FactorTracker.Builder
The Builder to construct an FactorTracker object.

Constructor Summary

Constructors
Constructor Description

FactorTracker(FactorTracker.Builder builder)
Creates a new instance of FactorTracker.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static FactorTracker.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
getNewValue

- Constructor Detail
  - FactorTracker
```
public FactorTracker(FactorTracker.Builder builder)
```
    Creates a new instance of FactorTracker.
    
    Parameters:
    
    builder - the builder to create a new instance of FactorTracker
- Method Detail
  - builder
```
public static FactorTracker.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