ai.djl.training

Class DefaultTrainingConfig

java.lang.Object

ai.djl.training.DefaultTrainingConfig

All Implemented Interfaces:

TrainingConfig

public class DefaultTrainingConfig
extends java.lang.Object
implements TrainingConfig

DefaultTrainingConfig is an implementation of the TrainingConfig interface.

Constructor Summary

Constructors

Constructor and Description
DefaultTrainingConfig(Initializer initializer, Loss loss) Creates an instance of DefaultTrainingConfig with the given Initializer.

Method Summary

Modifier and Type	Method and Description
DefaultTrainingConfig	addTrainingMetric(TrainingMetric trainingMetric) Adds a TrainingMetric that needs to be computed during training.
int	getBatchSize() Gets the batch size that must be used during training.
Device[]	getDevices() Gets the Device that are available for computation.
Initializer	getInitializer() Gets the Initializer to initialize the parameters of the model.
Loss	getLossFunction() Gets the Loss function to compute the loss against.
Optimizer	getOptimizer() Gets the Optimizer to use during training.
java.util.List<TrainingMetric>	getTrainingMetrics() Returns the list of TrainingMetric that should be computed during training.
DefaultTrainingConfig	setBatchSize(int batchSize) Sets the size of a batch for training.
DefaultTrainingConfig	setDevices(Device[] devices) Sets the array of Device available for training.
DefaultTrainingConfig	setOptimizer(Optimizer optimizer) Sets the Optimizer used during training.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultTrainingConfig

public DefaultTrainingConfig(Initializer initializer,
                             Loss loss)

Creates an instance of DefaultTrainingConfig with the given Initializer.

Parameters:

initializer - the initializer to initialize the parameters with

loss - the loss to use for training

Method Detail

setDevices

public DefaultTrainingConfig setDevices(Device[] devices)

Sets the array of Device available for training.

Parameters:

devices - an array of devices to be set

Returns:

this DefaultTrainingConfig

setOptimizer

public DefaultTrainingConfig setOptimizer(Optimizer optimizer)

Sets the Optimizer used during training.

Parameters:

optimizer - the optimizer to be set

Returns:

this DefaultTrainingConfig

addTrainingMetric

public DefaultTrainingConfig addTrainingMetric(TrainingMetric trainingMetric)

Adds a TrainingMetric that needs to be computed during training.

Parameters:

trainingMetric - the training metric to be added

Returns:

this DefaultTrainingConfig

setBatchSize

public DefaultTrainingConfig setBatchSize(int batchSize)

Sets the size of a batch for training.

Parameters:

batchSize - the batch size

Returns:

this DefaultTrainingConfig

getDevices

public Device[] getDevices()

Gets the Device that are available for computation.

This is necessary for a Trainer as it needs to know what kind of device it is running on, and how many devices it is running on.

Specified by:

getDevices in interface TrainingConfig

Returns:

an array of Device

getInitializer

public Initializer getInitializer()

Gets the Initializer to initialize the parameters of the model.

Specified by:

getInitializer in interface TrainingConfig

Returns:

an Initializer

getOptimizer

public Optimizer getOptimizer()

Gets the Optimizer to use during training.

Specified by:

getOptimizer in interface TrainingConfig

Returns:

an Optimizer

getLossFunction

public Loss getLossFunction()

Gets the Loss function to compute the loss against.

Specified by:

getLossFunction in interface TrainingConfig

Returns:

a Loss function

getTrainingMetrics

public java.util.List<TrainingMetric> getTrainingMetrics()

Returns the list of TrainingMetric that should be computed during training.

Specified by:

getTrainingMetrics in interface TrainingConfig

Returns:

a list of TrainingMetric

getBatchSize

public int getBatchSize()

Gets the batch size that must be used during training.

Specified by:

getBatchSize in interface TrainingConfig

Returns:

the batch size