weka.experiment
Class DedupingPRCurveCVResultProducerSplit

java.lang.Object
  extended byweka.experiment.DedupingPRCurveCVResultProducerSplit
All Implemented Interfaces:
AdditionalMeasureProducer, OptionHandler, ResultProducer, java.io.Serializable

public class DedupingPRCurveCVResultProducerSplit
extends java.lang.Object
implements ResultProducer, OptionHandler, AdditionalMeasureProducer

N-fold cross-validation learning curve for deduping applications

See Also:
Serialized Form

Field Summary
static java.lang.String DATASET_FIELD_NAME
           
static int FOLD_CREATION_MODE_RANDOM
           
static int FOLD_CREATION_MODE_STRATIFIED
          SVM-light can work in classification, regression and preference ranking modes
static java.lang.String FOLD_FIELD_NAME
           
protected  java.lang.String[] m_additionalMeasures
          The names of any additional measures to look for in SplitEvaluators
protected  boolean m_debugOutput
          Save raw output of split evaluators --- for debugging purposes
protected  int m_foldCreationMode
           
protected  Instances m_instances
          The dataset of interest
protected  int m_numFolds
          The number of folds in the cross-validation
protected  java.io.File m_outputFile
          The destination output file/directory for raw output
protected  double[] m_plotPoints
          The specific points to plot, either integers representing specific numbers of training examples, or decimal fractions representing percentages of the full training set
protected  ResultListener m_resultListener
          The ResultListener to send results to
protected  java.lang.String m_separateTrainingFile
          The separate training file if desired
protected  SplitEvaluator m_splitEvaluator
          The SplitEvaluator used to generate results
protected  OutputZipper m_zipDest
          The output zipper to use for saving raw splitEvaluator output
static java.lang.String RECALL_FIELD_NAME
           
static java.lang.String RUN_FIELD_NAME
           
static Tag[] TAGS_FOLD_CREATION_MODE
           
static java.lang.String TIMESTAMP_FIELD_NAME
           
 
Constructor Summary
DedupingPRCurveCVResultProducerSplit()
           
 
Method Summary
 void doRun(int run)
          Gets the results for a specified run number.
 void doRunKeys(int run)
          Gets the keys for a specified run number.
 java.util.Enumeration enumerateMeasures()
          Returns an enumeration of any additional measure names that might be in the SplitEvaluator
 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).
 SelectedTag getFoldCreationMode()
          return the fold creation mode
 java.lang.String[] getKeyNames()
          Gets the names of each of the columns produced for a single run.
 java.lang.Object[] getKeyTypes()
          Gets the data types of each of the columns produced for a single run.
 double getMeasure(java.lang.String additionalMeasureName)
          Returns the value of the named measure
 int getNumFolds()
          Get the value of NumFolds.
 java.lang.String[] getOptions()
          Gets the current settings of the result producer.
 java.io.File getOutputFile()
          Get the value of OutputFile.
 java.lang.String getPlotPoints()
          Get the value of PlotPoints.
 boolean getRawOutput()
          Get if raw split evaluator output is to be saved
 java.lang.String[] getResultNames()
          Gets the names of each of the columns produced for a single run.
 java.lang.Object[] getResultTypes()
          Gets the data types of each of the columns produced for a single run.
 java.lang.String getSeparateTrainingFile()
          Get the value of separate training file
 SplitEvaluator getSplitEvaluator()
          Get the SplitEvaluator.
static java.lang.Double getTimestamp()
          Gets a Double representing the current date and time.
protected  Instances getTrainingFold(java.util.ArrayList foldList, int testFoldIdx)
          Given a list of folds, merge together all but the test fold with the specified index and return the resulting training fold
 java.lang.String globalInfo()
          Returns a string describing this result producer
 java.util.Enumeration listOptions()
          Returns an enumeration describing the available options..
static void main(java.lang.String[] args)
           
 java.lang.String numFoldsTipText()
          Returns the tip text for this property
 java.lang.String outputFileTipText()
          Returns the tip text for this property
protected  double[] parsePlotPoints(java.lang.String plotPoints)
          Parse a string of doubles separated by commas or spaces into a sorted array of doubles
 java.lang.String plotPointsTipText()
          Returns the tip text for this property
 void postProcess()
          Perform any postprocessing.
 void preProcess()
          Prepare to generate results.
protected  java.lang.Object[] processResults(java.lang.Object[] prResults, double recallLevel)
          Given an array containing the overall results of a deduping experiment, produce an array containing results for a specific recall level
 java.lang.String rawOutputTipText()
          Returns the tip text for this property
 void setAdditionalMeasures(java.lang.String[] additionalMeasures)
          Set a list of method names for additional measures to look for in SplitEvaluators.
 void setFoldCreationMode(SelectedTag mode)
          Set the mode of creating folds
 void setInstances(Instances instances)
          Sets the dataset that results will be obtained for.
 void setNumFolds(int newNumFolds)
          Set the value of NumFolds.
 void setOptions(java.lang.String[] options)
          Parses a given list of options.
 void setOutputFile(java.io.File newOutputFile)
          Set the value of OutputFile.
 void setPlotPoints(java.lang.String plotPoints)
          Set the value of PlotPoints.
 void setRawOutput(boolean d)
          Set to true if raw split evaluator output is to be saved
 void setResultListener(ResultListener listener)
          Sets the object to send results of each run to.
 void setSeparateTrainingFile(java.lang.String separateTrainingFile)
          Set the value of separate training file
 void setSplitEvaluator(SplitEvaluator newSplitEvaluator)
          Set the SplitEvaluator.
 java.lang.String splitEvaluatorTipText()
          Returns the tip text for this property
 java.lang.String toString()
          Gets a text descrption of the result producer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

m_instances

