Class ANN_Network

Description
  • access: public

Located in /Network.php (line 51)

ANN_Filesystem
   |
   --ANN_Network
Class Constant Summary
Method Summary
[744]   protected   static   string :  getDefaultFilename ()
[1091]   public   static   void :  loadFromFile ([string $strFilename = null])
[1337]   public   static   ANN_Network :  loadFromHost (string $strUsername, string $strPassword, string $strHost)
[227]   public   ANN_Network :  __construct ([integer $intNumberOfHiddenLayers = 1], [integer $intNumberOfNeuronsPerLayer = 6], [integer $intNumberOfOutputs = 1])
[443]   protected   void :  activate ()
[407]   protected   void :  createHiddenLayers (integer $intNumberOfHiddenLayers, integer $intNumberOfNeuronsPerLayer)
[432]   protected   void :  createOutputLayer (integer $intNumberOfOutputs)
[1367]   protected   void :  detectOutputType ()
[704]   protected   integer :  getCountInputs ()
[1255]   protected   float :  getNetworkError ()
[552]   protected   integer :  getNextIndexInputsToTrain ([boolean $boolReset = FALSE])
[1130]   public   integer :  getNumberHiddenLayers ()
[1142]   public   integer :  getNumberHiddens ()
[1117]   public   integer :  getNumberInputs ()
[1155]   public   integer :  getNumberOutputs ()
[349]   public   array :  getOutputs ()
[385]   public   array :  getOutputsByInputKey (integer $intKeyInput)
[783]   protected   string :  getPrintNetwork ([integer $intLevel = 2])
[854]   protected   string :  getPrintNetworkDetails1 ()
[971]   protected   string :  getPrintNetworkDetails2 ()
[579]   public   integer :  getTotalLoops ()
[542]   protected   boolean :  hasTimeLeftForTraining ()
[588]   protected   boolean :  isEpoch ()
[628]   protected   boolean :  isTrainingComplete ()
[658]   protected   boolean :  isTrainingCompleteByEpoch ()
[673]   protected   boolean :  isTrainingCompleteByInputKey (integer $intKeyInput)
[1239]   protected   void :  logNetworkErrors ()
[1188]   public   void :  logNetworkErrorsToFile (string $strFilename)
[1204]   protected   void :  logWeights ()
[1171]   public   void :  logWeightsToFile (string $strFilename)
[1420]   public   void :  printNetwork ([integer $intLevel = 2])
[1105]   public   void :  saveToFile ([string $strFilename = null])
[1309]   public   void :  saveToHost (string $strUsername, string $strPassword, string $strHost)
[255]   protected   void :  setInputs (array $arrInputs)
[328]   protected   void :  setInputsToTrain (array $arrInputs)
[612]   public   void :  setLearningRate ([float $floatLearningRate = 0.7])
[1066]   protected   void :  setMaxExecutionTime ()
[1404]   public   void :  setMomentum ([float $floatMomentum = 0.95])
[1390]   public   void :  setOutputErrorTolerance ([float $floatOutputErrorTolerance = 0.02])
[277]   protected   void :  setOutputs (array $arrOutputs)
[755]   protected   void :  setOutputType ([integer $intType = self::OUTPUT_LINEAR])
[316]   public   void :  setValues (ANN_Values $objValues)
[475]   public   boolean :  train ()
[1276]   public   ANN_Network :  trainByHost (string $strUsername, string $strPassword, string $strHost)
[721]   protected   void :  training (array $arrOutputs)
[1430]   public   void :  __invoke ([integer $intLevel = 2])
[1440]   public   string :  __toString ()
[1078]   public   void :  __wakeup ()
Methods
protected static string getDefaultFilename () [744]
  • return: Filename
  • access: protected
public static void loadFromFile ([string $strFilename = null]) [1091]
  • string $strFilename: (Default: null)

Redefinition of:
ANN_Filesystem::loadFromFile()
public static ANN_Network loadFromHost (string $strUsername, string $strPassword, string $strHost) [1337]
  • throws: ANN_Exception
  • access: public
  • string $strUsername
  • string $strPassword
  • string $strHost
public  ANN_Network __construct ([integer $intNumberOfHiddenLayers = 1], [integer $intNumberOfNeuronsPerLayer = 6], [integer $intNumberOfOutputs = 1]) [227]
  • integer $intNumberOfHiddenLayers: (Default: 1)
  • integer $intNumberOfNeuronsPerLayer: (Default: 6)
  • integer $intNumberOfOutputs: (Default: 1)
protected  void activate () [443]
protected  void createHiddenLayers (integer $intNumberOfHiddenLayers, integer $intNumberOfNeuronsPerLayer) [407]
  • integer $intNumberOfHiddenLayers
  • integer $intNumberOfNeuronsPerLayer
