Serialized Form (nd4j-parameter-server-node 1.0.0-M1.1 API)

Package org.nd4j.parameterserver.distributed.conf
- Class org.nd4j.parameterserver.distributed.conf.VoidConfiguration extends Object implements Serializable
  - Serialized Fields
    - streamId
```
int streamId
```
      StreamId is used for Aeron configuration
    - unicastControllerPort
```
int unicastControllerPort
```
      This variable defines UDP port that will be used for communication with cluster driver.
      NOTE: Use #setPortSupplier(PortSupplier) to set the port to use - the value of the unicastControllerPort field will automatically be updated to the value set by the PortSupplier provided on the master/controller machine, before communicating to the worker machines. Setting this field directly will NOT control the port that is used.
    - multicastPort
```
int multicastPort
```
      This method specifies UDP port for multicast/broadcast transport
    - numberOfShards
```
int numberOfShards
```
      This method defines number of shards. Reserved for future use.
    - faultToleranceStrategy
```
FaultToleranceStrategy faultToleranceStrategy
```
      Reserved for future use.
    - executionMode
```
ExecutionMode executionMode
```
      Reserved for future use.
    - shardAddresses
```
List<E> shardAddresses
```
      Reserved for future use.
    - backupAddresses
```
List<E> backupAddresses
```
      Reserved for future use.
    - transportType
```
TransportType transportType
```
      This variable defines network transport to be used for comms
    - meshBuildMode
```
MeshBuildMode meshBuildMode
```
      This variable defines how cluster nodes are organized
    - networkMask
```
String networkMask
```
      This variable acts as hint for ParameterServer about IP address to be used for comms. Used only if SPARK_PUBLIC_DNS is undefined (i.e. as in YARN environment)
    - multicastNetwork
```
String multicastNetwork
```
      This value is optional, and has effect only for UDP MulticastTransport
    - multicastInterface
```
String multicastInterface
```
      This value is optional, and has effect only for UDP MulticastTransport
    - ttl
```
int ttl
```
      This value is optional, and has effect only for UDP MulticastTransport
    - forcedRole
```
NodeRole forcedRole
```
      This option is for debugging mostly. Do not use it, unless you have to.
    - useHS
```
boolean useHS
```
      Deprecated.
      
      This value is optional, and has effect only for UDP MulticastTransport
    - useNS
```
boolean useNS
```
      Deprecated.
      
      This value is optional, and has effect only for UDP MulticastTransport
    - retransmitTimeout
```
long retransmitTimeout
```
      This variable defines, how long transport should wait before resending message in case of network issues. Measured in milliseconds.
    - responseTimeframe
```
long responseTimeframe
```
      This variable defines, how long transport should wait for response on specific messages.
    - responseTimeout
```
long responseTimeout
```
      This variable defines, how long transport should wait for answer on specific messages.
    - chunksBufferSize
```
long chunksBufferSize
```
      This variable defines amount of memory used of Default value: 1GB
    - maxChunkSize
```
int maxChunkSize
```
      This variable defines max chunk size for INDArray splits
    - maxFailuresPerNode
```
int maxFailuresPerNode
```
      This variable defines max number of allowed reconnects per node
    - controllerAddress
```
String controllerAddress
```
      This optional variable defines IP address of the box which acts as master for gradients training. Leave it null, and Spark Master node will be used as Master for parameter server as well.
    - portSupplier
```
PortSupplier portSupplier
```
      The port supplier used to provide the networking port to use for communication to/from the driver (UDP via Aeron). This setting can be used to control how ports get assigned (including port setting different ports on different machines).
      See PortSupplier for further details.
      Default: static port (i.e., StaticPortSupplier) with value VoidConfiguration.DEFAULT_AERON_UDP_PORT
Package org.nd4j.parameterserver.distributed.messages
- Class org.nd4j.parameterserver.distributed.messages.BaseVoidMessage extends Object implements Serializable
  - Serialized Fields
    - messageType
```
int messageType
```
      Deprecated.
    - originatorId
```
long originatorId
```
      Deprecated.
    - taskId
```
long taskId
```
      Deprecated.
    - targetId
```
short targetId
```
      Deprecated.
- Class org.nd4j.parameterserver.distributed.messages.Frame extends Object implements Serializable
  - Serialized Fields
    - list
```
List<E> list
```
      Deprecated.
    - originatorId
```
long originatorId
```
      Deprecated.
    - targetId
