org.nd4j.linalg.api.ops.executioner

Class DefaultOpExecutioner

java.lang.Object

org.nd4j.linalg.api.ops.executioner.DefaultOpExecutioner

All Implemented Interfaces:

OpExecutioner

public class DefaultOpExecutioner
extends Object
implements OpExecutioner

Basic op executioner. Knows how to iterate over the buffers of each respective ndarray and apply transformations

Author:

Adam Gibson

Nested Class Summary

Nested classes/interfaces inherited from interface org.nd4j.linalg.api.ops.executioner.OpExecutioner

OpExecutioner.ExecutionMode, OpExecutioner.ProfilingMode

Field Summary

Fields

Modifier and Type	Field and Description
protected OpExecutioner.ExecutionMode	executionMode
protected OpExecutioner.ProfilingMode	profilingMode

Constructor Summary

Constructors

Constructor and Description
DefaultOpExecutioner()

Method Summary

Modifier and Type	Method and Description
INDArray	bitmapDecode(INDArray encoded, INDArray target)
INDArray	bitmapEncode(INDArray indArray, double threshold)
long	bitmapEncode(INDArray indArray, INDArray target, double threshold) This method returns number of elements affected by encoder
List<int[]>	calculateOutputShape(CustomOp op)
protected void	checkForCompression(Op op)
protected void	checkForWorkspaces(CustomOp op)
protected void	checkForWorkspaces(Op op)
protected void	checkWorkspace(String opName, INDArray array)
void	commit() This method ensures all operations that supposed to be executed at this moment, are executed and finished.
void	enableDebugMode(boolean reallyEnable)
void	enableVerboseMode(boolean reallyEnable)
INDArray	exec(Accumulation op, int... dimension) Execute an accumulation along one or more dimensions
void	exec(Aggregate op)
<T extends Aggregate> void	exec(Batch<T> batch) This method executes previously built batch
INDArray	exec(BroadcastOp broadcast, int... dimension) Execute an broadcast along one or more dimensions
void	exec(CustomOp op) This method executes given CustomOp PLEASE NOTE: You're responsible for input/output validation
void	exec(GridOp op) Execute GridOp
INDArray	exec(IndexAccumulation op, int... dimension) Execute an index accumulation along one or more dimensions
void	exec(List<Aggregate> batch) This method takes arbitrary sized list of aggregates, and packs them into batches
void	exec(MetaOp op) Execute MetaOp
Op	exec(Op op) Execute the operation
Op	exec(Op op, int... dimension) Execute the operation along 1 or more dimensions
INDArray	exec(RandomOp op) This method executes specified RandomOp using default RNG available via Nd4j.getRandom()
INDArray	exec(RandomOp op, Random rng) This method executes specific RandomOp against specified RNG
void	exec(ShapeOp op)
INDArray	exec(Variance accumulation, boolean biasCorrected, int... dimension) Execute an accumulation along one or more dimensions
Accumulation	execAndReturn(Accumulation op) Execute and return the result from an accumulation
INDArray	execAndReturn(BroadcastOp op) Execute and return the result from a vector op
IndexAccumulation	execAndReturn(IndexAccumulation op) Execute and return the result from an index accumulation
INDArray	execAndReturn(Op op) Execute and return a result ndarray from the given op
INDArray	execAndReturn(ScalarOp op) Execute and return the result from a scalar op
INDArray	execAndReturn(ShapeOp op) Execute and return the result from a vector op
INDArray	execAndReturn(TransformOp op) Execute a TransformOp and return the result
Accumulation	execAndReturn(Variance op, boolean biasCorrected) Execute and return the result from an accumulation
Map<String,INDArray>	executeGraph(long id, Map<String,INDArray> map)
OpExecutioner.ExecutionMode	executionMode() Get the execution mode for this executioner
void	forgetGraph(long id)
Map<String,CustomOpDescriptor>	getCustomOperations() This method returns names of all custom operations available in current backend, and their number of input/output arguments
Properties	getEnvironmentInformation() This method return set of key/value and key/key/value objects, describing current environment
String	getLastOp() This method returns opName of the last invoked op
OpExecutioner.ProfilingMode	getProfilingMode() Ths method returns current profiling
TADManager	getTADManager() This method returns TADManager instance used for this OpExecutioner
protected void	interceptIntDataType(Op op) This method checks if any Op operand has data opType of INT, and throws exception if any.
void	iterateOverAllColumns(Op op) Iterate over every column of every slice
void	iterateOverAllRows(Op op) Iterate over every row of every slice
void	printEnvironmentInformation() This method prints out environmental information returned by getEnvironmentInformation() method
long	profilingHookIn(CustomOp op)
long	profilingHookIn(Op op)
long	profilingHookIn(Op op, DataBuffer... tadBuffers)
void	profilingHookOut(CustomOp op, long timeStart)
void	profilingHookOut(Op op, long timeStart)
void	push() This method ensures all operations that supposed to be executed at this moment, are executed.
void	registerGraph(long id, org.bytedeco.javacpp.Pointer graph)
void	setElementsThreshold(int threshold) This method allows to set desired number of elements per thread, for performance optimization purposes.
void	setExecutionMode(OpExecutioner.ExecutionMode executionMode) Set the execution mode
void	setProfilingMode(OpExecutioner.ProfilingMode mode) This method specifies desired profiling mode
void	setTadThreshold(int threshold) This method allows to set desired number of sub-arrays per thread, for performance optimization purposes.
INDArray	thresholdDecode(INDArray encoded, INDArray target) This method decodes thresholds array, and puts it into target array
INDArray	thresholdEncode(INDArray input, double threshold) This method encodes array as thresholds, updating input array at the same time
INDArray	thresholdEncode(INDArray input, double threshold, Integer boundary) This method encodes array as thresholds, updating input array at the same time
static void	validateDataType(DataBuffer.Type expectedType, INDArray... operands)
static void	validateDataType(DataBuffer.Type expectedType, Op op) Validate the data types for the given operation

