WarmUpTracker.Builder (Deep Java Library 0.22.1 API specification)

java.lang.Object
- ai.djl.training.tracker.WarmUpTracker.Builder

Enclosing class:: WarmUpTracker

public static final class WarmUpTracker.Builder
extends java.lang.Object

The Builder to construct a WarmUpTracker.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`WarmUpTracker`	`build()`	Builds a `WarmUpTracker` block.
`WarmUpTracker.Builder`	`optWarmUpBeginValue(float warmUpBeginValue)`	Sets the value at the beginning of warm-up mode.
`WarmUpTracker.Builder`	`optWarmUpMode(WarmUpTracker.Mode warmUpMode)`	Sets the `WarmUpTracker.Mode` for the `WarmUpTracker`.
`WarmUpTracker.Builder`	`optWarmUpSteps(int warmUpSteps)`	Sets the number of steps until the point the value is updated in warm-up mode.
`WarmUpTracker.Builder`	`setMainTracker(Tracker mainTracker)`	Sets the base value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setMainTracker
```
public WarmUpTracker.Builder setMainTracker(Tracker mainTracker)
```
    Sets the base value.
    
    Parameters:
    
    mainTracker - the tracker to use after warm up ends
    
    Returns:
    
    this Builder
  - optWarmUpSteps
```
public WarmUpTracker.Builder optWarmUpSteps(int warmUpSteps)
```
    Sets the number of steps until the point the value is updated in warm-up mode.
    
    Parameters:
    
    warmUpSteps - the number of steps the value is updated in warm-up mode
    
    Returns:
    
    this Builder
  - optWarmUpBeginValue
```
public WarmUpTracker.Builder optWarmUpBeginValue(float warmUpBeginValue)
```
    Sets the value at the beginning of warm-up mode.
    
    Parameters:
    
    warmUpBeginValue - the value at the beginning of warm-up mode
    
    Returns:
    
    this Builder
  - optWarmUpMode
```
public WarmUpTracker.Builder optWarmUpMode(WarmUpTracker.Mode warmUpMode)
```
    Sets the WarmUpTracker.Mode for the WarmUpTracker.
    
    Parameters:
    
    warmUpMode - the WarmUpTracker.Mode to be set
    
    Returns:
    
    this Builder
  - build
```
public WarmUpTracker build()
```
    Builds a WarmUpTracker block.
    
    Returns:
    
    the WarmUpTracker block