Documentation

You can find the JSDoc Documentation here

class AvoNet

• Author: AvoLord
• Version: 0.1

Classes

AvoNet

Creates a new NeuronalNetwork-object with a given node-configuration

Members

ConstructionError

Sets the Error-messages

Functions

sigmoid(x) ⇒ Number

The sigmoid function

dsigmoid(x) ⇒ Number

The derivative of the sigmoid function

logit(x) ⇒ Number

The invers-sigmoid function or logit function

simple(x) ⇒ Number

A simple function that either returns 0 or 1

AvoNet

Creates a new NeuronalNetwork-object with a given node-configuration

Kind: global class

• AvoNet
  • new AvoNet(layer_configuration, input)
  • .initConfig(conf)
  • .initNodes()
  • .initWeights(input)
  • .initBias(input)
  • .download()
  • .clone() ⇒ AvoNet
  • .error(input, real) ⇒ Number
  • .guess(input) ⇒ Array
  • .think(output) ⇒ Array
  • .train(input, input)

new AvoNet(layer_configuration, input)

Param	Type	Description
layer_configuration	Array	A node-configuration that specifies the amount of input,hidden and output nodes
layer_configuration	AvoNet	Another NeuronalNetwork that will be copied
input	Number	A custom value for the weights [random if left empty]

.initConfig(conf)

Initializes the node-configuration

Kind: instance method of AvoNet

Param	Type	Description
conf	Array	The layer_configuration from the constructor

.initNodes()

Initializes the node-configuration [as an Array]

Kind: instance method of AvoNet

.initWeights(input)

Initializes the weights

Kind: instance method of AvoNet

Param	Type	Description
input	Number	A possible value for the weights [random if empty]

.initBias(input)

Initializes the bias

Kind: instance method of AvoNet

Param	Type	Description
input	Number	A possible value for the bias [random if empty]

.download()

Allows the User to download the Network

Kind: instance method of AvoNet

.clone()

Allows the User to clone the Network

Kind: instance method of AvoNet

.error(input, real) ⇒ Number

Determines the error given that Network produces

Kind: instance method of AvoNet Returns: Number - - The error-value

Param	Type	Description
input	Array	An Input Array [Input Vector]
real	Array	The Real-values [Solution Vector]

.guess(input) ⇒ Array

Returns a guess corresponding to a given Input

Kind: instance method of AvoNet Returns: Array - - An Output Array [Output Vector]

Param	Type	Description
input	Array	An Input Array [Input Vector]

.think(output) ⇒ Array

-----------------------[W I P]-------------------------

Kind: instance method of AvoNet Returns: Array - - An Input Array [Input Vector]

Param	Type	Description
output	Array	An Output Array [Output Vector]

.train(input, input)

Trains the Network corresponding to its error

Kind: instance method of AvoNet

Param	Type	Description
input	Array	An Input Array [Input Vector]
input	Array	An Real Array [Solution Vector]

ConstructionError

Sets the Error-messages

Kind: global variable

sigmoid(x) ⇒ Number

The sigmoid function

Kind: global function Returns: Number - - The corresponding y-value

Param	Type	Description
x	Number	The input

dsigmoid(x) ⇒ Number

The derivative of the sigmoid function

Kind: global function Returns: Number - - The corresponding y-value

Param	Type	Description
x	Number	The input

logit(x) ⇒ Number

The invers-sigmoid function or logit function

Kind: global function Returns: Number - - The corresponding y-value

Param	Type	Description
x	Number	The input

simple(x) ⇒ Number

A simple function that either returns 0 or 1

Kind: global function Returns: Number - - The corresponding y-value

Param	Type	Description
x	Number	The input