```
short targetId
```
      Deprecated.
    - taskId
```
long taskId
```
      Deprecated.
Package org.nd4j.parameterserver.distributed.messages.aggregations
- Class org.nd4j.parameterserver.distributed.messages.aggregations.BaseAggregation extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - aggregationType
```
short aggregationType
```
      Deprecated.
    - aggregationWidth
```
short aggregationWidth
```
      Deprecated.
    - numberOfElements
```
int numberOfElements
```
      Deprecated.
    - shardIndex
```
short shardIndex
```
      Deprecated.
    - payload
```
org.nd4j.linalg.api.ndarray.INDArray payload
```
      Deprecated.
- Class org.nd4j.parameterserver.distributed.messages.aggregations.DotAggregation extends BaseAggregation implements Serializable
- Class org.nd4j.parameterserver.distributed.messages.aggregations.InitializationAggregation extends BaseAggregation implements Serializable
- Class org.nd4j.parameterserver.distributed.messages.aggregations.VectorAggregation extends BaseAggregation implements Serializable
Package org.nd4j.parameterserver.distributed.messages.complete
- Class org.nd4j.parameterserver.distributed.messages.complete.BaseCompleteMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - payload
```
org.nd4j.linalg.api.ndarray.INDArray payload
```
      Deprecated.
- Class org.nd4j.parameterserver.distributed.messages.complete.FrameCompleteMessage extends BaseCompleteMessage implements Serializable
- Class org.nd4j.parameterserver.distributed.messages.complete.InitializationCompleteMessage extends BaseCompleteMessage implements Serializable
- Class org.nd4j.parameterserver.distributed.messages.complete.IntroductionCompleteMessage extends BaseCompleteMessage implements Serializable
- Class org.nd4j.parameterserver.distributed.messages.complete.VectorCompleteMessage extends BaseCompleteMessage implements Serializable
Package org.nd4j.parameterserver.distributed.messages.intercom
- Class org.nd4j.parameterserver.distributed.messages.intercom.DistributedAssignMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - index
```
int index
```
      Deprecated.
      
      The only use of this message is negTable sharing.
    - value
```
double value
```
      Deprecated.
    - key
```
Integer key
```
      Deprecated.
    - payload
```
org.nd4j.linalg.api.ndarray.INDArray payload
```
      Deprecated.
- Class org.nd4j.parameterserver.distributed.messages.intercom.DistributedCbowDotMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - rowsA
```
int[] rowsA
```
      Deprecated.
    - rowsB
```
int[] rowsB
```
      Deprecated.
    - w1
```
int w1
```
      Deprecated.
    - useHS
```
boolean useHS
```
      Deprecated.
    - negSamples
```
short negSamples
```
      Deprecated.
    - alpha
```
float alpha
```
      Deprecated.
    - codes
```
byte[] codes
```
      Deprecated.
- Class org.nd4j.parameterserver.distributed.messages.intercom.DistributedInitializationMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - vectorLength
```
int vectorLength
```
      Deprecated.
    - numWords
```
int numWords
```
      Deprecated.
    - seed
```
long seed
```
      Deprecated.
    - useHs
```
boolean useHs
```
      Deprecated.
    - useNeg
```
boolean useNeg
```
      Deprecated.
    - columnsPerShard
```
int columnsPerShard
```
      Deprecated.
- Class org.nd4j.parameterserver.distributed.messages.intercom.DistributedIntroductionMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - ip
```
String ip
```
      Deprecated.
    - port
```
int port
```
      Deprecated.
- Class org.nd4j.parameterserver.distributed.messages.intercom.DistributedSgDotMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - rowsA
```
int[] rowsA
```
      Deprecated.
    - rowsB
```
int[] rowsB
```
      Deprecated.
    - w1
```
int w1
```
      Deprecated.
    - w2
```
int w2
```
      Deprecated.
    - useHS
```
boolean useHS
```
      Deprecated.
    - negSamples
```
short negSamples
```
      Deprecated.
    - alpha
```
float alpha
```
      Deprecated.
    - codes
```
byte[] codes
```
      Deprecated.
- Class org.nd4j.parameterserver.distributed.messages.intercom.DistributedShutdownMessage extends BaseVoidMessage implements Serializable
- Class org.nd4j.parameterserver.distributed.messages.intercom.DistributedSkipGramMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - alpha
```
double alpha
```
      Deprecated.
    - w1
```
int w1
```
      Deprecated.
    - w2
