adams.flow.transformer
Class CrossValidationClassifier

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

All Implemented Interfaces:

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

public class CrossValidationClassifier
extends AbstractTransformer

Performs cross-validation of a classifier on a dataset.

Version:

$Revision$

Author:

msf8

See Also:

Serialized Form

Field Summary

protected Classifier	m_Classifier classifier to use for the cross validation
protected GlobalActorReference	m_ClassifierActor for getting the classifier as a global actor
protected int	m_Folds number of folds for the cross validation
protected int	m_Seed seed to use for the cross validation

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_ScopeHandler, 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

CrossValidationClassifier()

Method Summary

Class[]	accepts() Returns the class that the consumer accepts.
String	classifierTipText() description of this option
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
String	foldsTipText() Description of this option
Class[]	generates() Returns the class of objects that it generates.
GlobalActorReference	getClassifier() get the classifier to use
protected Classifier	getClassifierInstance() get the classifier from the global actor containing the classifier
int	getFolds() Get the number of folds used for the cross validation
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
int	getSeed() get the seed used for the cross validation
String	globalInfo() Returns a string describing the object.
String	seedTipText() description for this option
void	setClassifier(GlobalActorReference c) set the classifier to use
void	setFolds(int f) set the number of folds used for the cross validation
void	setSeed(int s) Set the seed for the cross validation

Methods inherited from class adams.flow.transformer.AbstractTransformer

backupState, execute, hasPendingOutput, input, output, postExecute, reset, restoreState, wrapUp

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, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, 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, 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.core.Actor

cleanUp, compareTo, debug, destroy, equals, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, sizeOf, stopExecution, stopExecution, variableChanged

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Field Detail

m_Seed

protected int m_Seed

seed to use for the cross validation

m_Folds

protected int m_Folds

number of folds for the cross validation

m_Classifier

protected Classifier m_Classifier

classifier to use for the cross validation

m_ClassifierActor

protected GlobalActorReference m_ClassifierActor

for getting the classifier as a global actor

Constructor Detail

CrossValidationClassifier

public CrossValidationClassifier()

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 AbstractActor

getQuickInfo

public String getQuickInfo()

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

Specified by:

getQuickInfo in interface QuickInfoSupporter

Specified by:

getQuickInfo in interface Actor

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

setFolds

public void setFolds(int f)

set the number of folds used for the cross validation

Parameters:

f - Number of folds for cross validation

getFolds

public int getFolds()

Get the number of folds used for the cross validation

Returns:

NUmber of folds in the cross validation

foldsTipText

public String foldsTipText()

Description of this option

Returns:

Description of the folds option

setSeed

public void setSeed(int s)

Set the seed for the cross validation

Parameters:

s - Seed for cross validation

getSeed

public int getSeed()

get the seed used for the cross validation

Returns:

seed for cross validation

seedTipText

public String seedTipText()

description for this option

Returns:

Description of the seed option

setClassifier

public void setClassifier(GlobalActorReference c)

set the classifier to use

Parameters:

c - global actor classifier for cross validation

getClassifier

public GlobalActorReference getClassifier()

get the classifier to use

Returns:

Global actor containing the classifier

classifierTipText

public String classifierTipText()

description of this option

Returns:

description of the classifier option

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Returns:

the Class of objects that can be processed

generates

public Class[] generates()

Returns the class of objects that it generates.

Returns:

the Class of the generated tokens

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message

getClassifierInstance

protected Classifier getClassifierInstance()

get the classifier from the global actor containing the classifier

Returns:

Classifier object