ai.djl.training.listener

Class MemoryTrainingListener

java.lang.Object

ai.djl.training.listener.MemoryTrainingListener

All Implemented Interfaces:

TrainingListener

public class MemoryTrainingListener
extends java.lang.Object
implements TrainingListener

TrainingListener that collects the memory usage information.

If an outputDir is provided, the file "$outputDir/memory.log" will be created after training with the memory usage results.

Nested Class Summary

Nested classes/interfaces inherited from interface ai.djl.training.listener.TrainingListener

TrainingListener.BatchData, TrainingListener.Defaults

Constructor Summary

Constructors

Constructor and Description
MemoryTrainingListener() Constructs a MemoryTrainingListener that does not output data to a file.
MemoryTrainingListener(java.lang.String outputDir) Constructs a MemoryTrainingListener that outputs data in the given directory.

Method Summary

Modifier and Type	Method and Description
static void	collectMemoryInfo(Metrics metrics) Collect memory information.
static void	dumpMemoryInfo(Metrics metrics, java.lang.String logDir) Dump memory metrics into log directory.
void	onEpoch(Trainer trainer) Listens to the end of an epoch during training.
void	onTrainingBatch(Trainer trainer, TrainingListener.BatchData batchData) Listens to the end of training one batch of data during training.
void	onTrainingBegin(Trainer trainer) Listens to the beginning of training.
void	onTrainingEnd(Trainer trainer) Listens to the end of training.
void	onValidationBatch(Trainer trainer, TrainingListener.BatchData batchData) Listens to the end of validating one batch of data during validation.

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryTrainingListener

public MemoryTrainingListener()

Constructs a MemoryTrainingListener that does not output data to a file.

MemoryTrainingListener

public MemoryTrainingListener(java.lang.String outputDir)

Constructs a MemoryTrainingListener that outputs data in the given directory.

Parameters:

outputDir - the directory to output the tracked memory data in

Method Detail

onEpoch

public void onEpoch(Trainer trainer)

Listens to the end of an epoch during training.

Specified by:

onEpoch in interface TrainingListener

Parameters:

trainer - the trainer the listener is attached to

onTrainingBatch

public void onTrainingBatch(Trainer trainer,
                            TrainingListener.BatchData batchData)

Listens to the end of training one batch of data during training.

Specified by:

onTrainingBatch in interface TrainingListener

Parameters:

trainer - the trainer the listener is attached to

batchData - the data from the batch

onValidationBatch

public void onValidationBatch(Trainer trainer,
                              TrainingListener.BatchData batchData)

Listens to the end of validating one batch of data during validation.

Specified by:

onValidationBatch in interface TrainingListener

Parameters:

trainer - the trainer the listener is attached to

batchData - the data from the batch

onTrainingBegin

public void onTrainingBegin(Trainer trainer)

Listens to the beginning of training.

Specified by:

onTrainingBegin in interface TrainingListener

Parameters:

trainer - the trainer the listener is attached to

onTrainingEnd

public void onTrainingEnd(Trainer trainer)

Listens to the end of training.

Specified by:

onTrainingEnd in interface TrainingListener

Parameters:

trainer - the trainer the listener is attached to

collectMemoryInfo

public static void collectMemoryInfo(Metrics metrics)

Collect memory information.

Parameters:

metrics - Metrics to store memory information

dumpMemoryInfo

public static void dumpMemoryInfo(Metrics metrics,
                                  java.lang.String logDir)

Dump memory metrics into log directory.

Parameters:

metrics - metrics contains memory information

logDir - output log directory