```
int w2
```
      Deprecated.
    - points
```
int[] points
```
      Deprecated.
    - codes
```
byte[] codes
```
      Deprecated.
    - negSamples
```
short negSamples
```
      Deprecated.
    - nextRandom
```
long nextRandom
```
      Deprecated.
- Class org.nd4j.parameterserver.distributed.messages.intercom.DistributedSolidMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - key
```
Integer key
```
      Deprecated.
      
      The only use of this message is negTable sharing.
    - payload
```
org.nd4j.linalg.api.ndarray.INDArray payload
```
      Deprecated.
    - overwrite
```
boolean overwrite
```
      Deprecated.
- Class org.nd4j.parameterserver.distributed.messages.intercom.DistributedVectorMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - rowIndex
```
int rowIndex
```
      Deprecated.
    - key
```
int key
```
      Deprecated.
Package org.nd4j.parameterserver.distributed.messages.requests
- Class org.nd4j.parameterserver.distributed.messages.requests.AssignRequestMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - key
```
Integer key
```
      Deprecated.
    - rowIdx
```
int rowIdx
```
      Deprecated.
    - payload
```
org.nd4j.linalg.api.ndarray.INDArray payload
```
      Deprecated.
    - value
```
Number value
```
      Deprecated.
- Class org.nd4j.parameterserver.distributed.messages.requests.CbowRequestMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - counter
```
byte counter
```
      Deprecated.
    - frameId
```
long frameId
```
      Deprecated.
    - w1
```
int w1
```
      Deprecated.
    - syn0rows
```
int[] syn0rows
```
      Deprecated.
    - syn1rows
```
int[] syn1rows
```
      Deprecated.
    - alpha
```
double alpha
```
      Deprecated.
    - nextRandom
```
long nextRandom
```
      Deprecated.
    - negSamples
```
int negSamples
```
      Deprecated.
    - codes
```
byte[] codes
```
      Deprecated.
    - negatives
```
int[] negatives
```
      Deprecated.
- Class org.nd4j.parameterserver.distributed.messages.requests.InitializationRequestMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - vectorLength
```
int vectorLength
```
      Deprecated.
    - numWords
```
int numWords
```
      Deprecated.
    - seed
```
long seed
```
      Deprecated.
    - useHs
```
boolean useHs
```
      Deprecated.
    - useNeg
```
boolean useNeg
```
      Deprecated.
    - columnsPerShard
```
int columnsPerShard
```
      Deprecated.
- Class org.nd4j.parameterserver.distributed.messages.requests.IntroductionRequestMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - ip
```
String ip
```
      Deprecated.
    - port
```
int port
```
      Deprecated.
- Class org.nd4j.parameterserver.distributed.messages.requests.ShutdownRequestMessage extends BaseVoidMessage implements Serializable
- Class org.nd4j.parameterserver.distributed.messages.requests.SkipGramRequestMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - alpha
```
double alpha
```
      Deprecated.
    - frameId
```
long frameId
```
      Deprecated.
    - w1
```
int w1
```
      Deprecated.
    - w2
```
int w2
```
      Deprecated.
    - points
```
int[] points
```
      Deprecated.
    - codes
```
byte[] codes
```
      Deprecated.
    - negatives
```
int[] negatives
```
      Deprecated.
    - negSamples
```
short negSamples
```
      Deprecated.
    - nextRandom
```
long nextRandom
```
      Deprecated.
    - counter
```
byte counter
```
      Deprecated.
- Class org.nd4j.parameterserver.distributed.messages.requests.VectorRequestMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - key
```
Integer key
```
      Deprecated.
    - rowIndex
```
int rowIndex
```
      Deprecated.
Package org.nd4j.parameterserver.distributed.util
- Class org.nd4j.parameterserver.distributed.util.NetworkInformation extends Object implements Serializable
  - Serialized Fields
    - totalMemory
```
long totalMemory
```
    - availableMemory
```
long availableMemory
```
    - ipAddresses
```
List<E> ipAddresses
```
Package org.nd4j.parameterserver.distributed.v2.chunks
- Class org.nd4j.parameterserver.distributed.v2.chunks.VoidChunk extends Object implements Serializable
  - Serialized Fields
    - chunkId
```
int chunkId
```
      This field contains position of this chunk in merger
    - totalSize
```
long totalSize
```
      This field contains number of bytes of original message
    - messageId
```
String messageId
```
      Unique messageId used to distringuish chunks from each other
    - splitSize
