ABLE 2.0.0 07/02/2003 10:25:01

com.ibm.able.agents
Class AbleNeuralClassifierAgent

java.lang.Object
  |
  +--com.ibm.able.AbleObject
        |
        +--com.ibm.able.AbleDefaultAgent
              |
              +--com.ibm.able.agents.AbleNeuralClassifierAgent
All Implemented Interfaces:
AbleAgent, AbleBean, AbleBeanContainer, AbleDataBufferManager, AbleEventListener, AbleEventListenerManager, AbleEventQueueManager, AbleEventQueueProcessor, AblePropertyChangeManager, AbleSerializable, AbleUserDefinedFunctionManager, java.util.EventListener, java.beans.PropertyChangeListener, java.io.Serializable

public class AbleNeuralClassifierAgent
extends AbleDefaultAgent
implements java.io.Serializable

This class implements a classifier using back propagation

See Also:
Serialized Form

Field Summary
 double avgRMSError
           
protected  int bufferSize
           
protected  java.lang.String dataFileName
           
static java.lang.String defaultName
          Value assigned to name by default.
protected  int desiredPercentCorrect
           
protected  int desiredPercentIncorrect
           
protected  AbleFilter filt1
           
protected  AbleFilter filt2
           
protected  AbleImport imp1
           
protected  AbleImport imp2
           
protected  int lastNumPasses
           
protected  int maxNumPasses
           
protected  AbleBackPropagation net
           
protected  java.lang.String netArch
           
 int numPasses
           
protected  java.lang.String testDataFileName
           
protected  double testTolerance
           
protected  boolean training
           
protected  boolean trainOK
           
protected  double trainTolerance
           
protected  int trainToTestRatio
           
 
Fields inherited from class com.ibm.able.AbleDefaultAgent
activeDataSource, eventConnections, myBeans, numEpochs, processList, processListOK, userDefinedFunctions
 
Fields inherited from class com.ibm.able.AbleObject
changed, chgSupport, comment, dataFlowEnabled, destBufferConnections, eventQueue, fileName, inputBuffer, listeners, logger, name, outputBuffer, parent, propertyConnectionMgr, sourceBufferConnections, state, stateChgSupport, trace
 
Constructor Summary
AbleNeuralClassifierAgent()
           
AbleNeuralClassifierAgent(java.lang.String aName)
           
 
Method Summary
protected  void autoTrain(int numPasses)
          AutoTrain toggles between train/test modes.
static java.lang.String Copyright()
          Determine the copyright of this class.
 double getAvgRMSError()
           
 int getBufferSize()
           
 java.lang.String getDataFileName()
           
 int getDesiredPercentCorrect()
           
 int getDesiredPercentIncorrect()
           
 int getMaxNumPasses()
           
 int getMode()
          get the internal config for either NNTRAIN = training from an external data file NNTEST = testing (with network locked) from an external data file or NNRUN = running (with network locked) from data placed in the input buffer
 java.lang.String getNetArch()
          Return the number of hidden units specified.
 java.lang.String getNetArchitecture()
          Return the number of input, hidden, and output units.
 AbleBackPropagation getNetwork()
           
 int getNumPasses()
           
 java.lang.String getTestDataFileName()
           
 double getTestTolerance()
           
 double getTrainTolerance()
           
 int getTrainToTestRatio()
           
 void init()
          Generate a complete neural Classifier agent bean.
 boolean isTraining()
          Check to see if the network is in the process of training.
 void processTimerEvent()
          This method is called from the asynch thread.
 void reset()
          Reset each bean created when the agent was initialized.
 void setBufferSize(int size)
           
 void setDataFileName(java.lang.String aFileName)
           
protected  void setDefaults()
           
 void setDesiredPercentCorrect(int percent)
           
 void setDesiredPercentIncorrect(int percent)
           
 void setMaxNumPasses(int num)
           
 void setMode(int mode)
          set the internal config for either NNTRAIN = training from an external data file NNTEST = testing (with network locked) from an external data file or NNRUN = running (with network locked) from data placed in the input buffer
 void setNetArch(java.lang.String arch)
           
 void setNumPasses(int num)
           
 void setTestDataFileName(java.lang.String aFileName)
           
 void setTestTolerance(double tol)
           
 void setTrainTolerance(double tol)
           
 void setTrainToTestRatio(int num)
           
 void startTraining()
          start automatically training the model from the external data this method is called from the customizer Start button should only be called when agent is already in TRAIN state
 void stopTraining()
          stop automatically training the model from the external data
 
