weka.knowledgeflow.steps

Class TrainTestSplitMaker

java.lang.Object

weka.knowledgeflow.steps.BaseStep

weka.knowledgeflow.steps.TrainTestSplitMaker

All Implemented Interfaces:

Serializable, BaseStepExtender, Step

@KFStep(name="TrainTestSplitMaker",
        category="Evaluation",
        toolTipText="Create a random train/test split",
        iconPath="weka/gui/knowledgeflow/icons/TrainTestSplitMaker.gif")
public class TrainTestSplitMaker
extends BaseStep

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TrainTestSplitMaker()

Method Summary

Modifier and Type	Method and Description
List<String>	getIncomingConnectionTypes() Get a list of incoming connection types that this step can accept.
List<String>	getOutgoingConnectionTypes() Get a list of outgoing connection types that this step can produce.
String	getSeed()
String	getTrainPercent()
String	globalInfo() Attempt to get default "about" information for this step by grabbing the toolTip from the KFStep annotation.
Instances	outputStructureForConnectionType(String connectionName) If possible, get the output structure for the named connection type as a header-only set of instances.
void	processIncoming(Data data) Process an incoming data payload (if the step accepts incoming connections)
String	seedTipText() Tip text for this property
void	setSeed(String seed)
void	setTrainPercent(String percent)
void	stepInit() Initialize the step.
String	trainPercentTipText() Tip text info for this property

Methods inherited from class weka.knowledgeflow.steps.BaseStep

environmentSubstitute, getCustomEditorForStep, getDefaultSettings, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, isResourceIntensive, isStopRequested, setName, setStepIsResourceIntensive, setStepManager, start, stop

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TrainTestSplitMaker

public TrainTestSplitMaker()

Method Detail

globalInfo

public String globalInfo()

Description copied from class: BaseStep

Attempt to get default "about" information for this step by grabbing the toolTip from the KFStep annotation.

Overrides:

globalInfo in class BaseStep

Returns:

a default "about" info string if this step uses the KFStep annotation and null otherwise. Subclasses should override to provide more comprehensive about info

trainPercentTipText

public String trainPercentTipText()

Tip text info for this property

Returns:

a String value

setTrainPercent

public void setTrainPercent(String percent)

getTrainPercent

public String getTrainPercent()

seedTipText

public String seedTipText()

Tip text for this property

Returns:

a String value

setSeed

public void setSeed(String seed)

getSeed

public String getSeed()

stepInit

public void stepInit()
              throws WekaException

Description copied from interface: Step

Initialize the step.

Throws:

WekaException - if a problem occurs during initialization

processIncoming

public void processIncoming(Data data)
                     throws WekaException

Description copied from class: BaseStep

Process an incoming data payload (if the step accepts incoming connections)

Specified by:

processIncoming in interface BaseStepExtender

Specified by:

processIncoming in interface Step

Overrides:

processIncoming in class BaseStep

Parameters:

data - the payload to process

Throws:

WekaException - if a problem occurs

getIncomingConnectionTypes

public List<String> getIncomingConnectionTypes()

Description copied from interface: Step

Get a list of incoming connection types that this step can accept. Ideally (and if appropriate), this should take into account the state of the step and any existing incoming connections. E.g. a step might be able to accept one (and only one) incoming batch data connection.

Returns:

a list of incoming connections that this step can accept given its current state

getOutgoingConnectionTypes

public List<String> getOutgoingConnectionTypes()

Description copied from interface: Step

Get a list of outgoing connection types that this step can produce. Ideally (and if appropriate), this should take into account the state of the step and the incoming connections. E.g. depending on what incoming connection is present, a step might be able to produce a trainingSet output, a testSet output or neither, but not both.

Returns:

a list of outgoing connections that this step can produce

outputStructureForConnectionType

public Instances outputStructureForConnectionType(String connectionName)
                                           throws WekaException

Description copied from class: BaseStep

If possible, get the output structure for the named connection type as a header-only set of instances. Can return null if the specified connection type is not representable as Instances or cannot be determined at present.

Specified by:

outputStructureForConnectionType in interface Step

Overrides:

outputStructureForConnectionType in class BaseStep

Parameters:

connectionName - the name of the connection type to get the output structure for

Returns:

the output structure as a header-only Instances object

Throws:

WekaException - if a problem occurs