adams.flow.transformer
Class WekaTestSetEvaluator

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.transformer.AbstractTransformer
                  adams.flow.transformer.AbstractWekaClassifierEvaluator
                      adams.flow.transformer.WekaTestSetEvaluator

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, ErrorHandler, InputConsumer, OutputProducer, ProvenanceSupporter, Serializable, Comparable

public class WekaTestSetEvaluator
extends AbstractWekaClassifierEvaluator
implements ProvenanceSupporter

Evaluates a trained classifier (obtained from input) on the dataset obtained from the global actor.

Input/output:
- accepts:
weka.classifiers.Classifier
adams.flow.container.WekaModelContainer
- generates:
weka.classifiers.Evaluation

Container information:
- adams.flow.container.WekaModelContainer: Model, Header

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: WekaTestSetEvaluator
 

-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
 

-testset <adams.flow.core.GlobalActorReference> (property: testset)
    The global actor to use for obtaining the test set.
    default: Testset
 

-no-predictions (property: discardPredictions)
    If enabled, the collection of predictions during evaluation is suppressed,
     wich will conserve memory.
 

Version:

$Revision: 4584 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected boolean	m_DiscardPredictions whether to discard predictions.
protected GlobalActorReference	m_Testset the name of the global trainset provider.

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

FILE_EXTENSION, FILE_EXTENSION_GZ, m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, 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

Constructor Summary

WekaTestSetEvaluator()

Method Summary

Class[]	accepts() Returns the class that the consumer accepts.
void	defineOptions() Adds options to the internal list of options.
String	discardPredictionsTipText() Returns the tip text for this property.
protected String	doExecute() Executes the flow item.
boolean	getDiscardPredictions() Returns whether to discard the predictions in order to preserve memory.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
GlobalActorReference	getTestset() Returns the name of the global classifier in use.
String	globalInfo() Returns a string describing the object.
void	setDiscardPredictions(boolean value) Sets whether to discard the predictions instead of collecting them for future use, in order to conserve memory.
void	setTestset(GlobalActorReference value) Sets the name of the global classifier to use.
String	testsetTipText() Returns the tip text for this property.
void	updateProvenance(ProvenanceContainer cont) Updates the provenance information in the provided container.

Methods inherited from class adams.flow.transformer.AbstractWekaClassifierEvaluator

generates, getOutput, outputTipText, reset, setOutput, wrapUp

Methods inherited from class adams.flow.transformer.AbstractTransformer

backupState, execute, hasPendingOutput, input, output, 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, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, 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

Field Detail

m_Testset

protected GlobalActorReference m_Testset

the name of the global trainset provider.

m_DiscardPredictions

protected boolean m_DiscardPredictions

whether to discard predictions.

Constructor Detail

WekaTestSetEvaluator

public WekaTestSetEvaluator()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractWekaClassifierEvaluator

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

setTestset

public void setTestset(GlobalActorReference value)

Sets the name of the global classifier to use.

Parameters:

value - the name

getTestset

public GlobalActorReference getTestset()

Returns the name of the global classifier in use.

Returns:

the name

testsetTipText

public String testsetTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setDiscardPredictions

public void setDiscardPredictions(boolean value)

Sets whether to discard the predictions instead of collecting them for future use, in order to conserve memory.

Parameters:

value - true if to discard predictions

getDiscardPredictions

public boolean getDiscardPredictions()

Returns whether to discard the predictions in order to preserve memory.

Returns:

true if predictions discarded

discardPredictionsTipText

public String discardPredictionsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Specified by:

accepts in interface InputConsumer

Returns:

weka.classifiers.Classifier.class, adams.flow.container.WekaModelContainer.class

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message

updateProvenance

public void updateProvenance(ProvenanceContainer cont)

Updates the provenance information in the provided container.

Specified by:

updateProvenance in interface ProvenanceSupporter

Parameters:

cont - the provenance container to update