Methods inherited from class com.ibm.able.AbleDefaultAgent
addBean, addBeans, addEventConnection, addUserDefinedFunction, buildProcessList, clsNm, containsBean, containsBean, containsUserDefinedFunction, debugTrace, generateUniqueName, getBean, getBeans, getDataSource, getNumEpochs, getProcessList, getUserDefinedFunction, getUserDefinedFunctions, handleAbleEvent, invokeUserDefinedFunction, isActiveDataSource, process, propertyChange, quitAll, quitEnabledEventProcessing, removeAllBeans, removeAllConnections, removeAllEventConnections, removeBean, removeBean, removeBeans, removeEventConnection, removeUserDefinedFunction, resumeAll, setActiveDataSource, setDataFlowEnabled, setProcessList, setUserDefinedFunctions, suspendAll
 
Methods inherited from class com.ibm.able.AbleObject
addAbleEventListener, addDestBufferConnection, addPropertyChangeListener, addPropertyConnection, addSourceBufferConnection, addStateChangeListener, dataChanged, firePropertyChange, flushAbleEventQueue, getAbleEventListeners, getAbleEventProcessingEnabled, getAbleEventQueueSize, getComment, getDestBufferConnections, getFileName, getInputBuffer, getInputBuffer, getInputBufferAsStringArray, getInputBufferContents, getLogger, getName, getOutputBuffer, getOutputBuffer, getOutputBufferAsStringArray, getOutputBufferContents, getParent, getPropertyConnectionManager, getSleepTime, getSourceBufferConnections, getState, getTraceLogger, hasInputBuffer, hasOutputBuffer, init, isAbleEventPostingEnabled, isAbleEventProcessingEnabled, isChanged, isConnectable, isDataFlowEnabled, isTimerEventProcessingEnabled, notifyAbleEventListeners, process, processAbleEvent, processBufferConnections, processNoEventProcessingEnabledSituation, removeAbleEventListener, removeAllAbleEventListeners, removeAllBufferConnections, removeAllPropertyConnections, removeDestBufferConnection, removePropertyChangeListener, removePropertyConnection, removeSourceBufferConnection, removeStateChangeListener, restartEnabledEventProcessing, restoreFromFile, restoreFromFile, restoreFromSerializedFile, restoreFromStream, resumeEnabledEventProcessing, saveToFile, saveToFile, setAbleEventProcessingEnabled, setChanged, setComment, setFileName, setInputBuffer, setInputBuffer, setLogger, setName, setOutputBuffer, setOutputBuffer, setParent, setSleepTime, setState, setTimerEventProcessingEnabled, setTraceLogger, sourceConnectionsOK, startEnabledEventProcessing, suspendEnabledEventProcessing
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.able.AbleBean
getComment, getLogger, getName, getParent, getState, getTraceLogger, init, isChanged, process, setChanged, setComment, setLogger, setName, setParent, setState, setTraceLogger
 
Methods inherited from interface com.ibm.able.AbleDataBufferManager
addDestBufferConnection, addSourceBufferConnection, getDestBufferConnections, getInputBuffer, getInputBuffer, getInputBufferAsStringArray, getInputBufferContents, getOutputBuffer, getOutputBuffer, getOutputBufferAsStringArray, getOutputBufferContents, getSourceBufferConnections, hasInputBuffer, hasOutputBuffer, isConnectable, isDataFlowEnabled, processBufferConnections, removeAllBufferConnections, removeDestBufferConnection, removeSourceBufferConnection, setInputBuffer, setInputBuffer, setOutputBuffer, setOutputBuffer
 
Methods inherited from interface com.ibm.able.AbleEventListenerManager
addAbleEventListener, dataChanged, getAbleEventListeners, notifyAbleEventListeners, removeAbleEventListener
 
Methods inherited from interface com.ibm.able.AbleEventQueueManager
flushAbleEventQueue, getAbleEventProcessingEnabled, getAbleEventQueueSize, getSleepTime, isAbleEventPostingEnabled, isAbleEventProcessingEnabled, isTimerEventProcessingEnabled, restartEnabledEventProcessing, resumeEnabledEventProcessing, setAbleEventProcessingEnabled, setSleepTime, setTimerEventProcessingEnabled, startEnabledEventProcessing, suspendEnabledEventProcessing
 
Methods inherited from interface com.ibm.able.AbleEventQueueProcessor
processAbleEvent, processNoEventProcessingEnabledSituation
 
Methods inherited from interface com.ibm.able.AblePropertyChangeManager
addPropertyChangeListener, addPropertyConnection, getPropertyConnectionManager, removeAllPropertyConnections, removePropertyChangeListener, removePropertyConnection
 
Methods inherited from interface com.ibm.able.AbleSerializable
getFileName, restoreFromFile, restoreFromFile, saveToFile, saveToFile, setFileName
 
Methods inherited from interface com.ibm.able.AbleBeanContainer
getName
 

Field Detail

defaultName

public static final java.lang.String defaultName
Value assigned to name by default.

dataFileName

protected java.lang.String dataFileName

testDataFileName

protected java.lang.String testDataFileName

bufferSize

protected int bufferSize

maxNumPasses

protected int maxNumPasses

