org.nd4j.autodiff.listeners.impl

Class UIListener

java.lang.Object

org.nd4j.autodiff.listeners.BaseListener

org.nd4j.autodiff.listeners.impl.UIListener

All Implemented Interfaces:

Listener

public class UIListener
extends BaseListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIListener.Builder
static class	UIListener.FileMode Default: FileMode.CREATE_OR_APPEND The mode for handling behaviour when an existing UI file already exists CREATE: Only allow new file creation.
static class	UIListener.HistogramType Used to specify which histograms should be collected.
static class	UIListener.TestEvaluation
static class	UIListener.UpdateRatio Used to specify how the Update:Parameter ratios are computed.

Method Summary

Modifier and Type	Method and Description
static UIListener.Builder	builder(File logFile)
protected void	checkStructureForRestore(SameDiff sd)
ListenerResponse	epochEnd(SameDiff sd, At at, LossCurve lossCurve, long epochTimeMillis) Called at the end of every epoch, when fitting from an iterator
void	epochStart(SameDiff sd, At at) Called at the start of every epoch, when fitting from an iterator
protected void	initalizeWriter(SameDiff sd)
protected void	initializeHelper(SameDiff sd)
boolean	isActive(Operation operation) Returns whether this listener is active during the given operation.
void	iterationDone(SameDiff sd, At at, MultiDataSet dataSet, Loss loss) Called at the end of every iteration, after all operations (including updating parameters) has been completed
void	iterationStart(SameDiff sd, At at, MultiDataSet data, long etlMs) Called at the start of every iteration (minibatch), before any operations have been executed
void	opExecution(SameDiff sd, At at, MultiDataSet batch, SameDiffOp op, OpContext opContext, INDArray[] outputs) Called at the end of each operation execution
void	preUpdate(SameDiff sd, At at, Variable v, INDArray update) Called just before each parameter is to be updated - i.e., just before each parameter is modified.
protected void	restoreLogFile()

Methods inherited from class org.nd4j.autodiff.listeners.BaseListener

activationAvailable, operationEnd, operationStart, preOpExecution, requiredVariables, validationDone

Methods inherited from class java.lang.Object

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

Method Detail

restoreLogFile

protected void restoreLogFile()

checkStructureForRestore

protected void checkStructureForRestore(SameDiff sd)

initalizeWriter

protected void initalizeWriter(SameDiff sd)

initializeHelper

protected void initializeHelper(SameDiff sd)
                         throws IOException

Throws:

IOException

isActive

public boolean isActive(Operation operation)

Description copied from interface: Listener

Returns whether this listener is active during the given operation. If this returns false for the given operation, those listener methods will not be called.

epochStart

public void epochStart(SameDiff sd,
                       At at)

Description copied from interface: Listener

Called at the start of every epoch, when fitting from an iterator

Specified by:

epochStart in interface Listener

Overrides:

epochStart in class BaseListener

Parameters:

sd - The SameDiff instance

at - Current iteration/epoch etc

epochEnd

public ListenerResponse epochEnd(SameDiff sd,
                                 At at,
                                 LossCurve lossCurve,
                                 long epochTimeMillis)

Description copied from interface: Listener

Called at the end of every epoch, when fitting from an iterator

Specified by:

epochEnd in interface Listener

Overrides:

epochEnd in class BaseListener

Parameters:

sd - The SameDiff instance

at - Current iteration/epoch etc

lossCurve - The losses so far

epochTimeMillis - How long this epoch took

Returns:

ListenerResponse.STOP to stop training, CONTINUE or null to continue

iterationStart

public void iterationStart(SameDiff sd,
                           At at,
                           MultiDataSet data,
                           long etlMs)

Description copied from interface: Listener

Called at the start of every iteration (minibatch), before any operations have been executed

Specified by:

iterationStart in interface Listener

Overrides:

iterationStart in class BaseListener

Parameters:

sd - The SameDiff instance

at - Current iteration/epoch etc

iterationDone

public void iterationDone(SameDiff sd,
                          At at,
                          MultiDataSet dataSet,
                          Loss loss)

Description copied from interface: Listener

Called at the end of every iteration, after all operations (including updating parameters) has been completed

Specified by:

iterationDone in interface Listener

Overrides:

iterationDone in class BaseListener

Parameters:

sd - The SameDiff instance

at - Current iteration/epoch etc

dataSet - The current dataset (minibatch) used for training

loss - The loss value for the current minibatch. Will be null except for during training

opExecution

public void opExecution(SameDiff sd,
                        At at,
                        MultiDataSet batch,
                        SameDiffOp op,
                        OpContext opContext,
                        INDArray[] outputs)

Description copied from interface: Listener

Called at the end of each operation execution

Note: Outputs will most likely be freed later, use detach() if you need to save it.

Specified by:

opExecution in interface Listener

Overrides:

opExecution in class BaseListener

Parameters:

sd - The SameDiff instance

at - Current iteration/epoch etc

batch - The batch's input data. May be null if not called with a batch

op - Operation that has just been executed

outputs - The output arrays for the just-executed operation

preUpdate

public void preUpdate(SameDiff sd,
                      At at,
                      Variable v,
                      INDArray update)

Description copied from interface: Listener

Called just before each parameter is to be updated - i.e., just before each parameter is modified.

Specified by:

preUpdate in interface Listener

Overrides:

preUpdate in class BaseListener

Parameters:

sd - SameDiff instance

at - The current iteration/epoch etc

v - Variable about to be updated during backprop

update - The array representing the update (i.e., the gradient after applying learning rate, momentum, etc)

builder

public static UIListener.Builder builder(File logFile)