Class Network

Description

Implements interfaces:

  • access: public

Located in /Network.php (line 60)

Filesystem
   |
   --Network
Class Constant Summary
Method Summary
[756]   protected   static   string :  getDefaultFilename ()
[1104]   public   static   Network :  loadFromFile ([string $strFilename = null])
[1350]   public   static   Network :  loadFromHost (string $strUsername, string $strPassword, string $strHost)
[236]   public   Network :  __construct ([integer $intNumberOfHiddenLayers = 1], [integer $intNumberOfNeuronsPerLayer = 6], [integer $intNumberOfOutputs = 1])
[449]   protected   void :  activate ()
[413]   protected   void :  createHiddenLayers (integer $intNumberOfHiddenLayers, integer $intNumberOfNeuronsPerLayer)
[438]   protected   void :  createOutputLayer (integer $intNumberOfOutputs)
[1380]   protected   void :  detectOutputType ()
[716]   protected   integer :  getCountInputs ()
[1268]   protected   float :  getNetworkError ()
[564]   protected   integer :  getNextIndexInputsToTrain ([boolean $boolReset = FALSE])
[1143]   public   integer :  getNumberHiddenLayers ()
[1155]   public   integer :  getNumberHiddens ()
[1130]   public   integer :  getNumberInputs ()
[1168]   public   integer :  getNumberOutputs ()
[355]   public   array :  getOutputs ()
[391]   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)
[1252]   protected   void :  logNetworkErrors ()
[1201]   public   void :  logNetworkErrorsToFile (string $strFilename)
[1217]   protected   void :  logWeights ()
[1184]   public   void :  logWeightsToFile (string $strFilename)
[1433]   public   void :  printNetwork ([integer $intLevel = 2])
[1118]   public   void :  saveToFile ([string $strFilename = null])
[1322]   public   void :  saveToHost (string $strUsername, string $strPassword, string $strHost)
[1467]   protected   void :  setDynamicLearningRate (integer $intLoop)
[264]   protected   void :  setInputs (array $arrInputs)
[334]   protected   void :  setInputsToTrain (array $arrInputs)
[624]   protected   void :  setLearningRate ([float $floatLearningRate = 0.7])
[1078]   protected   void :  setMaxExecutionTime ()
[1417]   public   void :  setMomentum ([float $floatMomentum = 0.95])
[1403]   public   void :  setOutputErrorTolerance ([float $floatOutputErrorTolerance = 0.02])
[285]   protected   void :  setOutputs (array $arrOutputs)
[767]   protected   void :  setOutputType ([integer $intType = self::OUTPUT_LINEAR])
[322]   public   void :  setValues (Values $objValues)
[483]   public   boolean :  train ()
[1289]   public   Network :  trainByHost (string $strUsername, string $strPassword, string $strHost)
[733]   protected   void :  training (array $arrOutputs)
[1443]   public   void :  __invoke ([integer $intLevel = 2])
[1453]   public   string :  __toString ()
[1090]   public   void :  __wakeup ()
Methods
protected static string getDefaultFilename () [756]
public static Network loadFromFile ([string $strFilename = null]) [1104]
  • string $strFilename: (Default: null)

Redefinition of:
Filesystem::loadFromFile()
public static Network loadFromHost (string $strUsername, string $strPassword, string $strHost) [1350]
  • 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 () [449]
protected  void createHiddenLayers (integer $intNumberOfHiddenLayers, integer $intNumberOfNeuronsPerLayer) [413]
  • integer $intNumberOfHiddenLayers
  • integer $intNumberOfNeuronsPerLayer
protected  void createOutputLayer (integer $intNumberOfOutputs) [438]
  • integer $intNumberOfOutputs
protected  void detectOutputType () [1380]
protected  integer getCountInputs () [716]
protected  float getNetworkError () [1268]
protected  integer getNextIndexInputsToTrain ([boolean $boolReset = FALSE]) [564]
  • boolean $boolReset: (Default: FALSE)
public  integer getNumberHiddenLayers () [1143]
public  integer getNumberHiddens () [1155]
public  integer getNumberInputs () [1130]
public  integer getNumberOutputs () [1168]
public  array getOutputs () [355]

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) [391]
  • 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 () [1252]
public  void logNetworkErrorsToFile (string $strFilename) [1201]

Log network errors while training in CSV format

  • string $strFilename
protected  void logWeights () [1217]
public  void logWeightsToFile (string $strFilename) [1184]

Log weights while training in CSV format

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

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

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) [334]
  • 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]) [1417]
  • throws: Exception
  • access: public
  • uses: Exception::__construct()
  • float $floatMomentum: (Default: 0.95) (0 .. 1)
public  void setOutputErrorTolerance ([float $floatOutputErrorTolerance = 0.02]) [1403]

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

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

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) [1289]
  • throws: Exception
  • access: public
  • string $strUsername
  • string $strPassword
  • string $strHost
protected  void training (array $arrOutputs) [733]
  • array $arrOutputs
public  void __invoke ([integer $intLevel = 2]) [1443]
  • integer $intLevel: (Default: 2)
public  string __toString () [1453]
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, 15 Jun 2011 09:45:46 +0200 by phpDocumentor 1.4.1