Methods inherited from class java.lang.Object

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

Field Detail

profilingMode

protected OpExecutioner.ProfilingMode profilingMode

executionMode

protected OpExecutioner.ExecutionMode executionMode

Constructor Detail

DefaultOpExecutioner

public DefaultOpExecutioner()

Method Detail

checkForCompression

protected void checkForCompression(Op op)

getLastOp

public String getLastOp()

Description copied from interface: OpExecutioner

This method returns opName of the last invoked op

Specified by:

getLastOp in interface OpExecutioner

Returns:

interceptIntDataType

protected void interceptIntDataType(Op op)

This method checks if any Op operand has data opType of INT, and throws exception if any.

Parameters:

op -

exec

public Op exec(Op op)

Description copied from interface: OpExecutioner

Execute the operation

Specified by:

exec in interface OpExecutioner

Parameters:

op - the operation to execute

execAndReturn

public INDArray execAndReturn(Op op)

Description copied from interface: OpExecutioner

Execute and return a result ndarray from the given op

Specified by:

execAndReturn in interface OpExecutioner

Parameters:

op - the operation to execute

Returns:

the result from the operation

iterateOverAllRows

public void iterateOverAllRows(Op op)

Description copied from interface: OpExecutioner

Iterate over every row of every slice

Specified by:

iterateOverAllRows in interface OpExecutioner

Parameters:

op - the operation to apply

iterateOverAllColumns

public void iterateOverAllColumns(Op op)

Description copied from interface: OpExecutioner

Iterate over every column of every slice

Specified by:

iterateOverAllColumns in interface OpExecutioner

Parameters:

op - the operation to apply

execAndReturn

public INDArray execAndReturn(TransformOp op)

Description copied from interface: OpExecutioner

Execute a TransformOp and return the result

Specified by:

execAndReturn in interface OpExecutioner

Parameters:

op - the operation to execute

execAndReturn

public Accumulation execAndReturn(Accumulation op)

Description copied from interface: OpExecutioner

Execute and return the result from an accumulation

Specified by:

execAndReturn in interface OpExecutioner

Parameters:

op - the operation to execute

Returns:

the accumulated result

execAndReturn

public Accumulation execAndReturn(Variance op,
                                  boolean biasCorrected)

Description copied from interface: OpExecutioner

Execute and return the result from an accumulation

Specified by:

execAndReturn in interface OpExecutioner

Parameters:

op - the operation to execute

Returns:

the accumulated result

execAndReturn

public INDArray execAndReturn(ScalarOp op)

Description copied from interface: OpExecutioner

Execute and return the result from a scalar op

Specified by:

execAndReturn in interface OpExecutioner

Parameters:

op - the operation to execute

Returns:

the accumulated result

execAndReturn

public IndexAccumulation execAndReturn(IndexAccumulation op)

Description copied from interface: OpExecutioner

Execute and return the result from an index accumulation

Specified by:

execAndReturn in interface OpExecutioner

Parameters:

op - the index accumulation operation to execute

Returns:

the accumulated index

execAndReturn

public INDArray execAndReturn(BroadcastOp op)

Description copied from interface: OpExecutioner

Execute and return the result from a vector op

Specified by:

execAndReturn in interface OpExecutioner

execAndReturn

public INDArray execAndReturn(ShapeOp op)

