Class Network

Description
  • access: public

Located in /Network.php (line 60)

Filesystem
   |
   --Network
Class Constant Summary
Method Summary
[756]   protected   static   string :  getDefaultFilename ()
[1103]   public   static   void :  loadFromFile ([string $strFilename = null])
[1349]   public   static   Network :  loadFromHost (string $strUsername, string $strPassword, string $strHost)
[236]   public   Network :  __construct ([integer $intNumberOfHiddenLayers = 1], [integer $intNumberOfNeuronsPerLayer = 6], [integer $intNumberOfOutputs = 1])
[452]   protected   void :  activate ()
[416]   protected   void :  createHiddenLayers (integer $intNumberOfHiddenLayers, integer $intNumberOfNeuronsPerLayer)
[441]   protected   void :  createOutputLayer (integer $intNumberOfOutputs)
[1379]   protected   void :  detectOutputType ()
[716]   protected   integer :  getCountInputs ()
[1267]   protected   float :  getNetworkError ()
[564]   protected   integer :  getNextIndexInputsToTrain ([boolean $boolReset = FALSE])
[1142]   public   integer :  getNumberHiddenLayers ()
[1154]   public   integer :  getNumberHiddens ()
[1129]   public   integer :  getNumberInputs ()
[1167]   public   integer :  getNumberOutputs ()
[358]   public   array :  getOutputs ()
[394]   public   array :  getOutputsByInputKey (integer $intKeyInput)
[795]   protected   string :  getPrintNetwork ([integer $intLevel = 2])
[866]   protected   string :  getPrintNetworkDetails1 ()
[983]   protected   string :  getPrintNetworkDetails2 ()
[591]   public   integer :  getTotalLoops ()
[554]   protected   boolean :  hasTimeLeftForTraining ()
[600]   protected   boolean :  isEpoch ()
[640]   protected   boolean :  isTrainingComplete ()
[670]   protected   boolean :  isTrainingCompleteByEpoch ()
[685]   protected   boolean :  isTrainingCompleteByInputKey (integer $intKeyInput)
[1251]   protected   void :  logNetworkErrors ()
[1200]   public   void :  logNetworkErrorsToFile (string $strFilename)
[1216]   protected   void :  logWeights ()
[1183]   public   void :  logWeightsToFile (string $strFilename)
[1436]   public   void :  printNetwork ([integer $intLevel = 2])
[1117]   public   void :  saveToFile ([string $strFilename = null])
[1321]   public   void :  saveToHost (string $strUsername, string $strPassword, string $strHost)
[1471]   protected   float :  setDynamicLearningRate (integer $intLoop)
[264]   protected   void :  setInputs (array $arrInputs)
[337]   protected   void :  setInputsToTrain (array $arrInputs)
[624]   protected   void :  setLearningRate ([float $floatLearningRate = 0.7])
[1078]   protected   void :  setMaxExecutionTime ()
[1420]   public   void :  setMomentum ([float $floatMomentum = 0.95])
[1406]   public   void :  setOutputErrorTolerance ([float $floatOutputErrorTolerance = 0.02])
[286]   protected   void :  setOutputs (array $arrOutputs)
[767]   protected   void :  setOutputType ([integer $intType = self::OUTPUT_LINEAR])
[325]   public   void :  setValues (Values $objValues)
[485]   public   boolean :  train ()
[1288]   public   Network :  trainByHost (string $strUsername, string $strPassword, string $strHost)
[733]   protected   void :  training (array $arrOutputs)
[1446]   public   void :  __invoke ([integer $intLevel = 2])
[1456]   public   string :  __toString ()
[1090]   public   void :  __wakeup ()
Methods
protected static string getDefaultFilename () [756]
public static void loadFromFile ([string $strFilename = null]) [1103]
  • string $strFilename: (Default: null)

Redefinition of:
Filesystem::loadFromFile()
public static Network loadFromHost (string $strUsername, string $strPassword, string $strHost) [1349]
  • throws: Exception
  • access: public
  • string $strUsername
  • string $strPassword
  • string $strHost
public  Network __construct ([integer $intNumberOfHiddenLayers = 1], [integer $intNumberOfNeuronsPerLayer = 6], [integer $intNumberOfOutputs = 1]) [236]
  • integer $intNumberOfHiddenLayers: (Default: 1)
  • integer $intNumberOfNeuronsPerLayer: (Default: 6)
  • integer $intNumberOfOutputs: (Default: 1)