protected Instances m_instances
The dataset of interest


FOLD_CREATION_MODE_STRATIFIED

public static final int FOLD_CREATION_MODE_STRATIFIED
SVM-light can work in classification, regression and preference ranking modes

See Also:
Constant Field Values

FOLD_CREATION_MODE_RANDOM

public static final int FOLD_CREATION_MODE_RANDOM
See Also:
Constant Field Values

TAGS_FOLD_CREATION_MODE

public static final Tag[] TAGS_FOLD_CREATION_MODE

m_foldCreationMode

protected int m_foldCreationMode

m_resultListener

protected ResultListener m_resultListener
The ResultListener to send results to


m_numFolds

protected int m_numFolds
The number of folds in the cross-validation


m_debugOutput

protected boolean m_debugOutput
Save raw output of split evaluators --- for debugging purposes


m_zipDest

protected OutputZipper m_zipDest
The output zipper to use for saving raw splitEvaluator output


m_outputFile

protected java.io.File m_outputFile
The destination output file/directory for raw output


m_separateTrainingFile

protected java.lang.String m_separateTrainingFile
The separate training file if desired


m_splitEvaluator

protected SplitEvaluator m_splitEvaluator
The SplitEvaluator used to generate results


m_additionalMeasures

protected java.lang.String[] m_additionalMeasures
The names of any additional measures to look for in SplitEvaluators


m_plotPoints

protected double[] m_plotPoints
The specific points to plot, either integers representing specific numbers of training examples, or decimal fractions representing percentages of the full training set


DATASET_FIELD_NAME

public static java.lang.String DATASET_FIELD_NAME

RUN_FIELD_NAME

public static java.lang.String RUN_FIELD_NAME

FOLD_FIELD_NAME

public static java.lang.String FOLD_FIELD_NAME

TIMESTAMP_FIELD_NAME

public static java.lang.String TIMESTAMP_FIELD_NAME

RECALL_FIELD_NAME

public static java.lang.String RECALL_FIELD_NAME
Constructor Detail

DedupingPRCurveCVResultProducerSplit

public DedupingPRCurveCVResultProducerSplit()
Method Detail

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.

Specified by:
setInstances in interface ResultProducer
Parameters:
instances - a value of type 'Instances'.

setResultListener

public void setResultListener(ResultListener listener)
Sets the object to send results of each run to.

Specified by:
setResultListener in interface ResultProducer
Parameters:
listener - a value of type 'ResultListener'

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.

Specified by:
setAdditionalMeasures in interface ResultProducer
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

Specified by:
enumerateMeasures in interface AdditionalMeasureProducer
Returns:
an enumeration of the measure names

getMeasure

public double getMeasure(java.lang.String additionalMeasureName)
Returns the value of the named measure

Specified by:
getMeasure in interface AdditionalMeasureProducer
Parameters:
additionalMeasureName - 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

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.

Specified by:
preProcess in interface ResultProducer
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.

Specified by:
postProcess in interface ResultProducer
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

Specified by:
doRunKeys in interface ResultProducer
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

Specified by:
doRun in interface ResultProducer
Parameters:
run - the run number to get results for.
Throws:
java.lang.Exception - if a problem occurs while getting the results

getTrainingFold

protected Instances getTrainingFold(java.util.ArrayList foldList,
                                    int testFoldIdx)
Given a list of folds, merge together all but the test fold with the specified index and return the resulting training fold

Parameters:
foldList - a list containg folds
testFoldIdx - the index of the fold that will be used for testing
Returns:
an agglomeration of all folds except for the test one.

processResults

protected java.lang.Object[] processResults(java.lang.Object[] prResults,
                                            double recallLevel)
Given an array containing the overall results of a deduping experiment, produce an array containing results for a specific recall level


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.

Specified by:
getKeyNames in interface ResultProducer
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.

Specified by:
getKeyTypes in interface ResultProducer
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.

Specified by:
getResultNames in interface ResultProducer
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.

Specified by:
getResultTypes in interface ResultProducer
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.

Specified by:
getCompatibilityState in interface ResultProducer
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.

getSeparateTrainingFile

public java.lang.String getSeparateTrainingFile()
Get the value of separate training file

Returns:
Value of separate training file.

setSeparateTrainingFile

public void setSeparateTrainingFile(java.lang.String separateTrainingFile)
Set the value of separate training file

Parameters:
separateTrainingFile - Value to assign to separate training file

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

getNumFolds

public int getNumFolds()
Get the value of NumFolds.

Returns:
Value of NumFolds.

setNumFolds

public void setNumFolds(int newNumFolds)
Set the value of NumFolds.

Parameters:
newNumFolds - Value to assign to NumFolds.

plotPointsTipText

public java.lang.String plotPointsTipText()
Returns the tip text for this property

Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui

getPlotPoints

public java.lang.String getPlotPoints()
Get the value of PlotPoints.

Returns:
Value of PlotPoints.

setPlotPoints

public void setPlotPoints(java.lang.String plotPoints)
Set the value of PlotPoints.

Parameters:
plotPoints - Value to assign to PlotPoints.

parsePlotPoints

protected double[] parsePlotPoints(java.lang.String plotPoints)
Parse a string of doubles separated by commas or spaces into a sorted array of doubles


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

setFoldCreationMode

public void setFoldCreationMode(SelectedTag mode)
Set the mode of creating folds

Parameters:
mode - stratified or random

getFoldCreationMode

public SelectedTag getFoldCreationMode()
return the fold creation mode

Returns:
one of stratified or random

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..

Specified by:
listOptions in interface OptionHandler
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:

-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.

Specified by:
setOptions in interface OptionHandler
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.

Specified by:
getOptions in interface OptionHandler
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.

main

public static void main(java.lang.String[] args)