ml.shifu.guagua.example.nn.meta

Class NNParams

java.lang.Object

ml.shifu.guagua.io.HaltBytable

ml.shifu.guagua.example.nn.meta.NNParams

All Implemented Interfaces:

ml.shifu.guagua.io.Bytable

public class NNParams
extends ml.shifu.guagua.io.HaltBytable

NNParams are used to save NN model info which can also be stored into ZooKeeper.

weights is used to set model weights which is used to transfer info from master to workers.

gradients is used to accumulate all workers' gradients together in master and then use the accumulated gradients to update neural network weights.

Constructor Summary

Constructors

Constructor and Description
NNParams()

Method Summary

Modifier and Type	Method and Description
void	accumulateGradients(double[] gradients)
void	accumulateTrainSize(long size)
void	doReadFields(DataInput in)
void	doWrite(DataOutput out)
double[]	getGradients()
double	getTestError()
double	getTrainError()
long	getTrainSize()
double[]	getWeights()
void	reset()
void	setGradients(double[] gradients)
void	setTestError(double testError)
void	setTrainError(double trainError)
void	setTrainSize(long trainSize)
void	setWeights(double[] weights)
String	toString()

Methods inherited from class ml.shifu.guagua.io.HaltBytable

isHalt, readFields, setHalt, write

Methods inherited from class java.lang.Object

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

Constructor Detail

NNParams

public NNParams()

Method Detail

getWeights

public double[] getWeights()

setWeights

public void setWeights(double[] weights)

getTestError

public double getTestError()

setTestError

public void setTestError(double testError)

getTrainError

public double getTrainError()

setTrainError

public void setTrainError(double trainError)

accumulateGradients

public void accumulateGradients(double[] gradients)

getGradients

public double[] getGradients()

Returns:

the gradients

setGradients

public void setGradients(double[] gradients)

Parameters:

gradients - the gradients to set

getTrainSize

public long getTrainSize()

setTrainSize

public void setTrainSize(long trainSize)

accumulateTrainSize

public void accumulateTrainSize(long size)

reset

public void reset()

doWrite

public void doWrite(DataOutput out)
             throws IOException

Specified by:

doWrite in class ml.shifu.guagua.io.HaltBytable

Throws:

IOException

doReadFields

public void doReadFields(DataInput in)
                  throws IOException

Specified by:

doReadFields in class ml.shifu.guagua.io.HaltBytable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object