adams.flow.transformer
Class PHMMIterativeEvaluation

java.lang.Object
  extended by adams.core.ConsoleObject
      extended by adams.core.option.AbstractOptionHandler
          extended by adams.flow.core.AbstractActor
              extended by adams.flow.transformer.AbstractTransformer
                  extended by adams.flow.transformer.AbstractWekaClassifierEvaluator
                      extended by adams.flow.transformer.AbstractGlobalPHMMClassifierEvaluator<T>
                          extended by adams.flow.transformer.AbstractPHMMIterativeEvaluation<IterativeHMMPropositionalizer,weka.utils.IterativeEvaluation>
                              extended by adams.flow.transformer.PHMMIterativeEvaluation
All Implemented Interfaces:
AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, ProvenanceSupporter, Serializable, Comparable

public class PHMMIterativeEvaluation
extends AbstractPHMMIterativeEvaluation<IterativeHMMPropositionalizer,weka.utils.IterativeEvaluation>
implements ProvenanceSupporter

Cross-validates a classifier on an incoming dataset. The classifier setup being used in the evaluation is a global 'Classifier' actor.

Input/output:
- accepts:
   weka.core.Instances
- generates:
   weka.classifiers.Evaluation

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 
-name <java.lang.String> (property: name)
    The name of the actor.
    default: PHMMIterativeEvaluation
 
-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:
 
-skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 
-stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 
-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
 
-classifier <adams.flow.core.GlobalActorReference> (property: classifier)
    The global PHMM classifier actor to evaluate on the input data.
    default: PHMMClassifier
 
-folds <int> (property: folds)
    The number of folds to use in the cross-validation; use -1 for leave-one-out
    cross-validation (LOOCV).
    default: 10
    minimum: -1
 
-num-iterations <int> (property: numIterations)
    The number of iterations to perform.
    default: 1
    minimum: 1
 
-iteration-step-size <int> (property: iterationStepSize)
    The step size for the iterations.
    default: 1
    minimum: 1
 

Version:
$Revision: 4584 $
Author:
fracpete (fracpete at waikato dot ac dot nz)
See Also:
Serialized Form

Field Summary
 
Fields inherited from class adams.flow.transformer.AbstractPHMMIterativeEvaluation
m_CurrentStep, m_Folds, m_IterationStepSize, m_Iterator, m_NumIterations
 
Fields inherited from class adams.flow.transformer.AbstractGlobalPHMMClassifierEvaluator
m_Classifier
 
Fields inherited from class adams.flow.transformer.AbstractWekaClassifierEvaluator
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_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated
 
Fields inherited from class adams.core.option.AbstractOptionHandler
m_DebugLevel, m_OptionManager
 
Fields inherited from interface adams.flow.core.Actor
FILE_EXTENSION, FILE_EXTENSION_GZ
 
Constructor Summary
PHMMIterativeEvaluation()
           
 
Method Summary
 String globalInfo()
          Returns a string describing the object.
protected  weka.utils.IterativeEvaluation newEvaluation()
          Instantiates a new evaluation object.
 
Methods inherited from class adams.flow.transformer.AbstractPHMMIterativeEvaluation
accepts, classifierTipText, defineOptions, doExecute, foldsTipText, getFolds, getIterationStepSize, getNumIterations, getQuickInfo, hasPendingOutput, iterationStepSizeTipText, numIterationsTipText, output, setFolds, setIterationStepSize, setNumIterations, stopExecution, updateProvenance
 
Methods inherited from class adams.flow.transformer.AbstractGlobalPHMMClassifierEvaluator
getClassifier, getClassifierInstance, setClassifier
 
Methods inherited from class adams.flow.transformer.AbstractWekaClassifierEvaluator
generates, getOutput, outputTipText, reset, setOutput, wrapUp
 
Methods inherited from class adams.flow.transformer.AbstractTransformer
backupState, execute, input, postExecute, restoreState
 
Methods inherited from class adams.flow.core.AbstractActor
annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged
 
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString
 
Methods inherited from class adams.core.ConsoleObject
getDebugging, getSystemErr, getSystemOut
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface adams.flow.provenance.ProvenanceSupporter
updateProvenance
 
Methods inherited from interface adams.flow.core.Actor
cleanUp, compareTo, debug, destroy, equals, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, sizeOf, stopExecution, variableChanged
 
Methods inherited from interface adams.core.AdditionalInformationHandler
getAdditionalInformation
 
Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager
 

Constructor Detail

PHMMIterativeEvaluation

public PHMMIterativeEvaluation()
Method Detail

globalInfo

public String globalInfo()
Returns a string describing the object.

Specified by:
globalInfo in class AbstractOptionHandler
Returns:
a description suitable for displaying in the gui

newEvaluation

protected weka.utils.IterativeEvaluation newEvaluation()
Instantiates a new evaluation object.

Specified by:
newEvaluation in class AbstractPHMMIterativeEvaluation<IterativeHMMPropositionalizer,weka.utils.IterativeEvaluation>
Returns:
the evaluation object


Copyright © 2013 University of Waikato, Hamilton, NZ. All Rights Reserved.