Sgd.Builder (Deep Java Library 0.24.0 API specification)

java.lang.Object
- ai.djl.training.optimizer.Optimizer.OptimizerBuilder<Sgd.Builder>
- - ai.djl.training.optimizer.Sgd.Builder

Enclosing class:: Sgd

public static final class Sgd.Builder
extends Optimizer.OptimizerBuilder<Sgd.Builder>

The Builder to construct an Sgd object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Sgd`	`build()`	Builds a `Sgd` block.
`Sgd.Builder`	`optMomentum(float momentum)`	Sets the momentum for `Sgd`.
`protected Sgd.Builder`	`self()`
`Sgd.Builder`	`setLearningRateTracker(ParameterTracker learningRateTracker)`	Sets the `ParameterTracker` for this optimizer.

Methods inherited from class ai.djl.training.optimizer.Optimizer.OptimizerBuilder
optBeginNumUpdate, optClipGrad, optWeightDecays, setRescaleGrad

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

- Method Detail
  - self
```
protected Sgd.Builder self()
```
    Specified by:
    
    self in class Optimizer.OptimizerBuilder<Sgd.Builder>
  - setLearningRateTracker
```
public Sgd.Builder setLearningRateTracker(ParameterTracker learningRateTracker)
```
    Sets the ParameterTracker for this optimizer.
    
    Parameters:
    
    learningRateTracker - the ParameterTracker to be set
    
    Returns:
    
    this Builder
  - optMomentum
```
public Sgd.Builder optMomentum(float momentum)
```
    Sets the momentum for Sgd.
    
    Parameters:
    
    momentum - the value of momentum
    
    Returns:
    
    this Builder
  - build
```
public Sgd build()
```
    Builds a Sgd block.
    
    Returns:
    
    the Sgd block