protected  void activate () [452]
protected  void createHiddenLayers (integer $intNumberOfHiddenLayers, integer $intNumberOfNeuronsPerLayer) [416]
  • integer $intNumberOfHiddenLayers
  • integer $intNumberOfNeuronsPerLayer
protected  void createOutputLayer (integer $intNumberOfOutputs) [441]
  • integer $intNumberOfOutputs
protected  void detectOutputType () [1379]
protected  integer getCountInputs () [716]
protected  float getNetworkError () [1267]
protected  integer getNextIndexInputsToTrain ([boolean $boolReset = FALSE]) [564]
  • boolean $boolReset: (Default: FALSE)
public  integer getNumberHiddenLayers () [1142]
public  integer getNumberHiddens () [1154]
public  integer getNumberInputs () [1129]
public  integer getNumberOutputs () [1167]
public  array getOutputs () [358]

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) [394]
  • integer $intKeyInput
protected  string getPrintNetwork ([integer $intLevel = 2]) [795]
  • integer $intLevel: (0, 1, 2) (Default: 2)
protected  string getPrintNetworkDetails1 () [866]
protected  string getPrintNetworkDetails2 () [983]
public  integer getTotalLoops () [591]
  • access: public
protected  boolean hasTimeLeftForTraining () [554]
protected  boolean isEpoch () [600]
protected  boolean isTrainingComplete () [640]
protected  boolean isTrainingCompleteByEpoch () [670]
protected  boolean isTrainingCompleteByInputKey (integer $intKeyInput) [685]
  • integer $intKeyInput
protected  void logNetworkErrors () [1251]
public  void logNetworkErrorsToFile (string $strFilename) [1200]

Log network errors while training in CSV format

  • string $strFilename
protected  void logWeights () [1216]
public  void logWeightsToFile (string $strFilename) [1183]

Log weights while training in CSV format

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

Redefinition of:
Filesystem::saveToFile()
public  void saveToHost (string $strUsername, string $strPassword, string $strHost) [1321]
  • throws: Exception
  • access: public
  • string $strUsername
  • string $strPassword
  • string $strHost
protected  float setDynamicLearningRate (integer $intLoop) [1471]

Dynamic Learning Rate

Setting learning rate all 1000 loops dynamically

  • integer $intLoop
protected  void setInputs (array $arrInputs) [264]
  • array $arrInputs
protected  void setInputsToTrain (array $arrInputs) [337]
  • array $arrInputs
protected  void setLearningRate ([float $floatLearningRate = 0.7]) [624]

Setting the learning rate

  • float $floatLearningRate: (Default: 0.7) (0.1 .. 0.9)
protected  void setMaxExecutionTime () [1078]
public  void setMomentum ([float $floatMomentum = 0.95]) [1420]
  • throws: Exception
  • access: public
  • uses: Exception::__construct()
  • float $floatMomentum: (Default: 0.95) (0 .. 1)
public  void setOutputErrorTolerance ([float $floatOutputErrorTolerance = 0.02]) [1406]

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

  • access: public
  • float $floatOutputErrorTolerance: (Default: 0.02)
protected  void setOutputs (array $arrOutputs) [286]
  • array $arrOutputs
protected  void setOutputType ([integer $intType = self::OUTPUT_LINEAR]) [767]
  • integer $intType: (Default: Network::OUTPUT_LINEAR)
public  void setValues (Values $objValues) [325]

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  Network trainByHost (string $strUsername, string $strPassword, string $strHost) [1288]
  • throws: Exception
  • access: public
  • string $strUsername
  • string $strPassword
  • string $strHost
protected  void training (array $arrOutputs) [733]
  • array $arrOutputs
public  void __invoke ([integer $intLevel = 2]) [1446]
  • integer $intLevel: (Default: 2)
public  string __toString () [1456]
public  void __wakeup () [1090]

Inherited Methods

Inherited From Filesystem

Filesystem::loadFromFile()
Filesystem::saveToFile()
Class Constants
OUTPUT_BINARY = 2 (line 223)

Binary output type

OUTPUT_LINEAR = 1 (line 217)

Linear output type

Documentation generated on Wed, 01 Jun 2011 16:26:41 +0200 by phpDocumentor 1.4.1