org.deeplearning4j.optimize.solvers.accumulation

Class EncodingHandler

java.lang.Object

org.deeplearning4j.optimize.solvers.accumulation.EncodingHandler

All Implemented Interfaces:

Serializable, MessageHandler

public class EncodingHandler
extends Object
implements MessageHandler

This MessageHandler implementation is suited for debugging mostly, but still can be used in production environment if you really want that. Basic idea: updates are encoded before sharing. This handler is used as basement for distributed handler though. PLEASE NOTE: This handler does NOT provide any network connectivity. *

Author:

[email protected]

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected GradientsAccumulator	accumulator
protected AtomicInteger	atomicBoundary
protected ThreadLocal<AtomicBoolean>	bitmapMode
protected Double	boundary
protected org.nd4j.linalg.compression.NDArrayCompressor	compressor
protected ThreadLocal<com.google.common.util.concurrent.AtomicDouble>	currentThreshold
protected ThreadLocal<AtomicLong>	iterations
protected ThreadLocal<AtomicLong>	lastStep
protected double	minThreshold
protected int	shakeFrequency
protected int	stepDelay
protected double	stepTrigger
protected double	threshold
protected double	thresholdStep

Constructor Summary

Constructors

Constructor and Description
EncodingHandler() This method builds new EncodingHandler instance with initial threshold of 1e-3
EncodingHandler(double threshold) This method builds new EncodingHandler instance
EncodingHandler(double threshold, Double boundary) This method builds new EncodingHandler instance
EncodingHandler(double threshold, double minThreshold, double thresholdStep, double stepTrigger, int stepDelay, int shakeFrequency) This method builds new EncodingHandler instance
EncodingHandler(double threshold, double minThreshold, double thresholdStep, double stepTrigger, int stepDelay, int shakeFrequency, Double boundary) This method builds new EncodingHandler instance

Method Summary

Modifier and Type	Method and Description
boolean	broadcastUpdates(org.nd4j.linalg.api.ndarray.INDArray updates) This method does broadcast of given update message across network
org.nd4j.linalg.api.ndarray.INDArray	decodeUpdates(org.nd4j.linalg.api.ndarray.INDArray message) Deprecated.
org.nd4j.linalg.api.ndarray.INDArray	encodeUpdates(org.nd4j.linalg.api.ndarray.INDArray updates)
void	initialize(GradientsAccumulator accumulator) This method does initial configuration of given MessageHandler instance
protected void	sendMessage(org.nd4j.linalg.api.ndarray.INDArray message) This method does loops encoded data back to updates queue

Methods inherited from class java.lang.Object

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

Field Detail

accumulator

protected transient GradientsAccumulator accumulator

threshold

protected double threshold

minThreshold

protected double minThreshold

thresholdStep

protected double thresholdStep

stepTrigger

protected double stepTrigger

shakeFrequency

protected int shakeFrequency

stepDelay

protected int stepDelay

boundary

protected Double boundary

compressor

protected org.nd4j.linalg.compression.NDArrayCompressor compressor

atomicBoundary

protected AtomicInteger atomicBoundary

iterations

protected ThreadLocal<AtomicLong> iterations

lastStep

protected ThreadLocal<AtomicLong> lastStep

currentThreshold

protected ThreadLocal<com.google.common.util.concurrent.AtomicDouble> currentThreshold

bitmapMode

protected ThreadLocal<AtomicBoolean> bitmapMode

Constructor Detail

EncodingHandler

public EncodingHandler()

This method builds new EncodingHandler instance with initial threshold of 1e-3

EncodingHandler

public EncodingHandler(double threshold)

This method builds new EncodingHandler instance

Parameters:

threshold - Initial encoding threshold

EncodingHandler

public EncodingHandler(double threshold,
                       Double boundary)

This method builds new EncodingHandler instance

Parameters:

threshold - Initial encoding threshold

EncodingHandler

public EncodingHandler(double threshold,
                       double minThreshold,
                       double thresholdStep,
                       double stepTrigger,
                       int stepDelay,
                       int shakeFrequency)

This method builds new EncodingHandler instance

Parameters:

threshold - Initial encoding threshold

minThreshold - Minimal encoding threshold (for threshold decay)

thresholdStep - Decay step for threshold decay

stepTrigger - Sparse/Dense ratio that will trigger decay step. In range 0..100

stepDelay - Minimal number of iterations between decay steps

shakeFrequency - How ofter we'll be sending dense updates with lower threshold

EncodingHandler

public EncodingHandler(double threshold,
                       double minThreshold,
                       double thresholdStep,
                       double stepTrigger,
                       int stepDelay,
                       int shakeFrequency,
                       Double boundary)

This method builds new EncodingHandler instance

Parameters:

threshold - Initial encoding threshold

minThreshold - Minimal encoding threshold (for threshold decay)

thresholdStep - Decay step for threshold decay

stepTrigger - Sparse/Dense ratio that will trigger decay step. In range 0..100

stepDelay - Minimal number of iterations between decay steps

shakeFrequency - How ofter we'll be sending dense updates with lower threshold

boundary -

Method Detail

initialize

public void initialize(@NonNull
                       GradientsAccumulator accumulator)

Description copied from interface: MessageHandler

This method does initial configuration of given MessageHandler instance

Specified by:

initialize in interface MessageHandler

encodeUpdates

public org.nd4j.linalg.api.ndarray.INDArray encodeUpdates(org.nd4j.linalg.api.ndarray.INDArray updates)

decodeUpdates

@Deprecated
public org.nd4j.linalg.api.ndarray.INDArray decodeUpdates(org.nd4j.linalg.api.ndarray.INDArray message)

Deprecated.

sendMessage

protected void sendMessage(org.nd4j.linalg.api.ndarray.INDArray message)

This method does loops encoded data back to updates queue

Parameters:

message -

broadcastUpdates

public boolean broadcastUpdates(org.nd4j.linalg.api.ndarray.INDArray updates)

Description copied from interface: MessageHandler

This method does broadcast of given update message across network

Specified by:

broadcastUpdates in interface MessageHandler

Returns:

TRUE if something was sent, FALSE otherwise