Execute and return the result from a vector op

Specified by:

execAndReturn in interface OpExecutioner

Parameters:

op -

exec

public Op exec(Op op,
               int... dimension)

Description copied from interface: OpExecutioner

Execute the operation along 1 or more dimensions

Specified by:

exec in interface OpExecutioner

Parameters:

op - the operation to execute

exec

public INDArray exec(Accumulation op,
                     int... dimension)

Description copied from interface: OpExecutioner

Execute an accumulation along one or more dimensions

Specified by:

exec in interface OpExecutioner

Parameters:

op - the accumulation

dimension - the dimension

Returns:

the accumulation op

exec

public INDArray exec(Variance accumulation,
                     boolean biasCorrected,
                     int... dimension)

Description copied from interface: OpExecutioner

Execute an accumulation along one or more dimensions

Specified by:

exec in interface OpExecutioner

Parameters:

accumulation - the accumulation

dimension - the dimension

Returns:

the accmulation op

exec

public INDArray exec(IndexAccumulation op,
                     int... dimension)

Description copied from interface: OpExecutioner

Execute an index accumulation along one or more dimensions

Specified by:

exec in interface OpExecutioner

Parameters:

op - the index accumulation operation

dimension - the dimension/s to execute along

Returns:

result

executionMode

public OpExecutioner.ExecutionMode executionMode()

Description copied from interface: OpExecutioner

Get the execution mode for this executioner

Specified by:

executionMode in interface OpExecutioner

Returns:

the execution mode for this executioner

setExecutionMode

public void setExecutionMode(OpExecutioner.ExecutionMode executionMode)

Description copied from interface: OpExecutioner

Set the execution mode

Specified by:

setExecutionMode in interface OpExecutioner

Parameters:

executionMode - the execution mode

exec

public INDArray exec(BroadcastOp broadcast,
                     int... dimension)

Description copied from interface: OpExecutioner

Execute an broadcast along one or more dimensions

Specified by:

exec in interface OpExecutioner

Parameters:

broadcast - the accumulation

dimension - the dimension

Returns:

the broadcast op

exec

public void exec(MetaOp op)

Description copied from interface: OpExecutioner

Execute MetaOp

Specified by:

exec in interface OpExecutioner

exec

public void exec(GridOp op)

Description copied from interface: OpExecutioner

Execute GridOp

Specified by:

exec in interface OpExecutioner

exec

public <T extends Aggregate> void exec(Batch<T> batch)

Description copied from interface: OpExecutioner

This method executes previously built batch

Specified by:

exec in interface OpExecutioner

exec

public void exec(Aggregate op)

Specified by:

exec in interface OpExecutioner

exec

public void exec(ShapeOp op)

Specified by:

exec in interface OpExecutioner

Parameters:

op -

exec

public void exec(List<Aggregate> batch)

Description copied from interface: OpExecutioner

This method takes arbitrary sized list of aggregates, and packs them into batches

Specified by:

exec in interface OpExecutioner

exec

public INDArray exec(RandomOp op)

This method executes specified RandomOp using default RNG available via Nd4j.getRandom()

Specified by:

exec in interface OpExecutioner

Parameters:

op -

exec

public INDArray exec(RandomOp op,
                     Random rng)

This method executes specific RandomOp against specified RNG

Specified by:

exec in interface OpExecutioner

Parameters:

op -

rng -

setProfilingMode

public void setProfilingMode(OpExecutioner.ProfilingMode mode)

Description copied from interface: OpExecutioner

This method specifies desired profiling mode

Specified by:

setProfilingMode in interface OpExecutioner

getProfilingMode

public OpExecutioner.ProfilingMode getProfilingMode()

Description copied from interface: OpExecutioner

Ths method returns current profiling

Specified by:

getProfilingMode in interface OpExecutioner

Returns:

profilingHookIn

public long profilingHookIn(Op op,
                            DataBuffer... tadBuffers)

checkWorkspace

protected void checkWorkspace(String opName,
                              INDArray array)

checkForWorkspaces

protected void checkForWorkspaces(CustomOp op)

checkForWorkspaces

protected void checkForWorkspaces(Op op)

profilingHookIn

public long profilingHookIn(Op op)

profilingHookIn

public long profilingHookIn(CustomOp op)

profilingHookOut

public void profilingHookOut(Op op,
                             long timeStart)

profilingHookOut

public void profilingHookOut(CustomOp op,
                             long timeStart)

validateDataType

public static void validateDataType(DataBuffer.Type expectedType,
                                    Op op)

Validate the data types for the given operation

Parameters:

expectedType -

op -

validateDataType

public static void validateDataType(DataBuffer.Type expectedType,
                                    INDArray... operands)

