Package adams.flow.transformer
Class WekaTrainClusterer
-
- All Implemented Interfaces:
AdditionalInformationHandler,CleanUpHandler,Destroyable,GlobalInfoSupporter,LoggingLevelHandler,LoggingSupporter,OptionHandler,QuickInfoSupporter,ShallowCopySupporter<Actor>,SizeOfHandler,Stoppable,StoppableWithFeedback,VariablesInspectionHandler,VariableChangeListener,Actor,ErrorHandler,InputConsumer,OutputProducer,JobRunnerSupporter,Serializable,Comparable
public class WekaTrainClusterer extends AbstractTransformer implements JobRunnerSupporter
Trains a clusterer based on the incoming dataset and output the built clusterer alongside the training header (in a model container).
Incremental training is performed, if the input are weka.core.Instance objects and the clusterer implements weka.clusterers.UpdateableClusterer.
Input/output:
- accepts:
weka.core.Instances
weka.core.Instance
- generates:
adams.flow.container.WekaModelContainer
Container information:
- adams.flow.container.WekaModelContainer: Model, Header, Dataset
-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: WekaTrainClusterer
-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
-clusterer <adams.flow.core.CallableActorReference> (property: clusterer) The Weka clusterer to build on the input data. default: WekaClustererSetup
-post-processor <adams.flow.transformer.wekaclusterer.AbstractClustererPostProcessor> (property: postProcessor) The post-processor to use on model containers. default: adams.flow.transformer.wekaclusterer.PassThrough
-prefer-jobrunner <boolean> (property: preferJobRunner) If enabled, tries to offload the processing onto a adams.flow.standalone.JobRunnerInstance; applies only to batch training. 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 classWekaTrainClusterer.BatchTrainJob
-
Field Summary
Fields Modifier and Type Field Description static StringBACKUP_INCREMENTALCLUSTERERthe key for storing the current incremental clusterer in the backup.protected weka.clusterers.Clustererm_ActualClustererthe weka clusterer.protected CallableActorReferencem_Clustererthe name of the callable weka clusterer.protected weka.clusterers.Clustererm_IncrementalClustererthe clusterer used when training incrementally.protected JobRunnerInstancem_JobRunnerInstancethe JobRunnerInstance to use.protected AbstractClustererPostProcessorm_PostProcessorthe post-processor.protected booleanm_PreferJobRunnerwhether to offload training into a JobRunnerInstance.-
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
-
Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager
-
Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel
-
Fields inherited from interface adams.flow.core.Actor
FILE_EXTENSION, FILE_EXTENSION_GZ
-
-
Constructor Summary
Constructors Constructor Description WekaTrainClusterer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Class[]accepts()Returns the class that the consumer accepts.protected Hashtable<String,Object>backupState()Backs up the current state of the actor before update the variables.StringclustererTipText()Returns the tip text for this property.voiddefineOptions()Adds options to the internal list of options.protected StringdoExecute()Executes the flow item.Class[]generates()Returns the class of objects that it generates.CallableActorReferencegetClusterer()Returns the clusterer in use.protected weka.clusterers.ClusterergetClustererInstance()Returns an instance of the callable clusterer.AbstractClustererPostProcessorgetPostProcessor()Returns the post-processor in use.booleangetPreferJobRunner()Returns whether to offload processing to a JobRunner instance if available.StringgetQuickInfo()Returns a quick info about the actor, which will be displayed in the GUI.StringglobalInfo()Returns a string describing the object.StringpostProcessorTipText()Returns the tip text for this property.StringpreferJobRunnerTipText()Returns the tip text for this property.protected voidpruneBackup()Removes entries from the backup.protected voidreset()Resets the scheme.protected voidrestoreState(Hashtable<String,Object> state)Restores the state of the actor before the variables got updated.voidsetClusterer(CallableActorReference value)Sets the clusterer to use.voidsetPostProcessor(AbstractClustererPostProcessor value)Sets the post-processor to use.voidsetPreferJobRunner(boolean value)Sets whether to offload processing to a JobRunner instance if available.StringsetUp()Initializes the item for flow execution.voidwrapUp()Cleans up after the execution has finished.-
Methods inherited from class adams.flow.transformer.AbstractTransformer
currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute
-
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, 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
-
Methods inherited from interface adams.core.AdditionalInformationHandler
getAdditionalInformation
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel, setLoggingLevel
-
Methods inherited from interface adams.core.logging.LoggingSupporter
getLogger, isLoggingEnabled
-
Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager
-
Methods inherited from interface adams.core.VariablesInspectionHandler
canInspectOptions
-
-
-
-
Field Detail
-
BACKUP_INCREMENTALCLUSTERER
public static final String BACKUP_INCREMENTALCLUSTERER
the key for storing the current incremental clusterer in the backup.- See Also:
- Constant Field Values
-
m_Clusterer
protected CallableActorReference m_Clusterer
the name of the callable weka clusterer.
-
m_ActualClusterer
protected weka.clusterers.Clusterer m_ActualClusterer
the weka clusterer.
-
m_IncrementalClusterer
protected weka.clusterers.Clusterer m_IncrementalClusterer
the clusterer used when training incrementally.
-
m_PostProcessor
protected AbstractClustererPostProcessor m_PostProcessor
the post-processor.
-
m_PreferJobRunner
protected boolean m_PreferJobRunner
whether to offload training into a JobRunnerInstance.
-
m_JobRunnerInstance
protected transient JobRunnerInstance m_JobRunnerInstance
the JobRunnerInstance to use.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfoin interfaceGlobalInfoSupporter- Specified by:
globalInfoin classAbstractOptionHandler- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptionsin interfaceOptionHandler- Overrides:
defineOptionsin classAbstractActor
-
setClusterer
public void setClusterer(CallableActorReference value)
Sets the clusterer to use.- Parameters:
value- the clusterer
-
getClusterer
public CallableActorReference getClusterer()
Returns the clusterer in use.- Returns:
- the clusterer
-
clustererTipText
public String clustererTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setPostProcessor
public void setPostProcessor(AbstractClustererPostProcessor value)
Sets the post-processor to use.- Parameters:
value- the post-processor
-
getPostProcessor
public AbstractClustererPostProcessor getPostProcessor()
Returns the post-processor in use.- Returns:
- the post-processor
-
postProcessorTipText
public String postProcessorTipText()
Returns the tip text for this property.- 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:
setPreferJobRunnerin interfaceJobRunnerSupporter- 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:
getPreferJobRunnerin interfaceJobRunnerSupporter- Returns:
- if true try to find/use a JobRunner instance
-
preferJobRunnerTipText
public String preferJobRunnerTipText()
Returns the tip text for this property.- Specified by:
preferJobRunnerTipTextin interfaceJobRunnerSupporter- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
getQuickInfo
public String getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.- Specified by:
getQuickInfoin interfaceActor- Specified by:
getQuickInfoin interfaceQuickInfoSupporter- Overrides:
getQuickInfoin classAbstractActor- Returns:
- null if no info available, otherwise short string
-
pruneBackup
protected void pruneBackup()
Removes entries from the backup.- Overrides:
pruneBackupin classAbstractActor- See Also:
AbstractActor.reset()
-
backupState
protected Hashtable<String,Object> backupState()
Backs up the current state of the actor before update the variables.- Overrides:
backupStatein classAbstractTransformer- Returns:
- the backup
- See Also:
AbstractActor.updateVariables(),AbstractActor.restoreState(Hashtable)
-
restoreState
protected void restoreState(Hashtable<String,Object> state)
Restores the state of the actor before the variables got updated.- Overrides:
restoreStatein classAbstractTransformer- Parameters:
state- the backup of the state to restore from- See Also:
AbstractActor.updateVariables(),AbstractActor.backupState()
-
reset
protected void reset()
Resets the scheme.- Overrides:
resetin classAbstractActor
-
accepts
public Class[] accepts()
Returns the class that the consumer accepts.- Specified by:
acceptsin interfaceInputConsumer- Returns:
- weka.core.Instances.class, weka.core.Instance.class
-
generates
public Class[] generates()
Returns the class of objects that it generates.- Specified by:
generatesin interfaceOutputProducer- Returns:
- adams.flow.container.WekaModelContainer.class
-
getClustererInstance
protected weka.clusterers.Clusterer getClustererInstance() throws ExceptionReturns an instance of the callable clusterer.- Returns:
- the clusterer
- Throws:
Exception- if fails to obtain clusterer
-
setUp
public String setUp()
Initializes the item for flow execution.- Specified by:
setUpin interfaceActor- Overrides:
setUpin classAbstractActor- Returns:
- null if everything is fine, otherwise error message
- See Also:
AbstractActor.reset()
-
doExecute
protected String doExecute()
Executes the flow item.- Specified by:
doExecutein classAbstractActor- Returns:
- null if everything is fine, otherwise error message
-
wrapUp
public void wrapUp()
Cleans up after the execution has finished.- Specified by:
wrapUpin interfaceActor- Overrides:
wrapUpin classAbstractTransformer
-
-