org.nd4j.parameterserver.distributed.v2

Class ModelParameterServer

java.lang.Object

org.nd4j.parameterserver.distributed.v2.ModelParameterServer

public final class ModelParameterServer
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected VoidConfiguration	configuration
protected org.nd4j.common.primitives.AtomicBoolean	gotFinalState
protected static ModelParameterServer	INSTANCE
protected List<org.reactivestreams.Subscriber<org.nd4j.linalg.api.ndarray.INDArray>>	modelParamsSubsribers
protected org.nd4j.common.primitives.Atomic<UpdaterParametersHolder>	updaterParameters
protected ReentrantReadWriteLock	updaterParamsLock
protected List<org.reactivestreams.Subscriber<org.nd4j.linalg.api.ndarray.INDArray>>	updaterParamsSubscribers
protected BlockingQueue<org.nd4j.linalg.api.ndarray.INDArray>	updatesBacklog
protected List<UpdatesHandler>	updatesSubscribers

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModelParameterServer()
protected	ModelParameterServer(@NonNull Transport transport) This constructor is for tests only
protected	ModelParameterServer(@NonNull Transport transport, boolean isMasterNode) This constructor is for tests only
	ModelParameterServer(@NonNull VoidConfiguration configuration, @NonNull Transport transport, boolean isMasterNode) This constructor creates new ModelParameterServer instance

Method Summary

Modifier and Type	Method and Description
void	addModelParamsSubscriber(@NonNull org.reactivestreams.Subscriber<org.nd4j.linalg.api.ndarray.INDArray> s) This method adds subcriber that will be called upon model params receival
void	addUpdaterParamsSubscriber(@NonNull org.reactivestreams.Subscriber<org.nd4j.linalg.api.ndarray.INDArray> s) This method adds subcriber that will be called upon updater params receival
void	addUpdatesSubscriber(@NonNull UpdatesHandler s) This method adds subcriber that will be called upon gradients update receival
void	configure(@NonNull VoidConfiguration configuration, @NonNull Transport transport, boolean isMasterNode) This method stores provided entities for MPS internal use
void	configure(@NonNull VoidConfiguration configuration, @NonNull Transport transport, @NonNull UpdaterParametersProvider updaterProvider) This method stores provided entities for MPS internal use
static ModelParameterServer	getInstance()
org.nd4j.common.primitives.Pair<Integer,Integer>	getStartPosition() This method returns pair of integers: iteration number and epoch number
Collection<org.nd4j.linalg.api.ndarray.INDArray>	getUpdates() This method returns updates received from network
boolean	isInitialized() This method checks if ModelParameterServer was initialized
void	launch() This method starts parameter server
void	sendUpdate(@NonNull org.nd4j.linalg.api.ndarray.INDArray array) This method sends gradient updates to the cluster
void	sendUpdate(@NonNull org.nd4j.linalg.api.ndarray.INDArray array, int iteration, int epoch)
void	shutdown() This method stops parameter server

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

protected static final ModelParameterServer INSTANCE

updatesSubscribers

protected final List<UpdatesHandler> updatesSubscribers

modelParamsSubsribers

protected final List<org.reactivestreams.Subscriber<org.nd4j.linalg.api.ndarray.INDArray>> modelParamsSubsribers

updaterParamsSubscribers

protected final List<org.reactivestreams.Subscriber<org.nd4j.linalg.api.ndarray.INDArray>> updaterParamsSubscribers

configuration

protected VoidConfiguration configuration

updatesBacklog

protected BlockingQueue<org.nd4j.linalg.api.ndarray.INDArray> updatesBacklog

updaterParameters

protected final org.nd4j.common.primitives.Atomic<UpdaterParametersHolder> updaterParameters

updaterParamsLock

protected final ReentrantReadWriteLock updaterParamsLock

gotFinalState

protected final org.nd4j.common.primitives.AtomicBoolean gotFinalState

Constructor Detail

ModelParameterServer

protected ModelParameterServer()

ModelParameterServer

protected ModelParameterServer(@NonNull
                               @NonNull Transport transport)

This constructor is for tests only

Parameters:

transport -

ModelParameterServer

protected ModelParameterServer(@NonNull
                               @NonNull Transport transport,
                               boolean isMasterNode)

This constructor is for tests only

Parameters:

transport -

isMasterNode -

ModelParameterServer

public ModelParameterServer(@NonNull
                            @NonNull VoidConfiguration configuration,
                            @NonNull
                            @NonNull Transport transport,
                            boolean isMasterNode)

This constructor creates new ModelParameterServer instance

Parameters:

configuration - VoidConfiguration bean

transport - Transport instance to be used for communications

isMasterNode - set to true if this parameter server instance will be a master node, false otherwise

Method Detail

getInstance

public static ModelParameterServer getInstance()

configure

public void configure(@NonNull
                      @NonNull VoidConfiguration configuration,
                      @NonNull
                      @NonNull Transport transport,
                      boolean isMasterNode)

This method stores provided entities for MPS internal use

Parameters:

configuration -

transport -

isMasterNode -

configure

public void configure(@NonNull
                      @NonNull VoidConfiguration configuration,
                      @NonNull
                      @NonNull Transport transport,
                      @NonNull
                      @NonNull UpdaterParametersProvider updaterProvider)

This method stores provided entities for MPS internal use

Parameters:

configuration -

transport -

isMasterNode -

addUpdatesSubscriber

public void addUpdatesSubscriber(@NonNull
                                 @NonNull UpdatesHandler s)

This method adds subcriber that will be called upon gradients update receival

Parameters:

s -

addModelParamsSubscriber

public void addModelParamsSubscriber(@NonNull
                                     @NonNull org.reactivestreams.Subscriber<org.nd4j.linalg.api.ndarray.INDArray> s)

This method adds subcriber that will be called upon model params receival

Parameters:

s -

addUpdaterParamsSubscriber

public void addUpdaterParamsSubscriber(@NonNull
                                       @NonNull org.reactivestreams.Subscriber<org.nd4j.linalg.api.ndarray.INDArray> s)

This method adds subcriber that will be called upon updater params receival

Parameters:

s -

isInitialized

public boolean isInitialized()

This method checks if ModelParameterServer was initialized

Returns:

true if already initalized, false otherwise

getStartPosition

public org.nd4j.common.primitives.Pair<Integer,Integer> getStartPosition()

This method returns pair of integers: iteration number and epoch number

Returns:

launch

public void launch()

This method starts parameter server

shutdown

public void shutdown()

This method stops parameter server

sendUpdate

public void sendUpdate(@NonNull
                       @NonNull org.nd4j.linalg.api.ndarray.INDArray array,
                       int iteration,
                       int epoch)

sendUpdate

public void sendUpdate(@NonNull
                       @NonNull org.nd4j.linalg.api.ndarray.INDArray array)

This method sends gradient updates to the cluster

getUpdates

public Collection<org.nd4j.linalg.api.ndarray.INDArray> getUpdates()

This method returns updates received from network

Returns: