nuroko.module

Class NeuralNet

java.lang.Object

nuroko.module.AComponent

nuroko.module.ALayerStack

nuroko.module.NeuralNet

All Implemented Interfaces:

Cloneable, IComponent, IGradientTrainable, IInput, IInputOutput, IInputState, IModule, IOutput, IOutputState, IParameterised, IThinker, ITrainable

public class NeuralNet
extends ALayerStack

Constructor Summary

Constructors

Constructor and Description
NeuralNet(AWeightLayer... layers)
NeuralNet(AWeightLayer[] layers, mikera.vectorz.Op outputOp)
NeuralNet(AWeightLayer[] layers, mikera.vectorz.Op hiddenOp, mikera.vectorz.Op outputOp)

Method Summary

Methods

Modifier and Type	Method and Description
NeuralNet	clone() Creates a clone of a module, including a deep copy of any mutable state.
List<IComponent>	getComponents()
mikera.vectorz.AVector	getData(int i)
mikera.vectorz.AVector	getGradient() Return an AVector referencing the accumulated gradient in this model
mikera.vectorz.AVector	getInput()
mikera.vectorz.AVector	getInputGradient()
int	getInputLength()
NeuralNet	getInverse()
AWeightLayer	getLayer(int i)
int	getLayerCount()
mikera.vectorz.Op	getLayerOp(int i)
List<AWeightLayer>	getLayers()
List<IModule>	getModules() Returns a list of sub-components of this module
mikera.vectorz.AVector	getOutput()
mikera.vectorz.AVector	getOutputGradient()
int	getOutputLength()
int	getParameterLength() Returns the length of the parameter vector for this model
mikera.vectorz.AVector	getParameters() Return an AVector referring to the parameters in the model.
void	initRandom()
void	thinkInternal() Thinks within the scope of the component.
void	train(mikera.vectorz.AVector input, mikera.vectorz.AVector target)
void	trainGradient(mikera.vectorz.AVector input, mikera.vectorz.AVector outputGradient, mikera.vectorz.AVector inputGradient, double factor, boolean skipTopDerivative) Trains with a direct gradient.
void	trainGradient(mikera.vectorz.AVector gradient, double factor) Trains with a output gradient, incrementing inputGradient and accumulated gradient for parameters.
void	trainGradientInternal(double factor)

Methods inherited from class nuroko.module.AComponent

getComponent, getInputState, isStochastic, setInput, setOutput, think, think, thinkInternalTraining, topComponent, train

Methods inherited from class java.lang.Object

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

Constructor Detail

NeuralNet

public NeuralNet(AWeightLayer... layers)

NeuralNet

public NeuralNet(AWeightLayer[] layers,
         mikera.vectorz.Op outputOp)

NeuralNet

public NeuralNet(AWeightLayer[] layers,
         mikera.vectorz.Op hiddenOp,
         mikera.vectorz.Op outputOp)

Method Detail

getModules

public List<IModule> getModules()

Description copied from interface: IModule

Returns a list of sub-components of this module

Specified by:

getModules in interface IModule

Overrides:

getModules in class AComponent

Returns:

getComponents

public List<IComponent> getComponents()

getInverse

public NeuralNet getInverse()

initRandom

public void initRandom()

train

public void train(mikera.vectorz.AVector input,
         mikera.vectorz.AVector target)

Specified by:

train in interface ITrainable

Specified by:

train in class ALayerStack

trainGradient

public void trainGradient(mikera.vectorz.AVector input,
                 mikera.vectorz.AVector outputGradient,
                 mikera.vectorz.AVector inputGradient,
                 double factor,
                 boolean skipTopDerivative)

Description copied from class: ALayerStack

Trains with a direct gradient. Assumes think has been called immediately prior to set any intermediate values.

Specified by:

trainGradient in class ALayerStack

trainGradientInternal

public void trainGradientInternal(double factor)

trainGradient

public void trainGradient(mikera.vectorz.AVector gradient,
                 double factor)

Description copied from interface: IGradientTrainable

Trains with a output gradient, incrementing inputGradient and accumulated gradient for parameters.

factor - TODO

getLayerOp

public mikera.vectorz.Op getLayerOp(int i)

thinkInternal

public void thinkInternal()

Description copied from interface: IComponent

Thinks within the scope of the component. Updates component's output.

getLayer

public AWeightLayer getLayer(int i)

Specified by:

getLayer in class ALayerStack

getInputLength

public int getInputLength()

Specified by:

getInputLength in interface IInput

Overrides:

getInputLength in class AComponent

getOutputLength

public int getOutputLength()

Specified by:

getOutputLength in interface IOutput

Overrides:

getOutputLength in class AComponent

getParameterLength

public int getParameterLength()

Description copied from interface: IParameterised

Returns the length of the parameter vector for this model

Specified by:

getParameterLength in interface IParameterised

Overrides:

getParameterLength in class AComponent

Returns:

getParameters

public mikera.vectorz.AVector getParameters()

Description copied from interface: IParameterised

Return an AVector referring to the parameters in the model. Expected to be mutable.

Returns:

getGradient

public mikera.vectorz.AVector getGradient()

Description copied from interface: IParameterised

Return an AVector referencing the accumulated gradient in this model

Returns:

getLayers

public List<AWeightLayer> getLayers()

Overrides:

getLayers in class ALayerStack

getOutput

public mikera.vectorz.AVector getOutput()

Specified by:

getOutput in interface IOutputState

Overrides:

getOutput in class ALayerStack

getInput

public mikera.vectorz.AVector getInput()

Specified by:

getInput in interface IInputState

Overrides:

getInput in class ALayerStack

getData

public mikera.vectorz.AVector getData(int i)

Specified by:

getData in class ALayerStack

clone

public NeuralNet clone()

Description copied from interface: IModule

Creates a clone of a module, including a deep copy of any mutable state.

Specified by:

clone in interface IComponent

Specified by:

clone in interface IModule

Specified by:

clone in interface IParameterised

Specified by:

clone in interface IThinker

Specified by:

clone in interface ITrainable

Specified by:

clone in class ALayerStack

Returns:

getLayerCount

public int getLayerCount()

Specified by:

getLayerCount in class ALayerStack

getInputGradient

public mikera.vectorz.AVector getInputGradient()

getOutputGradient

public mikera.vectorz.AVector getOutputGradient()