getTADManager

public TADManager getTADManager()

Description copied from interface: OpExecutioner

This method returns TADManager instance used for this OpExecutioner

Specified by:

getTADManager in interface OpExecutioner

Returns:

getEnvironmentInformation

public Properties getEnvironmentInformation()

This method return set of key/value and key/key/value objects, describing current environment

Specified by:

getEnvironmentInformation in interface OpExecutioner

Returns:

printEnvironmentInformation

public void printEnvironmentInformation()

Description copied from interface: OpExecutioner

This method prints out environmental information returned by getEnvironmentInformation() method

Specified by:

printEnvironmentInformation in interface OpExecutioner

push

public void push()

Description copied from interface: OpExecutioner

This method ensures all operations that supposed to be executed at this moment, are executed.

Specified by:

push in interface OpExecutioner

commit

public void commit()

Description copied from interface: OpExecutioner

This method ensures all operations that supposed to be executed at this moment, are executed and finished.

Specified by:

commit in interface OpExecutioner

thresholdEncode

public INDArray thresholdEncode(INDArray input,
                                double threshold)

Description copied from interface: OpExecutioner

This method encodes array as thresholds, updating input array at the same time

Specified by:

thresholdEncode in interface OpExecutioner

Returns:

encoded array is returned

thresholdEncode

public INDArray thresholdEncode(INDArray input,
                                double threshold,
                                Integer boundary)

Description copied from interface: OpExecutioner

This method encodes array as thresholds, updating input array at the same time

Specified by:

thresholdEncode in interface OpExecutioner

Returns:

encoded array is returned

thresholdDecode

public INDArray thresholdDecode(INDArray encoded,
                                INDArray target)

Description copied from interface: OpExecutioner

This method decodes thresholds array, and puts it into target array

Specified by:

thresholdDecode in interface OpExecutioner

Returns:

target is returned

bitmapEncode

public long bitmapEncode(INDArray indArray,
                         INDArray target,
                         double threshold)

Description copied from interface: OpExecutioner

This method returns number of elements affected by encoder

Specified by:

bitmapEncode in interface OpExecutioner

Returns:

bitmapEncode

public INDArray bitmapEncode(INDArray indArray,
                             double threshold)

Specified by:

bitmapEncode in interface OpExecutioner

Returns:

bitmapDecode

public INDArray bitmapDecode(INDArray encoded,
                             INDArray target)

Specified by:

bitmapDecode in interface OpExecutioner

Returns:

getCustomOperations

public Map<String,CustomOpDescriptor> getCustomOperations()

Description copied from interface: OpExecutioner

This method returns names of all custom operations available in current backend, and their number of input/output arguments

Specified by:

getCustomOperations in interface OpExecutioner

Returns:

exec

public void exec(CustomOp op)

Description copied from interface: OpExecutioner

This method executes given CustomOp PLEASE NOTE: You're responsible for input/output validation

Specified by:

exec in interface OpExecutioner

calculateOutputShape

public List<int[]> calculateOutputShape(CustomOp op)

Specified by:

calculateOutputShape in interface OpExecutioner

enableDebugMode

public void enableDebugMode(boolean reallyEnable)

Specified by:

enableDebugMode in interface OpExecutioner

enableVerboseMode

public void enableVerboseMode(boolean reallyEnable)

Specified by:

enableVerboseMode in interface OpExecutioner

registerGraph

public void registerGraph(long id,
                          org.bytedeco.javacpp.Pointer graph)

Specified by:

registerGraph in interface OpExecutioner

executeGraph

public Map<String,INDArray> executeGraph(long id,
                                         Map<String,INDArray> map)

Specified by:

executeGraph in interface OpExecutioner

forgetGraph

public void forgetGraph(long id)

Specified by:

forgetGraph in interface OpExecutioner

setElementsThreshold

public void setElementsThreshold(int threshold)

This method allows to set desired number of elements per thread, for performance optimization purposes. I.e. if array contains 2048 elements, and threshold is set to 1024, 2 threads will be used for given op execution.

Default value: 1024

Specified by:

setElementsThreshold in interface OpExecutioner

Parameters:

threshold -

setTadThreshold

public void setTadThreshold(int threshold)

This method allows to set desired number of sub-arrays per thread, for performance optimization purposes. I.e. if matrix has shape of 64 x 128, and threshold is set to 8, each thread will be processing 8 sub-arrays (sure, if you have 8 core cpu). If your cpu has, say, 4, cores, only 4 threads will be spawned, and each will process 16 sub-arrays

Default value: 8

Specified by:

setTadThreshold in interface OpExecutioner

Parameters:

threshold -