All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home

Class weka.experiment.CrossValidationResultProducer

java.lang.Object
    |
    +----weka.experiment.CrossValidationResultProducer

public class CrossValidationResultProducer
extends java.lang.Object
implements ResultProducer, OptionHandler, AdditionalMeasureProducer
Generates for each run, carries out an n-fold cross-validation, using the set SplitEvaluator to generate some results. If the class attribute is nominal, the dataset is stratified. Results for each fold are generated, so you may wish to use this in addition with an AveragingResultProducer to obtain averages for each run.

Version:
$Revision: 1.11 $
Author:
Len Trigg (trigg@cs.waikato.ac.nz)

Variable Index

 o DATASET_FIELD_NAME
 
 o FOLD_FIELD_NAME
 
 o RUN_FIELD_NAME
 
 o TIMESTAMP_FIELD_NAME
 

Constructor Index

 o CrossValidationResultProducer()
 

Method Index

 o doRun(int)
Gets the results for a specified run number.
 o doRunKeys(int)
Gets the keys for a specified run number.
 o enumerateMeasures()
Returns an enumeration of any additional measure names that might be in the SplitEvaluator
 o 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).
 o getKeyNames()
Gets the names of each of the columns produced for a single run.
 o getKeyTypes()
Gets the data types of each of the columns produced for a single run.
 o getMeasure(String)
Returns the value of the named measure
 o getNumFolds()
Get the value of NumFolds.
 o getOptions()
Gets the current settings of the result producer.
 o getOutputFile()
Get the value of OutputFile.
 o getRawOutput()
Get if raw split evaluator output is to be saved
 o getResultNames()
Gets the names of each of the columns produced for a single run.
 o getResultTypes()
Gets the data types of each of the columns produced for a single run.
 o getSplitEvaluator()
Get the SplitEvaluator.
 o getTimestamp()
Gets a Double representing the current date and time.
 o globalInfo()
Returns a string describing this result producer
 o listOptions()
Returns an enumeration describing the available options.
 o main(String[])
 
 o numFoldsTipText()
Returns the tip text for this property
 o outputFileTipText()
Returns the tip text for this property
 o postProcess()
Perform any postprocessing.
 o preProcess()
Prepare to generate results.
 o rawOutputTipText()
Returns the tip text for this property
 o setAdditionalMeasures(String[])
Set a list of method names for additional measures to look for in SplitEvaluators.
 o setInstances(Instances)
Sets the dataset that results will be obtained for.
 o setNumFolds(int)
Set the value of NumFolds.
 o setOptions(String[])
Parses a given list of options.
 o setOutputFile(File)
Set the value of OutputFile.
 o setRawOutput(boolean)
Set to true if raw split evaluator output is to be saved
 o setResultListener(ResultListener)
Sets the object to send results of each run to.
 o setSplitEvaluator(SplitEvaluator)
Set the SplitEvaluator.
 o splitEvaluatorTipText()
Returns the tip text for this property
 o toString()
Gets a text descrption of the result producer.

Field Detail

 o DATASET_FIELD_NAME
public static java.lang.String DATASET_FIELD_NAME
 o RUN_FIELD_NAME
public static java.lang.String RUN_FIELD_NAME
 o FOLD_FIELD_NAME
public static java.lang.String FOLD_FIELD_NAME
 o TIMESTAMP_FIELD_NAME
public static java.lang.String TIMESTAMP_FIELD_NAME

Constructor Detail

 o CrossValidationResultProducer
public CrossValidationResultProducer()

Method Detail

 o 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
 o setInstances
public void setInstances(Instances instances)
          Sets the dataset that results will be obtained for.
Parameters:
instances - a value of type 'Instances'.
 o setResultListener
public void setResultListener(ResultListener listener)
          Sets the object to send results of each run to.
Parameters:
listener - a value of type 'ResultListener'
 o 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
 o 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
 o 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
 o 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
 o preProcess
public void preProcess() throws java.lang.Exception
          Prepare to generate results.
Throws:
java.lang.Exception - if an error occurs during preprocessing.
 o 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
 o 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
 o 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
 o 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
 o 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.
 o 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
 o 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.
 o 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
 o 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
 o getOutputFile
public java.io.File getOutputFile()
          Get the value of OutputFile.
Returns:
Value of OutputFile.
 o setOutputFile
public void setOutputFile(java.io.File newOutputFile)
          Set the value of OutputFile.
Parameters:
newOutputFile - Value to assign to OutputFile.
 o numFoldsTipText
public java.lang.String numFoldsTipText()
          Returns the tip text for this property
Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui
 o getNumFolds
public int getNumFolds()
          Get the value of NumFolds.
Returns:
Value of NumFolds.
 o setNumFolds
public void setNumFolds(int newNumFolds)
          Set the value of NumFolds.
Parameters:
newNumFolds - Value to assign to NumFolds.
 o 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
 o 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
 o 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
 o 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
 o getSplitEvaluator
public SplitEvaluator getSplitEvaluator()
          Get the SplitEvaluator.
Returns:
the SplitEvaluator.
 o setSplitEvaluator
public void setSplitEvaluator(SplitEvaluator newSplitEvaluator)
          Set the SplitEvaluator.
Parameters:
newSplitEvaluator - new SplitEvaluator to use.
 o listOptions
public java.util.Enumeration listOptions()
          Returns an enumeration describing the available options.
Returns:
an enumeration of all the available options
 o setOptions
public void setOptions(java.lang.String options[]) throws java.lang.Exception
          Parses a given list of options. Valid options are:

-X num_folds
The number of folds to use for the cross-validation.

-D
Specify that raw split evaluator output is to be saved.

-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
 o getOptions
public java.lang.String[] getOptions()
          Gets the current settings of the result producer.
Returns:
an array of strings suitable for passing to setOptions
 o 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
 o main
public static void main(java.lang.String args[])

All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home