org.nd4j.autodiff.listeners.debugging

Class OpBenchmarkListener

java.lang.Object

org.nd4j.autodiff.listeners.BaseListener

org.nd4j.autodiff.listeners.debugging.OpBenchmarkListener

All Implemented Interfaces:

Listener

public class OpBenchmarkListener
extends BaseListener

A simple listener for benchmarking single operations in SameDiff
Supports 2 modes:
- SINGLE_ITER_PRINT: Print the runtime of the first iteration
- AGGREGATE: Collect statistics for multiple runs, that can be accessed (by op name) via #getAggregateModeMap()

Author:

Alex Black

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpBenchmarkListener.Mode
static class	OpBenchmarkListener.OpExec

Constructor Summary

Constructors

Constructor and Description
OpBenchmarkListener(Operation operation, @NonNull OpBenchmarkListener.Mode mode)
OpBenchmarkListener(Operation operation, @NonNull OpBenchmarkListener.Mode mode, long minRuntime)

Method Summary

Modifier and Type	Method and Description
boolean	isActive(Operation operation) Returns whether this listener is active during the given operation.
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, iterationDone, iterationStart, preUpdate, requiredVariables, validationDone

Methods inherited from class java.lang.Object

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

Constructor Detail

OpBenchmarkListener

public OpBenchmarkListener(Operation operation,
                           @NonNull
                           @NonNull OpBenchmarkListener.Mode mode)

OpBenchmarkListener

public OpBenchmarkListener(Operation operation,
                           @NonNull
                           @NonNull OpBenchmarkListener.Mode mode,
                           long minRuntime)

Parameters:

operation - Operation to collect stats for

mode - Mode - see OpBenchmarkListener

minRuntime - Minimum runtime - only applies to Mode.SINGLE_ITER_PRINT. If op runtime below this: don't print

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

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