```
int splitSize
```
      This field stores split size for original message
    - originalId
```
String originalId
```
      This field holds ID of the original message
    - originatorId
```
String originatorId
```
    - numberOfChunks
```
int numberOfChunks
```
      This field holds number of chunks for original message
    - payload
```
byte[] payload
```
      Actual chunk
Package org.nd4j.parameterserver.distributed.v2.messages
Package org.nd4j.parameterserver.distributed.v2.messages.impl
- Class org.nd4j.parameterserver.distributed.v2.messages.impl.GradientsUpdateMessage extends BaseINDArrayMessage implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - relayId
```
String relayId
```
    - iteration
```
int iteration
```
    - epoch
```
int epoch
```
- Class org.nd4j.parameterserver.distributed.v2.messages.impl.MeshUpdateMessage extends BaseVoidMessage implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - relayId
```
String relayId
```
    - mesh
```
MeshOrganizer mesh
```
Package org.nd4j.parameterserver.distributed.v2.messages.impl.base
- Class org.nd4j.parameterserver.distributed.v2.messages.impl.base.BaseINDArrayMessage extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - messageId
```
String messageId
```
    - originatorId
```
String originatorId
```
    - requestId
```
String requestId
```
    - payload
```
org.nd4j.linalg.api.ndarray.INDArray payload
```
- Class org.nd4j.parameterserver.distributed.v2.messages.impl.base.BaseRequestMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - requestId
```
String requestId
```
- Class org.nd4j.parameterserver.distributed.v2.messages.impl.base.BaseResponseMessage extends BaseVoidMessage implements Serializable
  - Serialized Fields
    - requestId
```
String requestId
```
- Class org.nd4j.parameterserver.distributed.v2.messages.impl.base.BaseVoidMessage extends Object implements Serializable
  - Serialized Fields
    - messageId
```
String messageId
```
      Unique messageId used to distringuish chunks from each other
    - originatorId
```
String originatorId
```
Package org.nd4j.parameterserver.distributed.v2.messages.pairs.handshake
- Class org.nd4j.parameterserver.distributed.v2.messages.pairs.handshake.HandshakeRequest extends BaseRequestMessage implements Serializable
- Class org.nd4j.parameterserver.distributed.v2.messages.pairs.handshake.HandshakeResponse extends BaseResponseMessage implements Serializable
  - Serialized Fields
    - sequenceId
```
long sequenceId
```
    - mesh
```
MeshOrganizer mesh
```
    - restart
```
boolean restart
```
      This method returns true if our node failed earlier, and should re-acquire model/updater/whatever params
    - dead
```
boolean dead
```
      This method returns true if our node failed too many times, so it'll just enable bypass for the rest of data
    - iteration
```
int iteration
```
    - epoch
```
int epoch
```
Package org.nd4j.parameterserver.distributed.v2.messages.pairs.params
- Class org.nd4j.parameterserver.distributed.v2.messages.pairs.params.ModelParametersMessage extends BaseINDArrayMessage implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - iterationNumber
```
int iterationNumber
```
    - epochNumber
```
int epochNumber
```
- Class org.nd4j.parameterserver.distributed.v2.messages.pairs.params.ModelParametersRequest extends BaseRequestMessage implements Serializable
- Class org.nd4j.parameterserver.distributed.v2.messages.pairs.params.UpdaterParametersMessage extends BaseINDArrayMessage implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - finalState
```
boolean finalState
```
- Class org.nd4j.parameterserver.distributed.v2.messages.pairs.params.UpdaterParametersRequest extends BaseRequestMessage implements Serializable
Package org.nd4j.parameterserver.distributed.v2.messages.pairs.ping
- Class org.nd4j.parameterserver.distributed.v2.messages.pairs.ping.PingMessage extends BaseRequestMessage implements Serializable
- Class org.nd4j.parameterserver.distributed.v2.messages.pairs.ping.PongMessage extends BaseResponseMessage implements Serializable
Package org.nd4j.parameterserver.distributed.v2.transport
Package org.nd4j.parameterserver.distributed.v2.transport.impl
- Class org.nd4j.parameterserver.distributed.v2.transport.impl.EnvironmentVarPortSupplier extends Object implements Serializable
  - Serialized Fields
    - port
```
int port
```
    - variableName
```
String variableName
```
- Class org.nd4j.parameterserver.distributed.v2.transport.impl.StaticPortSupplier extends Object implements Serializable
  - Serialized Fields
    - port
