Package adams.flow.transformer
Class WekaStreamEvaluator
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.flow.core.AbstractActor
-
- adams.flow.transformer.AbstractTransformer
-
- adams.flow.transformer.AbstractWekaClassifierEvaluator
-
- adams.flow.transformer.AbstractCallableWekaClassifierEvaluator
-
- adams.flow.transformer.WekaStreamEvaluator
-
- All Implemented Interfaces:
adams.core.AdditionalInformationHandler
,adams.core.CleanUpHandler
,adams.core.Destroyable
,adams.core.GlobalInfoSupporter
,adams.core.logging.LoggingLevelHandler
,adams.core.logging.LoggingSupporter
,adams.core.option.OptionHandler
,adams.core.QuickInfoSupporter
,adams.core.ShallowCopySupporter<adams.flow.core.Actor>
,adams.core.SizeOfHandler
,adams.core.Stoppable
,adams.core.StoppableWithFeedback
,adams.core.VariablesInspectionHandler
,adams.event.VariableChangeListener
,adams.flow.core.Actor
,adams.flow.core.ErrorHandler
,adams.flow.core.InputConsumer
,adams.flow.core.OutputProducer
,Serializable
,Comparable
public class WekaStreamEvaluator extends AbstractCallableWekaClassifierEvaluator
Evaluates an incremental classifier on a data stream using prequential evaluation (first evaluate, then train).
Input/output:
- accepts:
weka.core.Instance
- generates:
adams.flow.container.WekaEvaluationContainer
Container information:
- adams.flow.container.WekaEvaluationContainer: Evaluation, Model, Prediction output
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-name <java.lang.String> (property: name) The name of the actor. default: WekaStreamEvaluator
-annotation <adams.core.base.BaseAnnotation> (property: annotations) The annotations to attach to this actor. default:
-skip <boolean> (property: skip) If set to true, transformation is skipped and the input token is just forwarded as it is. default: false
-stop-flow-on-error <boolean> (property: stopFlowOnError) If set to true, the flow gets stopped in case this actor encounters an error; useful for critical actors. default: false
-silent <boolean> (property: silent) If enabled, then no errors are output in the console. default: false
-output <weka.classifiers.evaluation.output.prediction.AbstractOutput> (property: output) The class for generating prediction output; if 'Null' is used, then an Evaluation object is forwarded instead of a String. default: weka.classifiers.evaluation.output.prediction.Null
-always-use-container <boolean> (property: alwaysUseContainer) If enabled, always outputs an evaluation container. default: false
-classifier <adams.flow.core.CallableActorReference> (property: classifier) The callable source with the incremental classifier to evaluate. default: WekaClassifierSetup
-no-predictions <boolean> (property: discardPredictions) If enabled, the collection of predictions during evaluation is suppressed, wich will conserve memory. default: false
-interval <int> (property: interval) The interval (number of instance objects processed) after which to output evaluation or buffer. default: 100 minimum: 1
- Version:
- $Revision$
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static String
BACKUP_CLaSSIFIER
the backup key for the classifier.static String
BACKUP_CURRENT
the backup key for the current counter.static String
BACKUP_EVALUATION
the backup key for the evaluation.static String
BACKUP_HEADER
the backup key for the current header.protected weka.classifiers.Classifier
m_Classifier
the classifier to use.protected int
m_Current
the current counter of instances.protected weka.classifiers.Evaluation
m_Evaluation
the evaluation to use.protected weka.core.Instances
m_Header
the current header.protected int
m_Interval
the interval at which to output the evaluation.-
Fields inherited from class adams.flow.transformer.AbstractCallableWekaClassifierEvaluator
m_DiscardPredictions
-
Fields inherited from class adams.flow.transformer.AbstractWekaClassifierEvaluator
m_AlwaysUseContainer, m_Output, m_OutputBuffer
-
Fields inherited from class adams.flow.transformer.AbstractTransformer
BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken
-
Fields inherited from class adams.flow.core.AbstractActor
m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated
-
-
Constructor Summary
Constructors Constructor Description WekaStreamEvaluator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Class[]
accepts()
Returns the class that the consumer accepts.protected Hashtable<String,Object>
backupState()
Backs up the current state of the actor before update the variables.String
classifierTipText()
Returns the tip text for this property.void
defineOptions()
Adds options to the internal list of options.protected String
doExecute()
Executes the flow item.protected weka.classifiers.Classifier
getClassifierInstance()
Returns an instance of the callable classifier.int
getInterval()
Returns the output interval.String
getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.String
globalInfo()
Returns a string describing the object.String
intervalTipText()
Returns the tip text for this property.protected void
pruneBackup()
Removes entries from the backup.protected void
reset()
Initializes the members.protected void
restoreState(Hashtable<String,Object> state)
Restores the state of the actor before the variables got updated.void
setInterval(int value)
Sets the output interval.-
Methods inherited from class adams.flow.transformer.AbstractCallableWekaClassifierEvaluator
discardPredictionsTipText, getClassifier, getDiscardPredictions, setClassifier, setDiscardPredictions, setUp
-
Methods inherited from class adams.flow.transformer.AbstractWekaClassifierEvaluator
alwaysUseContainerTipText, cleanOutputBuffer, generates, getAlwaysUseContainer, getOutput, initOutputBuffer, outputTipText, setAlwaysUseContainer, setOutput, wrapUp
-
Methods inherited from class adams.flow.transformer.AbstractTransformer
currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute
-
Methods inherited from class adams.flow.core.AbstractActor
annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, preExecute, pruneBackup, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString
-
Methods inherited from class adams.core.logging.LoggingObject
getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface adams.flow.core.Actor
cleanUp, compareTo, destroy, equals, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged
-
-
-
-
Field Detail
-
BACKUP_CURRENT
public static final String BACKUP_CURRENT
the backup key for the current counter.- See Also:
- Constant Field Values
-
BACKUP_HEADER
public static final String BACKUP_HEADER
the backup key for the current header.- See Also:
- Constant Field Values
-
BACKUP_EVALUATION
public static final String BACKUP_EVALUATION
the backup key for the evaluation.- See Also:
- Constant Field Values
-
BACKUP_CLaSSIFIER
public static final String BACKUP_CLaSSIFIER
the backup key for the classifier.- See Also:
- Constant Field Values
-
m_Interval
protected int m_Interval
the interval at which to output the evaluation.
-
m_Current
protected int m_Current
the current counter of instances.
-
m_Header
protected weka.core.Instances m_Header
the current header.
-
m_Evaluation
protected weka.classifiers.Evaluation m_Evaluation
the evaluation to use.
-
m_Classifier
protected weka.classifiers.Classifier m_Classifier
the classifier to use.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceadams.core.GlobalInfoSupporter
- Specified by:
globalInfo
in classadams.core.option.AbstractOptionHandler
- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptions
in interfaceadams.core.option.OptionHandler
- Overrides:
defineOptions
in classAbstractCallableWekaClassifierEvaluator
-
reset
protected void reset()
Initializes the members.- Overrides:
reset
in classAbstractWekaClassifierEvaluator
-
classifierTipText
public String classifierTipText()
Returns the tip text for this property.- Specified by:
classifierTipText
in classAbstractCallableWekaClassifierEvaluator
- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setInterval
public void setInterval(int value)
Sets the output interval.- Parameters:
value
- the interval
-
getInterval
public int getInterval()
Returns the output interval.- Returns:
- the interval
-
intervalTipText
public String intervalTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
getQuickInfo
public String getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.- Specified by:
getQuickInfo
in interfaceadams.flow.core.Actor
- Specified by:
getQuickInfo
in interfaceadams.core.QuickInfoSupporter
- Overrides:
getQuickInfo
in classAbstractCallableWekaClassifierEvaluator
- Returns:
- null if no info available, otherwise short string
-
pruneBackup
protected void pruneBackup()
Removes entries from the backup.- Overrides:
pruneBackup
in classadams.flow.core.AbstractActor
-
backupState
protected Hashtable<String,Object> backupState()
Backs up the current state of the actor before update the variables.- Overrides:
backupState
in classadams.flow.transformer.AbstractTransformer
- Returns:
- the backup
-
restoreState
protected void restoreState(Hashtable<String,Object> state)
Restores the state of the actor before the variables got updated.- Overrides:
restoreState
in classadams.flow.transformer.AbstractTransformer
- Parameters:
state
- the backup of the state to restore from
-
accepts
public Class[] accepts()
Returns the class that the consumer accepts.- Returns:
- the Class of objects that can be processed
-
getClassifierInstance
protected weka.classifiers.Classifier getClassifierInstance()
Returns an instance of the callable classifier.- Overrides:
getClassifierInstance
in classAbstractCallableWekaClassifierEvaluator
- Returns:
- the classifier
-
doExecute
protected String doExecute()
Executes the flow item.- Specified by:
doExecute
in classadams.flow.core.AbstractActor
- Returns:
- null if everything is fine, otherwise error message
-
-