desiredPercentCorrect

protected int desiredPercentCorrect

desiredPercentIncorrect

protected int desiredPercentIncorrect

netArch

protected java.lang.String netArch

imp1

protected AbleImport imp1

imp2

protected AbleImport imp2

filt1

protected AbleFilter filt1

filt2

protected AbleFilter filt2

net

protected AbleBackPropagation net

avgRMSError

public double avgRMSError

numPasses

public int numPasses

training

protected boolean training

lastNumPasses

protected int lastNumPasses

trainTolerance

protected double trainTolerance

testTolerance

protected double testTolerance

trainToTestRatio

protected int trainToTestRatio

trainOK

protected boolean trainOK
Constructor Detail

AbleNeuralClassifierAgent

public AbleNeuralClassifierAgent()
                          throws AbleException

AbleNeuralClassifierAgent

public AbleNeuralClassifierAgent(java.lang.String aName)
                          throws AbleException
Method Detail

reset

public void reset()
           throws AbleException
Reset each bean created when the agent was initialized. Restore processing options to default values.
Overrides:
reset in class AbleDefaultAgent
Following copied from class: com.ibm.able.AbleDefaultAgent
Throws:
AbleException - If an error occurs when resetting a contained bean. All errors are collected and insert into the exception so that one bean's error does not prevent another from being reset.

setDefaults

protected void setDefaults()
                    throws AbleException

init

public void init()
          throws AbleException
Generate a complete neural Classifier agent bean. If the training data file is not set, no action is taken. If the test data file is not set, the test import and filter beans are not generated.
Overrides:
init in class AbleObject
Following copied from interface: com.ibm.able.AbleBean
Throws:
AbleException - If an error occurs.

processTimerEvent

public void processTimerEvent()
                       throws AbleException
This method is called from the asynch thread. It is only used for automated training of the neural agent.
Overrides:
processTimerEvent in class AbleObject
Following copied from interface: com.ibm.able.AbleEventQueueProcessor
Throws:
AbleException - If an error occurs.

autoTrain

protected void autoTrain(int numPasses)
AutoTrain toggles between train/test modes. It is only called at the end of an epoch.

setDataFileName

public void setDataFileName(java.lang.String aFileName)
                     throws AbleException

getDataFileName

public java.lang.String getDataFileName()

setTestDataFileName

public void setTestDataFileName(java.lang.String aFileName)
                         throws AbleException

getTestDataFileName

public java.lang.String getTestDataFileName()

setBufferSize

public void setBufferSize(int size)

getBufferSize

public int getBufferSize()

getNetwork

public AbleBackPropagation getNetwork()

getNumPasses

public int getNumPasses()

setNumPasses

public void setNumPasses(int num)

setMaxNumPasses

public void setMaxNumPasses(int num)

getMaxNumPasses

public int getMaxNumPasses()

setDesiredPercentCorrect

public void setDesiredPercentCorrect(int percent)

getDesiredPercentCorrect

public int getDesiredPercentCorrect()

setDesiredPercentIncorrect

public void setDesiredPercentIncorrect(int percent)

getDesiredPercentIncorrect

public int getDesiredPercentIncorrect()

getAvgRMSError

public double getAvgRMSError()

setNetArch

public void setNetArch(java.lang.String arch)

getNetArch

public java.lang.String getNetArch()
Return the number of hidden units specified. Input and output units are calculated.

getNetArchitecture

public java.lang.String getNetArchitecture()
Return the number of input, hidden, and output units.

setTrainToTestRatio

public void setTrainToTestRatio(int num)

getTrainToTestRatio

public int getTrainToTestRatio()

setTestTolerance

public void setTestTolerance(double tol)

getTestTolerance

public double getTestTolerance()

setTrainTolerance

public void setTrainTolerance(double tol)

getTrainTolerance

public double getTrainTolerance()

setMode

public void setMode(int mode)
             throws AbleException
set the internal config for either NNTRAIN = training from an external data file NNTEST = testing (with network locked) from an external data file or NNRUN = running (with network locked) from data placed in the input buffer

getMode

public int getMode()
            throws AbleException
get the internal config for either NNTRAIN = training from an external data file NNTEST = testing (with network locked) from an external data file or NNRUN = running (with network locked) from data placed in the input buffer

isTraining

public boolean isTraining()
                   throws AbleException
Check to see if the network is in the process of training.

startTraining

public void startTraining()
                   throws AbleException
start automatically training the model from the external data this method is called from the customizer Start button should only be called when agent is already in TRAIN state

stopTraining

public void stopTraining()
                  throws AbleException
stop automatically training the model from the external data

Copyright

public static java.lang.String Copyright()
Determine the copyright of this class.
Returns:
A String containing this class's copyright statement.

ABLE 2.0.0 07/02/2003 10:25:01

(C) Copyright IBM Corporation 1999, 2003