Package weka.knowledgeflow.steps
Class Clusterer
java.lang.Object
weka.knowledgeflow.steps.BaseStep
weka.knowledgeflow.steps.WekaAlgorithmWrapper
weka.knowledgeflow.steps.Clusterer
- All Implemented Interfaces:
Serializable,BaseStepExtender,PairedDataHelper.PairedProcessor<Clusterer>,Step
@KFStep(name="Clusterer",
category="Clusterers",
toolTipText="Weka clusterer wrapper",
iconPath="",
resourceIntensive=true)
public class Clusterer
extends WekaAlgorithmWrapper
implements PairedDataHelper.PairedProcessor<Clusterer>
Step that wraps a Weka clusterer. Handles trainingSet and testSet incoming
connections
- Version:
- $Revision: $
- Author:
- Mark Hall (mhall{[at]}pentaho{[dot]}com)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the clusterer to trainGet a list of connection types that could be made to this Step at this point in timeGet the name of the clusterer to load at execution time.Get a list of outgoing connections that could be made from this step at this point in timeGet the class of the wrapped algorithmvoidprocessIncoming(Data data) Process an incoming data objectprocessPrimary(Integer setNum, Integer maxSetNum, Data data, PairedDataHelper<Clusterer> helper) Process a training split (primary data handled by the PairedDataHelper)voidprocessSecondary(Integer setNum, Integer maxSetNum, Data data, PairedDataHelper<Clusterer> helper) Process a test split/fold (secondary data handled by PairedDataHelper)voidsetClusterer(Clusterer clusterer) Set the clusterer to trainvoidsetLoadClustererFileName(File filename) Set the name of the clusterer to load at execution time.voidsetWrappedAlgorithm(Object algo) Set the wrapped algorithmvoidstepInit()Initialize the stepMethods inherited from class weka.knowledgeflow.steps.WekaAlgorithmWrapper
getDefaultIconPath, getDefaultPackageLevelIconPath, getIconPath, getWrappedAlgorithm, globalInfoMethods inherited from class weka.knowledgeflow.steps.BaseStep
environmentSubstitute, getCustomEditorForStep, getDefaultSettings, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, isResourceIntensive, isStopRequested, outputStructureForConnectionType, outputStructureForConnectionType, setName, setStepIsResourceIntensive, setStepManager, setStepMustRunSingleThreaded, start, stepMustRunSingleThreaded, stop
-
Constructor Details
-
Clusterer
public Clusterer()
-
-
Method Details
-
getClusterer
Get the clusterer to train- Returns:
- the clusterer to train
-
setClusterer
Set the clusterer to train- Parameters:
clusterer- the clusterer to train
-
getLoadClustererFileName
Get the name of the clusterer to load at execution time. This only applies in the case where the only incoming connection is a test set connection (batch mode) or an instance connection (incremental prediction mode).- Returns:
- the name of the file to load the model from
-
setLoadClustererFileName
@OptionMetadata(displayName="Clusterer model to load", description="Optional path to a clusterer to load at execution time (only applies when using testSet connections)") @FilePropertyMetadata(fileChooserDialogType=0, directoriesOnly=false) public void setLoadClustererFileName(File filename) Set the name of the clusterer to load at execution time. This only applies in the case where the only incoming connection is a test set connection (batch mode) or an instance connection (incremental prediction mode).- Parameters:
filename- the name of the file to load the model from
-
getWrappedAlgorithmClass
Get the class of the wrapped algorithm- Specified by:
getWrappedAlgorithmClassin classWekaAlgorithmWrapper- Returns:
- the class of the wrapped algorithm
-
setWrappedAlgorithm
Set the wrapped algorithm- Overrides:
setWrappedAlgorithmin classWekaAlgorithmWrapper- Parameters:
algo- the algorithm to wrap
-
stepInit
Initialize the step- Specified by:
stepInitin interfaceBaseStepExtender- Specified by:
stepInitin interfaceStep- Throws:
WekaException- if a problem occurs
-
processIncoming
Process an incoming data object- Specified by:
processIncomingin interfaceBaseStepExtender- Specified by:
processIncomingin interfaceStep- Overrides:
processIncomingin classBaseStep- Parameters:
data- the data to process- Throws:
WekaException- if a problem occurs
-
getIncomingConnectionTypes
Get a list of connection types that could be made to this Step at this point in time- Specified by:
getIncomingConnectionTypesin interfaceBaseStepExtender- Specified by:
getIncomingConnectionTypesin interfaceStep- Returns:
- a list of incoming connection types that could be made at this time
-
getOutgoingConnectionTypes
Get a list of outgoing connections that could be made from this step at this point in time- Specified by:
getOutgoingConnectionTypesin interfaceBaseStepExtender- Specified by:
getOutgoingConnectionTypesin interfaceStep- Returns:
- a list of outgoing connections that could be made at this point in time
-
processPrimary
public Clusterer processPrimary(Integer setNum, Integer maxSetNum, Data data, PairedDataHelper<Clusterer> helper) throws WekaException Process a training split (primary data handled by the PairedDataHelper)- Specified by:
processPrimaryin interfacePairedDataHelper.PairedProcessor<Clusterer>- Parameters:
setNum- the number of this split/foldmaxSetNum- the maximum number of splits/folds in the groupdata- the actual split/fold datahelper- the PairedDataHelper managing the paired data- Returns:
- a Classifier trained on this training split
- Throws:
WekaException- if a problem occurs
-
processSecondary
public void processSecondary(Integer setNum, Integer maxSetNum, Data data, PairedDataHelper<Clusterer> helper) throws WekaException Process a test split/fold (secondary data handled by PairedDataHelper)- Specified by:
processSecondaryin interfacePairedDataHelper.PairedProcessor<Clusterer>- Parameters:
setNum- the set number of this split/foldmaxSetNum- the maximum number of splits/folds in the groupdata- the actual split/fold datahelper- the PairedDataHelper managing the paried data- Throws:
WekaException- if a problem occurs
-