Package org.nd4j.autodiff.listeners.profiler

Class ProfilingListener

java.lang.Object

org.nd4j.autodiff.listeners.BaseListener

org.nd4j.autodiff.listeners.profiler.ProfilingListener

All Implemented Interfaces:

Listener

public class ProfilingListener
extends BaseListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProfilingListener.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProfilingListener(@NonNull File outputFile, boolean all, int warmup, int nIter, long nMs, Operation[] operations)

Method Summary

Modifier and Type	Method	Description
static ProfilingListener.Builder	builder(File outputFile)	Create a new builder
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
static org.nd4j.shade.jackson.databind.ObjectMapper	jsonMapper()	Get a new JSON mapper for use in serializing/deserializing JSON format
void	operationEnd(SameDiff sd, Operation op)	Called at the end of an operation, e.g.
void	operationStart(SameDiff sd, Operation op)	Called at the start of an operation, e.g.
void	opExecution(SameDiff sd, At at, MultiDataSet batch, SameDiffOp op, OpContext opContext, INDArray[] outputs)	Called at the end of each operation execution
void	preOpExecution(SameDiff sd, At at, SameDiffOp op, OpContext opContext)	Called just before each operation is executed (native code called, etc) - after all inputs etc have been set

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

activationAvailable, epochEnd, epochStart, iterationStart, preUpdate, requiredVariables, validationDone

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfilingListener

protected ProfilingListener(@NonNull
                            @NonNull File outputFile,
                            boolean all,
                            int warmup,
                            int nIter,
                            long nMs,
                            Operation[] operations)

Method Detail

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.

operationStart

public void operationStart(SameDiff sd,
                           Operation op)

Description copied from interface: Listener

Called at the start of an operation, e.g. training or validation

Specified by:

operationStart in interface Listener

Overrides:

operationStart in class BaseListener

Parameters:

sd - The SameDiff instance

op - The operation being started

operationEnd

public void operationEnd(SameDiff sd,
                         Operation op)

Description copied from interface: Listener

Called at the end of an operation, e.g. training or validation

Specified by:

operationEnd in interface Listener

Overrides:

operationEnd in class BaseListener

Parameters:

sd - The SameDiff instance

op - The operation being started

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

preOpExecution

public void preOpExecution(SameDiff sd,
                           At at,
                           SameDiffOp op,
                           OpContext opContext)

Description copied from interface: Listener

Called just before each operation is executed (native code called, etc) - after all inputs etc have been set

Specified by:

preOpExecution in interface Listener

Overrides:

preOpExecution in class BaseListener

Parameters:

sd - The SameDiff instance

at - Current iteration/epoch etc

op - Operation that has just been executed

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

jsonMapper

public static org.nd4j.shade.jackson.databind.ObjectMapper jsonMapper()

Get a new JSON mapper for use in serializing/deserializing JSON format

builder

public static ProfilingListener.Builder builder(File outputFile)

Create a new builder

Parameters:

outputFile - Output file. Will be overwritten if file already exists