protected  void createOutputLayer (integer $intNumberOfOutputs) [432]
  • integer $intNumberOfOutputs
protected  void detectOutputType () [1367]
protected  integer getCountInputs () [704]
protected  float getNetworkError () [1255]
protected  integer getNextIndexInputsToTrain ([boolean $boolReset = FALSE]) [552]
  • boolean $boolReset: (Default: FALSE)
public  integer getNumberHiddenLayers () [1130]
public  integer getNumberHiddens () [1142]
public  integer getNumberInputs () [1117]
public  integer getNumberOutputs () [1155]
public  array getOutputs () [349]

Get the output values

Get the output values to the related input values set by setValues(). This method returns the output values as a two-dimensional array.

public  array getOutputsByInputKey (integer $intKeyInput) [385]
  • integer $intKeyInput
protected  string getPrintNetwork ([integer $intLevel = 2]) [783]
  • integer $intLevel: (0, 1, 2) (Default: 2)
protected  string getPrintNetworkDetails1 () [854]
protected  string getPrintNetworkDetails2 () [971]
public  integer getTotalLoops () [579]
  • access: public
protected  boolean hasTimeLeftForTraining () [542]
protected  boolean isEpoch () [588]
protected  boolean isTrainingComplete () [628]
protected  boolean isTrainingCompleteByEpoch () [658]
protected  boolean isTrainingCompleteByInputKey (integer $intKeyInput) [673]
  • integer $intKeyInput
protected  void logNetworkErrors () [1239]
public  void logNetworkErrorsToFile (string $strFilename) [1188]

Log network errors while training in CSV format

  • string $strFilename
protected  void logWeights () [1204]
public  void logWeightsToFile (string $strFilename) [1171]

Log weights while training in CSV format

  • string $strFilename
public  void printNetwork ([integer $intLevel = 2]) [1420]
  • integer $intLevel: (Default: 2)
public  void saveToFile ([string $strFilename = null]) [1105]
  • string $strFilename: (Default: null)

Redefinition of:
ANN_Filesystem::saveToFile()
public  void saveToHost (string $strUsername, string $strPassword, string $strHost) [1309]
  • throws: ANN_Exception
  • access: public
  • string $strUsername
  • string $strPassword
  • string $strHost
protected  void setInputs (array $arrInputs) [255]
  • array $arrInputs
protected  void setInputsToTrain (array $arrInputs) [328]
  • array $arrInputs
public  void setLearningRate ([float $floatLearningRate = 0.7]) [612]

Setting the learning rate

  • throws: ANN_Exception
  • access: public
  • uses: ANN_Exception::__construct()
  • float $floatLearningRate: (Default: 0.7) (0.1 .. 0.9)
protected  void setMaxExecutionTime () [1066]
public  void setMomentum ([float $floatMomentum = 0.95]) [1404]
  • throws: ANN_Exception
  • access: public
  • uses: ANN_Exception::__construct()
  • float $floatMomentum: (Default: 0.95) (0 .. 1)
public  void setOutputErrorTolerance ([float $floatOutputErrorTolerance = 0.02]) [1390]

Setting the percentage of output error in comparison to the desired output

  • access: public
  • float $floatOutputErrorTolerance: (Default: 0.02)
protected  void setOutputs (array $arrOutputs) [277]
  • array $arrOutputs
protected  void setOutputType ([integer $intType = self::OUTPUT_LINEAR]) [755]
  • integer $intType: (Default: ANN_Network::OUTPUT_LINEAR)
public  void setValues (ANN_Values $objValues) [316]

Set Values for training or using network

Set Values of inputs and outputs for training or just inputs for using already trained network.

  1.  $objNetwork new ANN_Network(241);
  2.  
  3.  $objValues new ANN_Values;
  4.  
  5.  $objValues->train()
  6.            ->input(0.120.110.15)
  7.            ->output(0.56);
  8.  
  9.  $objNetwork->setValues($objValues);

public  ANN_Network trainByHost (string $strUsername, string $strPassword, string $strHost) [1276]
  • throws: ANN_Exception
  • access: public
  • string $strUsername
  • string $strPassword
  • string $strHost
protected  void training (array $arrOutputs) [721]
  • array $arrOutputs
public  void __invoke ([integer $intLevel = 2]) [1430]
  • integer $intLevel: (Default: 2)
public  string __toString () [1440]
public  void __wakeup () [1078]

Inherited Methods

Inherited From ANN_Filesystem

ANN_Filesystem::loadFromFile()
ANN_Filesystem::saveToFile()
Class Constants
OUTPUT_BINARY = 2 (line 214)

Binary output type

OUTPUT_LINEAR = 1 (line 208)

Linear output type

Documentation generated on Wed, 15 Jun 2011 08:57:50 +0200 by phpDocumentor 1.4.1