Package adams.flow.transformer
Class WekaTrainTestSetEvaluator
- 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.WekaTrainTestSetEvaluator
-
- 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
,adams.multiprocess.JobRunnerSupporter
,Serializable
,Comparable
public class WekaTrainTestSetEvaluator extends AbstractCallableWekaClassifierEvaluator implements adams.multiprocess.JobRunnerSupporter
Trains a classifier on an incoming training dataset (from a container) and then evaluates it on the test set (also from a container).
The classifier setup being used in the evaluation is a callable 'Classifier' actor.
Input/output:
- accepts:
adams.flow.container.WekaTrainTestSetContainer
- generates:
adams.flow.container.WekaEvaluationContainer
Container information:
- adams.flow.container.WekaTrainTestSetContainer: Train, Test, Seed, FoldNumber, FoldCount, Train original indices, Test original indices
- adams.flow.container.WekaEvaluationContainer: Evaluation, Model, Prediction output, Original indices, Test data
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING min-user-mode: Expert
-name <java.lang.String> (property: name) The name of the actor. default: WekaTrainTestSetEvaluator
-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 execution at this level gets stopped in case this actor encounters an error; the error gets propagated; useful for critical actors. default: false min-user-mode: Expert
-silent <boolean> (property: silent) If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well. default: false min-user-mode: Expert
-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 classifier actor to train and evaluate on the test data. default: WekaClassifierSetup
-no-predictions <boolean> (property: discardPredictions) If enabled, the collection of predictions during evaluation is suppressed, wich will conserve memory. default: false
-prefer-jobrunner <boolean> (property: preferJobRunner) If enabled, tries to offload the processing onto a adams.flow.standalone.JobRunnerInstance. default: false
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
WekaTrainTestSetEvaluator.EvaluateJob
-
Field Summary
Fields Modifier and Type Field Description protected adams.flow.standalone.JobRunnerInstance
m_JobRunnerInstance
the JobRunnerInstance to use.protected boolean
m_PreferJobRunner
whether to offload train/evaluate onto a JobRunnerInstance.-
Fields inherited from class adams.flow.transformer.AbstractCallableWekaClassifierEvaluator
m_Classifier, 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 WekaTrainTestSetEvaluator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Class[]
accepts()
Returns the class that the consumer accepts.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.boolean
getPreferJobRunner()
Returns whether to offload processing to a JobRunner instance if available.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
preferJobRunnerTipText()
Returns the tip text for this property.void
setPreferJobRunner(boolean value)
Sets whether to offload processing to a JobRunner instance if available.String
setUp()
Initializes the item for flow execution.-
Methods inherited from class adams.flow.transformer.AbstractCallableWekaClassifierEvaluator
discardPredictionsTipText, getClassifier, getClassifierInstance, getDiscardPredictions, setClassifier, setDiscardPredictions
-
Methods inherited from class adams.flow.transformer.AbstractWekaClassifierEvaluator
alwaysUseContainerTipText, cleanOutputBuffer, generates, getAlwaysUseContainer, getOutput, initOutputBuffer, outputTipText, reset, setAlwaysUseContainer, setOutput, wrapUp
-
Methods inherited from class adams.flow.transformer.AbstractTransformer
backupState, currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute, restoreState
-
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, 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
-
-
-
-
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
-
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.
-
setPreferJobRunner
public void setPreferJobRunner(boolean value)
Sets whether to offload processing to a JobRunner instance if available.- Specified by:
setPreferJobRunner
in interfaceadams.multiprocess.JobRunnerSupporter
- Parameters:
value
- if true try to find/use a JobRunner instance
-
getPreferJobRunner
public boolean getPreferJobRunner()
Returns whether to offload processing to a JobRunner instance if available.- Specified by:
getPreferJobRunner
in interfaceadams.multiprocess.JobRunnerSupporter
- Returns:
- if true try to find/use a JobRunner instance
-
preferJobRunnerTipText
public String preferJobRunnerTipText()
Returns the tip text for this property.- Specified by:
preferJobRunnerTipText
in interfaceadams.multiprocess.JobRunnerSupporter
- 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 interfaceadams.flow.core.InputConsumer
- Returns:
- adams.flow.container.WekaTrainTestSetContainer.class
-
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
-
setUp
public String setUp()
Initializes the item for flow execution.- Specified by:
setUp
in interfaceadams.flow.core.Actor
- Overrides:
setUp
in classAbstractCallableWekaClassifierEvaluator
- Returns:
- null if everything is fine, otherwise error message
-
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
-
-