adams.flow.transformer
Class OptimizeClassifierMultiSearch

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

All Implemented Interfaces:

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

public class OptimizeClassifierMultiSearch
extends AbstractTransformer

Performs cross-validation of a classifier on a dataset.

Version:

$Revision: 6830 $

Author:

msf8, FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

static class

OptimizeClassifierMultiSearch.Evaluation The type of evaluation to perform.

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 OptimizeClassifierMultiSearch.Evaluation	m_Evaluation the statistic to evaluate on.
protected AbstractParameter[]	m_Parameters the search parameters.

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

OptimizeClassifierMultiSearch()

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	evaluationTipText() 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
OptimizeClassifierMultiSearch.Evaluation	getEvaluation() Sets the type of statistic to evaluate the performance on.
AbstractParameter[]	getParameters() Returns the search parameters.
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	parametersTipText() description for this option.
void	setClassifier(GlobalActorReference c) set the classifier to use
void	setEvaluation(OptimizeClassifierMultiSearch.Evaluation value) Sets the type of statistic to evaluate the performance on.
void	setParameters(AbstractParameter[] value) Set the search parameters.

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_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

m_Parameters

protected AbstractParameter[] m_Parameters

the search parameters.

m_Evaluation

protected OptimizeClassifierMultiSearch.Evaluation m_Evaluation

the statistic to evaluate on.

Constructor Detail

OptimizeClassifierMultiSearch

public OptimizeClassifierMultiSearch()

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

setParameters

public void setParameters(AbstractParameter[] value)

Set the search parameters.

Parameters:

value - the search parameters

getParameters

public AbstractParameter[] getParameters()

Returns the search parameters.

Returns:

the search parameters

parametersTipText

public String parametersTipText()

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

setEvaluation

public void setEvaluation(OptimizeClassifierMultiSearch.Evaluation value)

Sets the type of statistic to evaluate the performance on.

Parameters:

value - the type of statistic to use

getEvaluation

public OptimizeClassifierMultiSearch.Evaluation getEvaluation()

Sets the type of statistic to evaluate the performance on.

Returns:

the evaluation

evaluationTipText

public String evaluationTipText()

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

getClassifierInstance

protected Classifier getClassifierInstance()

get the classifier from the global actor containing the classifier

Returns:

Classifier object

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message