All Packages Class Hierarchy This Package Previous Next Index WEKA's home
Class weka.experiment.RandomSplitResultProducer
java.lang.Object
|
+----weka.experiment.RandomSplitResultProducer
- public class RandomSplitResultProducer
- extends java.lang.Object
- implements ResultProducer, OptionHandler, AdditionalMeasureProducer
Generates a single train/test split and calls the appropriate
SplitEvaluator to generate some results.
- Version:
- $Revision: 1.13 $
- Author:
- Len Trigg (trigg@cs.waikato.ac.nz)
DATASET_FIELD_NAME-
RUN_FIELD_NAME-
TIMESTAMP_FIELD_NAME-
RandomSplitResultProducer()
-
doRun(int)
- Gets the results for a specified run number.
doRunKeys(int)
- Gets the keys for a specified run number.
enumerateMeasures()
- Returns an enumeration of any additional measure names that might be
in the SplitEvaluator
getCompatibilityState()
- Gets a description of the internal settings of the result
producer, sufficient for distinguishing a ResultProducer
instance from another with different settings (ignoring
those settings set through this interface).
getKeyNames()
- Gets the names of each of the columns produced for a single run.
getKeyTypes()
- Gets the data types of each of the columns produced for a single run.
getMeasure(String)
- Returns the value of the named measure
getOptions()
- Gets the current settings of the result producer.
getOutputFile()
- Get the value of OutputFile.
getRandomizeData()
- Get if dataset is to be randomized
getRawOutput()
- Get if raw split evaluator output is to be saved
getResultNames()
- Gets the names of each of the columns produced for a single run.
getResultTypes()
- Gets the data types of each of the columns produced for a single run.
getSplitEvaluator()
- Get the SplitEvaluator.
getTimestamp()
- Gets a Double representing the current date and time.
getTrainPercent()
- Get the value of TrainPercent.
globalInfo()
- Returns a string describing this result producer
listOptions()
- Returns an enumeration describing the available options.
outputFileTipText()
- Returns the tip text for this property
postProcess()
- Perform any postprocessing.
preProcess()
- Prepare to generate results.
randomizeDataTipText()
- Returns the tip text for this property
rawOutputTipText()
- Returns the tip text for this property
setAdditionalMeasures(String[])
- Set a list of method names for additional measures to look for
in SplitEvaluators.
setInstances(Instances)
- Sets the dataset that results will be obtained for.
setOptions(String[])
- Parses a given list of options.
setOutputFile(File)
- Set the value of OutputFile.
setRandomizeData(boolean)
- Set to true if dataset is to be randomized
setRawOutput(boolean)
- Set to true if raw split evaluator output is to be saved
setResultListener(ResultListener)
- Sets the object to send results of each run to.
setSplitEvaluator(SplitEvaluator)
- Set the SplitEvaluator.
setTrainPercent(double)
- Set the value of TrainPercent.
splitEvaluatorTipText()
- Returns the tip text for this property
toString()
- Gets a text descrption of the result producer.
trainPercentTipText()
- Returns the tip text for this property
DATASET_FIELD_NAME
public static java.lang.String DATASET_FIELD_NAME
RUN_FIELD_NAME
public static java.lang.String RUN_FIELD_NAME
TIMESTAMP_FIELD_NAME
public static java.lang.String TIMESTAMP_FIELD_NAME
RandomSplitResultProducer
public RandomSplitResultProducer()
globalInfo
public java.lang.String globalInfo()
Returns a string describing this result producer
- Returns:
- a description of the result producer suitable for
displaying in the explorer/experimenter gui
setInstances
public void setInstances(Instances instances)
Sets the dataset that results will be obtained for.
- Parameters:
instances
- a value of type 'Instances'.
setAdditionalMeasures
public void setAdditionalMeasures(java.lang.String additionalMeasures[])
Set a list of method names for additional measures to look for
in SplitEvaluators. This could contain many measures (of which only a
subset may be produceable by the current SplitEvaluator) if an experiment
is the type that iterates over a set of properties.
- Parameters:
additionalMeasures
- an array of measure names, null if none
enumerateMeasures
public java.util.Enumeration enumerateMeasures()
Returns an enumeration of any additional measure names that might be
in the SplitEvaluator
- Returns:
- an enumeration of the measure names
getMeasure
public double getMeasure(java.lang.String additionalMeasureName)
Returns the value of the named measure
- Parameters:
measureName
- the name of the measure to query for its value
- Returns:
- the value of the named measure
- Throws:
- java.lang.IllegalArgumentException - if the named measure is not supported
setResultListener
public void setResultListener(ResultListener listener)
Sets the object to send results of each run to.
- Parameters:
listener
- a value of type 'ResultListener'
getTimestamp
public static java.lang.Double getTimestamp()
Gets a Double representing the current date and time.
eg: 1:46pm on 20/5/1999 -> 19990520.1346
- Returns:
- a value of type Double
preProcess
public void preProcess() throws java.lang.Exception
Prepare to generate results.
- Throws:
- java.lang.Exception - if an error occurs during preprocessing.
postProcess
public void postProcess() throws java.lang.Exception
Perform any postprocessing. When this method is called, it indicates
that no more requests to generate results for the current experiment
will be sent.
- Throws:
- java.lang.Exception - if an error occurs
doRunKeys
public void doRunKeys(int run) throws java.lang.Exception
Gets the keys for a specified run number. Different run
numbers correspond to different randomizations of the data. Keys
produced should be sent to the current ResultListener
- Parameters:
run
- the run number to get keys for.
- Throws:
- java.lang.Exception - if a problem occurs while getting the keys
doRun
public void doRun(int run) throws java.lang.Exception
Gets the results for a specified run number. Different run
numbers correspond to different randomizations of the data. Results
produced should be sent to the current ResultListener
- Parameters:
run
- the run number to get results for.
- Throws:
- java.lang.Exception - if a problem occurs while getting the results
getKeyNames
public java.lang.String[] getKeyNames()
Gets the names of each of the columns produced for a single run.
This method should really be static.
- Returns:
- an array containing the name of each column
getKeyTypes
public java.lang.Object[] getKeyTypes()
Gets the data types of each of the columns produced for a single run.
This method should really be static.
- Returns:
- an array containing objects of the type of each column. The
objects should be Strings, or Doubles.
getResultNames
public java.lang.String[] getResultNames()
Gets the names of each of the columns produced for a single run.
This method should really be static.
- Returns:
- an array containing the name of each column
getResultTypes
public java.lang.Object[] getResultTypes()
Gets the data types of each of the columns produced for a single run.
This method should really be static.
- Returns:
- an array containing objects of the type of each column. The
objects should be Strings, or Doubles.
getCompatibilityState
public java.lang.String getCompatibilityState()
Gets a description of the internal settings of the result
producer, sufficient for distinguishing a ResultProducer
instance from another with different settings (ignoring
those settings set through this interface). For example,
a cross-validation ResultProducer may have a setting for the
number of folds. For a given state, the results produced should
be compatible. Typically if a ResultProducer is an OptionHandler,
this string will represent the command line arguments required
to set the ResultProducer to that state.
- Returns:
- the description of the ResultProducer state, or null
if no state is defined
outputFileTipText
public java.lang.String outputFileTipText()
Returns the tip text for this property
- Returns:
- tip text for this property suitable for
displaying in the explorer/experimenter gui
getOutputFile
public java.io.File getOutputFile()
Get the value of OutputFile.
- Returns:
- Value of OutputFile.
setOutputFile
public void setOutputFile(java.io.File newOutputFile)
Set the value of OutputFile.
- Parameters:
newOutputFile
- Value to assign to OutputFile.
randomizeDataTipText
public java.lang.String randomizeDataTipText()
Returns the tip text for this property
- Returns:
- tip text for this property suitable for
displaying in the explorer/experimenter gui
getRandomizeData
public boolean getRandomizeData()
Get if dataset is to be randomized
- Returns:
- true if dataset is to be randomized
setRandomizeData
public void setRandomizeData(boolean d)
Set to true if dataset is to be randomized
- Parameters:
d
- true if dataset is to be randomized
rawOutputTipText
public java.lang.String rawOutputTipText()
Returns the tip text for this property
- Returns:
- tip text for this property suitable for
displaying in the explorer/experimenter gui
getRawOutput
public boolean getRawOutput()
Get if raw split evaluator output is to be saved
- Returns:
- true if raw split evalutor output is to be saved
setRawOutput
public void setRawOutput(boolean d)
Set to true if raw split evaluator output is to be saved
- Parameters:
d
- true if output is to be saved
trainPercentTipText
public java.lang.String trainPercentTipText()
Returns the tip text for this property
- Returns:
- tip text for this property suitable for
displaying in the explorer/experimenter gui
getTrainPercent
public double getTrainPercent()
Get the value of TrainPercent.
- Returns:
- Value of TrainPercent.
setTrainPercent
public void setTrainPercent(double newTrainPercent)
Set the value of TrainPercent.
- Parameters:
newTrainPercent
- Value to assign to TrainPercent.
splitEvaluatorTipText
public java.lang.String splitEvaluatorTipText()
Returns the tip text for this property
- Returns:
- tip text for this property suitable for
displaying in the explorer/experimenter gui
getSplitEvaluator
public SplitEvaluator getSplitEvaluator()
Get the SplitEvaluator.
- Returns:
- the SplitEvaluator.
setSplitEvaluator
public void setSplitEvaluator(SplitEvaluator newSplitEvaluator)
Set the SplitEvaluator.
- Parameters:
newSplitEvaluator
- new SplitEvaluator to use.
listOptions
public java.util.Enumeration listOptions()
Returns an enumeration describing the available options.
- Returns:
- an enumeration of all the available options
setOptions
public void setOptions(java.lang.String options[]) throws java.lang.Exception
Parses a given list of options. Valid options are:
-P num
The percent of instances used for training.
-D
Specify that raw split evaluator output is to be saved.
-R
Do not randomize the dataset.
-O file/directory name
Specify the file or directory to which raw split evaluator output
is to be saved. If a directory is specified, then each output string
is saved as an individual gzip file. If a file is specified, then
each output string is saved as an entry in a zip file.
-W classname
Specify the full class name of the split evaluator.
All option after -- will be passed to the split evaluator.
- Parameters:
options
- the list of options as an array of strings
- Throws:
- java.lang.Exception - if an option is not supported
getOptions
public java.lang.String[] getOptions()
Gets the current settings of the result producer.
- Returns:
- an array of strings suitable for passing to setOptions
toString
public java.lang.String toString()
Gets a text descrption of the result producer.
- Returns:
- a text description of the result producer.
- Overrides:
- toString in class java.lang.Object
All Packages Class Hierarchy This Package Previous Next Index WEKA's home