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

Interface weka.experiment.SplitEvaluator


public interface SplitEvaluator
extends java.io.Serializable
Interface to objects able to generate a fixed set of results for a particular split of a dataset. The set of results should contain fields related to any settings of the SplitEvaluator (not including the dataset name. For example, one field for the classifier used to get the results, another for the classifier options, etc).

Possible implementations of SplitEvaluator:

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

Method Index

 o getKey()
Gets the key describing the current SplitEvaluator.
 o getKeyNames()
Gets the names of each of the key columns produced for a single run.
 o getKeyTypes()
Gets the data types of each of the key columns produced for a single run.
 o getRawResultOutput()
Returns the raw output for the most recent call to getResult.
 o getResult(Instances, Instances)
Gets the results for the supplied train and test datasets.
 o getResultNames()
Gets the names of each of the result columns produced for a single run.
 o getResultTypes()
Gets the data types of each of the result columns produced for a single run.
 o setAdditionalMeasures(String[])
Sets a list of method names for additional measures to look for in SplitEvaluators.

Method Detail

 o setAdditionalMeasures
public void setAdditionalMeasures(java.lang.String additionalMeasures[])
          Sets a list of method names for additional measures to look for in SplitEvaluators.
Parameters:
additionalMeasures - a list of method names
 o getKeyNames
public java.lang.String[] getKeyNames()
          Gets the names of each of the key columns produced for a single run. The names should not contain spaces (use '_' instead for easy translation.) The number of key fields must be constant for a given SplitEvaluator.
Returns:
an array containing the name of each key column
 o getKeyTypes
public java.lang.Object[] getKeyTypes()
          Gets the data types of each of the key columns produced for a single run. The number of key fields must be constant for a given SplitEvaluator.
Returns:
an array containing objects of the type of each key column. The objects should be Strings, or Doubles.
 o getResultNames
public java.lang.String[] getResultNames()
          Gets the names of each of the result columns produced for a single run. The names should not contain spaces (use '_' instead for easy translation.) The number of result fields must be constant for a given SplitEvaluator.
Returns:
an array containing the name of each result column
 o getResultTypes
public java.lang.Object[] getResultTypes()
          Gets the data types of each of the result columns produced for a single run. The number of result fields must be constant for a given SplitEvaluator.
Returns:
an array containing objects of the type of each result column. The objects should be Strings, or Doubles.
 o getKey
public java.lang.Object[] getKey()
          Gets the key describing the current SplitEvaluator. For example This may contain the name of the classifier used for classifier predictive evaluation. The number of key fields must be constant for a given SplitEvaluator.
Returns:
a value of type 'Object'
 o getResult
public java.lang.Object[] getResult(Instances train,
                          Instances test) throws java.lang.Exception
          Gets the results for the supplied train and test datasets.
Parameters:
train - the training Instances.
test - the testing Instances.
Returns:
the results stored in an array. The objects stored in the array may be Strings, Doubles, or null (for the missing value).
Throws:
java.lang.Exception - if a problem occurs while getting the results
 o getRawResultOutput
public java.lang.String getRawResultOutput()
          Returns the raw output for the most recent call to getResult. Useful for debugging splitEvaluators.
Returns:
the raw output corresponding to the most recent call to getResut

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