```
int port
```
Package org.nd4j.parameterserver.distributed.v2.util
- Class org.nd4j.parameterserver.distributed.v2.util.MeshOrganizer extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialization Methods
    - readObject
```
private void readObject(ObjectInputStream ois)
                 throws ClassNotFoundException,
                        IOException
```
      Throws:
      
      ClassNotFoundException
      
      IOException
  - Serialized Fields
    - buildMode
```
MeshBuildMode buildMode
```
    - rootNode
```
MeshOrganizer.Node rootNode
```
    - version
```
long version
```
- Class org.nd4j.parameterserver.distributed.v2.util.MeshOrganizer.Node extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - rootNode
```
boolean rootNode
```
    - id
```
String id
```
    - port
```
int port
```
    - upstream
```
MeshOrganizer.Node upstream
```
    - downstream
```
List<E> downstream
```
    - position
```
AtomicInteger position
```
    - status
```
org.nd4j.common.primitives.Atomic<T extends Serializable> status
```
- Class org.nd4j.parameterserver.distributed.v2.util.UpdaterParametersHolder extends Object implements Serializable
  - Serialized Fields
    - parameters
```
org.nd4j.linalg.api.ndarray.INDArray parameters
```
    - timeReceived
```
long timeReceived
```
    - finalState
```
boolean finalState
```

Serialized Form

Package org.nd4j.parameterserver.distributed.conf

Class org.nd4j.parameterserver.distributed.conf.VoidConfiguration extends Object implements Serializable

Serialized Fields

streamId

unicastControllerPort

multicastPort

numberOfShards

faultToleranceStrategy

executionMode

shardAddresses

backupAddresses

transportType

meshBuildMode

networkMask

multicastNetwork

multicastInterface

ttl

forcedRole

useHS

useNS

retransmitTimeout

responseTimeframe

responseTimeout

chunksBufferSize

maxChunkSize

maxFailuresPerNode

controllerAddress

portSupplier

Package org.nd4j.parameterserver.distributed.messages

Class org.nd4j.parameterserver.distributed.messages.BaseVoidMessage extends Object implements Serializable

Serialized Fields

messageType

originatorId

taskId

targetId

Class org.nd4j.parameterserver.distributed.messages.Frame extends Object implements Serializable

Serialized Fields

list

originatorId

targetId

taskId

Package org.nd4j.parameterserver.distributed.messages.aggregations

Class org.nd4j.parameterserver.distributed.messages.aggregations.BaseAggregation extends BaseVoidMessage implements Serializable

Serialized Fields

aggregationType

aggregationWidth

numberOfElements

shardIndex

payload

Class org.nd4j.parameterserver.distributed.messages.aggregations.DotAggregation extends BaseAggregation implements Serializable

Class org.nd4j.parameterserver.distributed.messages.aggregations.InitializationAggregation extends BaseAggregation implements Serializable

Class org.nd4j.parameterserver.distributed.messages.aggregations.VectorAggregation extends BaseAggregation implements Serializable

Package org.nd4j.parameterserver.distributed.messages.complete

Class org.nd4j.parameterserver.distributed.messages.complete.BaseCompleteMessage extends BaseVoidMessage implements Serializable

Serialized Fields

payload

Class org.nd4j.parameterserver.distributed.messages.complete.FrameCompleteMessage extends BaseCompleteMessage implements Serializable

Class org.nd4j.parameterserver.distributed.messages.complete.InitializationCompleteMessage extends BaseCompleteMessage implements Serializable

Class org.nd4j.parameterserver.distributed.messages.complete.IntroductionCompleteMessage extends BaseCompleteMessage implements Serializable

Class org.nd4j.parameterserver.distributed.messages.complete.VectorCompleteMessage extends BaseCompleteMessage implements Serializable

Package org.nd4j.parameterserver.distributed.messages.intercom

Class org.nd4j.parameterserver.distributed.messages.intercom.DistributedAssignMessage extends BaseVoidMessage implements Serializable

Serialized Fields

index

value

key

payload

Class org.nd4j.parameterserver.distributed.messages.intercom.DistributedCbowDotMessage extends BaseVoidMessage implements Serializable

Serialized Fields

rowsA

rowsB

w1

useHS

negSamples

alpha

codes

Class org.nd4j.parameterserver.distributed.messages.intercom.DistributedInitializationMessage extends BaseVoidMessage implements Serializable

Serialized Fields

vectorLength