nuroko.module

Class Stack

java.lang.Object

nuroko.module.AComponent

nuroko.module.ACompoundComponent

nuroko.module.Stack

All Implemented Interfaces:

Cloneable, Iterable<IComponent>, IComponent, IFunction<mikera.vectorz.AVector,mikera.vectorz.AVector>, IInput, IInputOutput, IInputState, IModule, IOutput, IOutputState, IParameterised, ISynthesiser, IThinker, ITrainable

public class Stack
extends ACompoundComponent

A stack of connected components, with the output of each feeding into the input of the next

Author:

Mike

Field Summary

Fields inherited from class nuroko.module.ACompoundComponent

componentCount, components, gradient, parameters

Constructor Summary

Constructors

Constructor and Description
Stack(List<? extends IComponent> comps)

Method Summary

Modifier and Type	Method and Description
Stack	clone() Creates a clone of a module, including a deep copy of any mutable state.
void	generate(mikera.vectorz.AVector input, mikera.vectorz.AVector output)
LossFunction	getDefaultLossFunction() Returns the default loss function that should be used
mikera.vectorz.AVector	getInput()
mikera.vectorz.AVector	getInputGradient()
int	getInputLength()
IInputState	getInputState()
mikera.vectorz.AVector	getOutput()
mikera.vectorz.AVector	getOutputGradient()
void	setInput(mikera.vectorz.AVector input)
void	thinkInternal() Thinks within the scope of the component.
void	thinkInternalTraining() Thinks within the scope of the component.
IComponent	topComponent()
void	trainGradientInternal(double factor) Abstract method for training gradients.

Methods inherited from class nuroko.module.ACompoundComponent

getComponent, getComponents, getGradient, getParameterLength, getParameters, hasDifferentTrainingThinking

Methods inherited from class nuroko.module.AComponent

applyConstraints, applyConstraintsInternal, generate, getConstraints, getDownStack, getLearnFactor, getModules, getOutputLength, getUpStack, initRandom, isStochastic, isSynthesiser, iterator, setConstraint, setLearnFactor, setOutput, think, think, train, train, trainSynth, trainSynth

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Stack

public Stack(List<? extends IComponent> comps)

Method Detail

topComponent

public IComponent topComponent()

Overrides:

topComponent in class AComponent

getDefaultLossFunction

public LossFunction getDefaultLossFunction()

Description copied from interface: IComponent

Returns the default loss function that should be used

Specified by:

getDefaultLossFunction in interface IComponent

Overrides:

getDefaultLossFunction in class AComponent

Returns:

getInput

public mikera.vectorz.AVector getInput()

getInputGradient

public mikera.vectorz.AVector getInputGradient()

getInputLength

public int getInputLength()

Specified by:

getInputLength in interface IInput

Overrides:

getInputLength in class AComponent

thinkInternal

public void thinkInternal()

Description copied from interface: IComponent

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

thinkInternalTraining

public void thinkInternalTraining()

Description copied from interface: IComponent

Thinks within the scope of the component. Update's component's output. May be different from regular thinking.

Specified by:

thinkInternalTraining in interface IComponent

Specified by:

thinkInternalTraining in interface ITrainable

Overrides:

thinkInternalTraining in class AComponent

generate

public void generate(mikera.vectorz.AVector input,
                     mikera.vectorz.AVector output)

Specified by:

generate in interface ISynthesiser

Overrides:

generate in class AComponent

clone

public Stack 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 ISynthesiser

Specified by:

clone in interface IThinker

Specified by:

clone in interface ITrainable

Overrides:

clone in class AComponent

Returns:

setInput

public void setInput(mikera.vectorz.AVector input)

Specified by:

setInput in interface IInputState

Overrides:

setInput in class AComponent

getInputState

public IInputState getInputState()

Specified by:

getInputState in interface IComponent

Overrides:

getInputState in class AComponent

trainGradientInternal

public void trainGradientInternal(double factor)

Description copied from class: AComponent

Abstract method for training gradients. Assumes use of the current activation states for all inputs/outputs. Should overwrite inputGradient, and adjust gradient for all parameters. Should apply own internal learn rate factor

Specified by:

trainGradientInternal in interface IComponent

Specified by:

trainGradientInternal in class AComponent

getOutput

public mikera.vectorz.AVector getOutput()

getOutputGradient

public mikera.vectorz.AVector getOutputGradient()