|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectweka.experiment.ExplicitTestsetResultProducer
public class ExplicitTestsetResultProducer
Loads the external test set and calls the appropriate SplitEvaluator to generate some results.
The filename of the test set is constructed as follows:
<dir> + / + <prefix> + <relation-name> + <suffix>
The relation-name can be modified by using the regular expression to replace the matching sub-string with a specified replacement string. In order to get rid of the string that the Weka filters add to the end of the relation name, just use '.*-weka' as the regular expression to find.
The suffix determines the type of file to load, i.e., one is not restricted to ARFF files. As long as Weka recognizes the extension specified in the suffix, the data will be loaded with one of Weka's converters.
-D Save raw split evaluator output.
-O <file/directory name/path> The filename where raw output will be stored. If a directory name is specified then then individual outputs will be gzipped, otherwise all output will be zipped to the named file. Use in conjuction with -D. (default: splitEvalutorOut.zip)
-W <class name> The full class name of a SplitEvaluator. eg: weka.experiment.ClassifierSplitEvaluator
-R Set when data is to be randomized.
-dir <directory> The directory containing the test sets. (default: current directory)
-prefix <string> An optional prefix for the test sets (before the relation name). (default: empty string)
-suffix <string> The suffix to append to the test set. (default: _test.arff)
-find <regular expression> The regular expression to search the relation name with. Not used if an empty string. (default: empty string)
-replace <string> The replacement string for the all the matches of '-find'. (default: empty string)
Options specific to split evaluator weka.experiment.ClassifierSplitEvaluator:
-W <class name> The full class name of the classifier. eg: weka.classifiers.bayes.NaiveBayes
-C <index> The index of the class for which IR statistics are to be output. (default 1)
-I <index> The index of an attribute to output in the results. This attribute should identify an instance in order to know which instances are in the test set of a cross validation. if 0 no output (default 0).
-P Add target and prediction columns to the result for each fold.
Options specific to classifier weka.classifiers.rules.ZeroR:
-D If set, classifier is run in debug mode and may output additional info to the consoleAll options after -- will be passed to the split evaluator.
Field Summary | |
---|---|
static java.lang.String |
DATASET_FIELD_NAME
The name of the key field containing the dataset name. |
static java.lang.String |
DEFAULT_SUFFIX
the default suffix. |
static java.lang.String |
RUN_FIELD_NAME
The name of the key field containing the run number. |
static java.lang.String |
TIMESTAMP_FIELD_NAME
The name of the result field containing the timestamp. |
Constructor Summary | |
---|---|
ExplicitTestsetResultProducer()
|
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). |
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. |
java.lang.String[] |
getOptions()
Gets the current settings of the result producer. |
java.io.File |
getOutputFile()
Get the value of OutputFile. |
boolean |
getRandomizeData()
Get if dataset is to be randomized. |
boolean |
getRawOutput()
Get if raw split evaluator output is to be saved. |
java.lang.String |
getRelationFind()
Returns the currently set regular expression to use on the relation name. |
java.lang.String |
getRelationReplace()
Returns the currently set replacement string to use on the relation name. |
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 |
getRevision()
Returns the revision string. |
SplitEvaluator |
getSplitEvaluator()
Get the SplitEvaluator. |
java.io.File |
getTestsetDir()
Returns the currently set directory for the test sets. |
java.lang.String |
getTestsetPrefix()
Returns the currently set prefix. |
java.lang.String |
getTestsetSuffix()
Returns the currently set suffix. |
static java.lang.Double |
getTimestamp()
Gets a Double representing the current date and time. |
java.lang.String |
globalInfo()
Returns a string describing this result producer. |
java.util.Enumeration |
listOptions()
Returns an enumeration describing the available options.. |
java.lang.String |
outputFileTipText()
Returns the tip text for this property. |
void |
postProcess()
Perform any postprocessing. |
void |
preProcess()
Prepare to generate results. |
java.lang.String |
randomizeDataTipText()
Returns the tip text for this property. |
java.lang.String |
rawOutputTipText()
Returns the tip text for this property. |
java.lang.String |
relationFindTipText()
Returns the tip text for this property. |
java.lang.String |
relationReplaceTipText()
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 |
setInstances(Instances instances)
Sets the dataset that results will be obtained for. |
void |
setOptions(java.lang.String[] options)
Parses a given list of options. |
void |
setOutputFile(java.io.File value)
Set the value of OutputFile. |
void |
setRandomizeData(boolean value)
Set to true if dataset is to be randomized. |
void |
setRawOutput(boolean value)
Set to true if raw split evaluator output is to be saved. |
void |
setRelationFind(java.lang.String value)
Sets the regular expression to use on the relation name. |
void |
setRelationReplace(java.lang.String value)
Sets the replacement string to use on the relation name. |
void |
setResultListener(ResultListener listener)
Sets the object to send results of each run to. |
void |
setSplitEvaluator(SplitEvaluator value)
Set the SplitEvaluator. |
void |
setTestsetDir(java.io.File value)
Sets the directory to use for the test sets. |
void |
setTestsetPrefix(java.lang.String value)
Sets the prefix to use for the test sets. |
void |
setTestsetSuffix(java.lang.String value)
Sets the suffix to use for the test sets. |
java.lang.String |
splitEvaluatorTipText()
Returns the tip text for this property. |
java.lang.String |
testsetDirTipText()
Returns the tip text for this property. |
java.lang.String |
testsetPrefixTipText()
Returns the tip text for this property. |
java.lang.String |
testsetSuffixTipText()
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 |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_SUFFIX
public static java.lang.String DATASET_FIELD_NAME
public static java.lang.String RUN_FIELD_NAME
public static java.lang.String TIMESTAMP_FIELD_NAME
Constructor Detail |
---|
public ExplicitTestsetResultProducer()
Method Detail |
---|
public java.lang.String globalInfo()
public java.util.Enumeration listOptions()
listOptions
in interface OptionHandler
public void setOptions(java.lang.String[] options) throws java.lang.Exception
-D Save raw split evaluator output.
-O <file/directory name/path> The filename where raw output will be stored. If a directory name is specified then then individual outputs will be gzipped, otherwise all output will be zipped to the named file. Use in conjuction with -D. (default: splitEvalutorOut.zip)
-W <class name> The full class name of a SplitEvaluator. eg: weka.experiment.ClassifierSplitEvaluator
-R Set when data is to be randomized.
-dir <directory> The directory containing the test sets. (default: current directory)
-prefix <string> An optional prefix for the test sets (before the relation name). (default: empty string)
-suffix <string> The suffix to append to the test set. (default: _test.arff)
-find <regular expression> The regular expression to search the relation name with. Not used if an empty string. (default: empty string)
-replace <string> The replacement string for the all the matches of '-find'. (default: empty string)
Options specific to split evaluator weka.experiment.ClassifierSplitEvaluator:
-W <class name> The full class name of the classifier. eg: weka.classifiers.bayes.NaiveBayes
-C <index> The index of the class for which IR statistics are to be output. (default 1)
-I <index> The index of an attribute to output in the results. This attribute should identify an instance in order to know which instances are in the test set of a cross validation. if 0 no output (default 0).
-P Add target and prediction columns to the result for each fold.
Options specific to classifier weka.classifiers.rules.ZeroR:
-D If set, classifier is run in debug mode and may output additional info to the consoleAll options after -- will be passed to the split evaluator.
setOptions
in interface OptionHandler
options
- the list of options as an array of strings
java.lang.Exception
- if an option is not supportedpublic java.lang.String[] getOptions()
getOptions
in interface OptionHandler
public void setInstances(Instances instances)
setInstances
in interface ResultProducer
instances
- a value of type 'Instances'.public void setAdditionalMeasures(java.lang.String[] additionalMeasures)
setAdditionalMeasures
in interface ResultProducer
additionalMeasures
- an array of measure names, null if nonepublic java.util.Enumeration enumerateMeasures()
enumerateMeasures
in interface AdditionalMeasureProducer
public double getMeasure(java.lang.String additionalMeasureName)
getMeasure
in interface AdditionalMeasureProducer
additionalMeasureName
- the name of the measure to query for its value
java.lang.IllegalArgumentException
- if the named measure is not supportedpublic void setResultListener(ResultListener listener)
setResultListener
in interface ResultProducer
listener
- a value of type 'ResultListener'public static java.lang.Double getTimestamp()
public void preProcess() throws java.lang.Exception
preProcess
in interface ResultProducer
java.lang.Exception
- if an error occurs during preprocessing.public void postProcess() throws java.lang.Exception
postProcess
in interface ResultProducer
java.lang.Exception
- if an error occurspublic void doRunKeys(int run) throws java.lang.Exception
doRunKeys
in interface ResultProducer
run
- the run number to get keys for.
java.lang.Exception
- if a problem occurs while getting the keyspublic void doRun(int run) throws java.lang.Exception
doRun
in interface ResultProducer
run
- the run number to get results for.
java.lang.Exception
- if a problem occurs while getting the resultspublic java.lang.String[] getKeyNames()
getKeyNames
in interface ResultProducer
public java.lang.Object[] getKeyTypes()
getKeyTypes
in interface ResultProducer
public java.lang.String[] getResultNames()
getResultNames
in interface ResultProducer
public java.lang.Object[] getResultTypes()
getResultTypes
in interface ResultProducer
public java.lang.String getCompatibilityState()
getCompatibilityState
in interface ResultProducer
public java.lang.String outputFileTipText()
public java.io.File getOutputFile()
public void setOutputFile(java.io.File value)
value
- Value to assign to OutputFile.public java.lang.String randomizeDataTipText()
public boolean getRandomizeData()
public void setRandomizeData(boolean value)
value
- true if dataset is to be randomizedpublic java.lang.String rawOutputTipText()
public boolean getRawOutput()
public void setRawOutput(boolean value)
value
- true if output is to be savedpublic java.lang.String splitEvaluatorTipText()
public SplitEvaluator getSplitEvaluator()
public void setSplitEvaluator(SplitEvaluator value)
value
- new SplitEvaluator to use.public java.lang.String testsetDirTipText()
public java.io.File getTestsetDir()
public void setTestsetDir(java.io.File value)
value
- the directory to usepublic java.lang.String testsetPrefixTipText()
public java.lang.String getTestsetPrefix()
public void setTestsetPrefix(java.lang.String value)
value
- the prefixpublic java.lang.String testsetSuffixTipText()
public java.lang.String getTestsetSuffix()
public void setTestsetSuffix(java.lang.String value)
value
- the suffixpublic java.lang.String relationFindTipText()
public java.lang.String getRelationFind()
public void setRelationFind(java.lang.String value)
value
- the regular expressionpublic java.lang.String relationReplaceTipText()
public java.lang.String getRelationReplace()
public void setRelationReplace(java.lang.String value)
value
- the regular expressionpublic java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getRevision()
getRevision
in interface RevisionHandler
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |