CrossValidation (meka 1.9.1 API)

java.lang.Object
- meka.events.LogObject
- - meka.experiment.evaluators.AbstractEvaluator
  - - meka.experiment.evaluators.CrossValidation

All Implemented Interfaces:

Serializable, ThreadLimiter, LogSupporter, Evaluator, weka.core.OptionHandler, weka.core.Randomizable
```
public class CrossValidation
extends AbstractEvaluator
implements weka.core.Randomizable, ThreadLimiter
```
Evaluates the classifier using cross-validation. Order can be preserved.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_FOLD` the key for the fold.
`protected int`	`m_ActualNumThreads` the actual number of threads to use.
`protected ExecutorService`	`m_Executor` the executor service to use for parallel execution.
`protected int`	`m_NumFolds` the number of folds.
`protected int`	`m_NumThreads` the number of threads to use for parallel execution.
`protected boolean`	`m_PreserveOrder` whether to preserve the order.
`protected int`	`m_Seed` the seed value.
`protected String`	`m_Threshold` the threshold option.
`protected String`	`m_Verbosity` the verbosity option.

Fields inherited from class meka.experiment.evaluators.AbstractEvaluator
m_Stopped

Fields inherited from class meka.events.LogObject
m_Debug, m_LogListeners

Constructor Summary

Constructors
Constructor and Description

CrossValidation()

Constructors
Constructor and Description
`CrossValidation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<EvaluationStatistics>`	`evaluate(MultiLabelClassifier classifier, weka.core.Instances dataset)` Returns the evaluation statistics generated for the dataset.
`protected List<EvaluationStatistics>`	`evaluateParallel(MultiLabelClassifier classifier, weka.core.Instances dataset)` Returns the evaluation statistics generated for the dataset (parallel execution).
`protected List<EvaluationStatistics>`	`evaluateSequential(MultiLabelClassifier classifier, weka.core.Instances dataset)` Returns the evaluation statistics generated for the dataset (sequential execution).
`protected int`	`getDefaultNumFolds()` Gets the number of folds.
`protected int`	`getDefaultNumThreads()` Returns the default number of threads to use.
`protected int`	`getDefaultSeed()` Gets the default seed for the random number generations
`protected String`	`getDefaultThreshold()` Gets the default threshold option.
`protected String`	`getDefaultVerbosity()` Gets the default threshold option.
`int`	`getNumFolds()` Gets the number of folds
`int`	`getNumThreads()` Returns the number of threads to use.
`String[]`	`getOptions()` Returns the options.
`boolean`	`getPreserveOrder()` Returns whether to preserve the order instead of randomizing the data.
`int`	`getSeed()` Gets the seed for the random number generations
`String`	`getThreshold()` Gets the threshold option.
`String`	`getVerbosity()` Gets the verbosity option.
`String`	`globalInfo()` Description to be displayed in the GUI.
`Enumeration<weka.core.Option>`	`listOptions()` Returns an enumeration of all the available options..
`String`	`numFoldsTipText()` Describes this property.
`String`	`numThreadsTipText()` Returns the tip text for this property.
`String`	`preserveOrderTipText()` Describes this property.
`String`	`seedTipText()` Describes this property.
`void`	`setNumFolds(int value)` Set the number of folds.
`void`	`setNumThreads(int value)` Sets the number of threads to use.
`void`	`setOptions(String[] options)` Sets the options.
`void`	`setPreserveOrder(boolean value)` Sets whether to preserve the order instead of randomizing the data.
`void`	`setSeed(int value)` Set the seed for random number generation.
`void`	`setThreshold(String value)` Set the threshold option.
`void`	`setVerbosity(String value)` Set the verbosity option.
`void`	`stop()` Stops the evaluation, if possible.
`String`	`thresholdTipText()` Describes this property.
`String`	`verbosityTipText()` Describes this property.

Methods inherited from class meka.experiment.evaluators.AbstractEvaluator
initialize

Methods inherited from class meka.events.LogObject
addLogListener, debug, getLogListeners, handleException, log, removeLogListener

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface meka.events.LogSupporter
addLogListener, log, removeLogListener

- Field Detail
  - KEY_FOLD
```
public static final String KEY_FOLD
```
    the key for the fold.
    
    See Also:
    
    Constant Field Values
  - m_NumFolds
```
protected int m_NumFolds
```
    the number of folds.
  - m_PreserveOrder
```
protected boolean m_PreserveOrder
```
    whether to preserve the order.
  - m_Seed
```
protected int m_Seed
```
    the seed value.
  - m_NumThreads
```
protected int m_NumThreads
```
    the number of threads to use for parallel execution.
  - m_ActualNumThreads
```
protected int m_ActualNumThreads
```
    the actual number of threads to use.
  - m_Executor
```
protected transient ExecutorService m_Executor
```
    the executor service to use for parallel execution.
  - m_Threshold
```
protected String m_Threshold
```
    the threshold option.
  - m_Verbosity
```
protected String m_Verbosity
```
    the verbosity option.
- Constructor Detail
  - CrossValidation
```
public CrossValidation()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Description to be displayed in the GUI.
    
    Specified by:
    
    globalInfo in class AbstractEvaluator
    
    Returns:
    
    the description
  - getDefaultNumFolds
```
protected int getDefaultNumFolds()
```
    Gets the number of folds.
    
    Returns:
    
    the defaut
  - setNumFolds
```
public void setNumFolds(int value)
```
    Set the number of folds.
    
    Parameters:
    
    value - the folds (>= 2)
  - getNumFolds
```
public int getNumFolds()
```
    Gets the number of folds
    
    Returns:
    
    the folds (>= 2)
  - numFoldsTipText
```
public String numFoldsTipText()
```
    Describes this property.
    
    Returns:
    
    the description
  - setPreserveOrder
```
public void setPreserveOrder(boolean value)
```
    Sets whether to preserve the order instead of randomizing the data.
    
    Parameters:
    
    value - true if to preserve the order
  - getPreserveOrder
```
public boolean getPreserveOrder()
```
    Returns whether to preserve the order instead of randomizing the data.
    
    Returns:
    
    true if to preserve the order
  - preserveOrderTipText
```
public String preserveOrderTipText()
```
    Describes this property.
    
    Returns:
    
    the description
  - getDefaultSeed
```
protected int getDefaultSeed()
```
    Gets the default seed for the random number generations
    
    Returns:
    
    the default
  - setSeed
```
public void setSeed(int value)
```
    Set the seed for random number generation.
    
    Specified by:
    
    setSeed in interface weka.core.Randomizable
    
    Parameters:
    
    value - the seed
  - getSeed
```
public int getSeed()
```
    Gets the seed for the random number generations
    
    Specified by:
    
    getSeed in interface weka.core.Randomizable
    
    Returns:
    
    the seed for the random number generation
  - seedTipText
```
public String seedTipText()
```
    Describes this property.
    
    Returns:
    
    the description
  - getDefaultNumThreads
```
protected int getDefaultNumThreads()
```
    Returns the default number of threads to use.
    
    Returns:
    
    the number of threads: -1 = # of CPUs/cores; 0/1 = sequential execution
  - setNumThreads
```
public void setNumThreads(int value)
```
    Sets the number of threads to use.
    
    Specified by:
    
    setNumThreads in interface ThreadLimiter
    
    Parameters:
    
    value - the number of threads: -1 = # of CPUs/cores; 0/1 = sequential execution
  - getNumThreads
```
public int getNumThreads()
```
    Returns the number of threads to use.
    
    Specified by:
    
    getNumThreads in interface ThreadLimiter
    
    Returns:
    
    the number of threads: -1 = # of CPUs/cores; 0/1 = sequential execution
  - numThreadsTipText
```
public String numThreadsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - getDefaultThreshold
```
protected String getDefaultThreshold()
```
    Gets the default threshold option.
    
    Returns:
    
    the defaut
  - setThreshold
```
public void setThreshold(String value)
```
    Set the threshold option.
    
    Parameters:
    
    value - the option
  - getThreshold
```
public String getThreshold()
```
    Gets the threshold option.
    
    Returns:
    
    the option
  - thresholdTipText
```
public String thresholdTipText()
```
    Describes this property.
    
    Returns:
    
    the description
  - getDefaultVerbosity
```
protected String getDefaultVerbosity()
```
    Gets the default threshold option.
    
    Returns:
    
    the defaut
  - setVerbosity
```
public void setVerbosity(String value)
```
    Set the verbosity option.
    
    Parameters:
    
    value - the option
  - getVerbosity
```
public String getVerbosity()
```
    Gets the verbosity option.
    
    Returns:
    
    the option
  - verbosityTipText
```
public String verbosityTipText()
```
    Describes this property.
    
    Returns:
    
    the description
  - listOptions
```
public Enumeration<weka.core.Option> listOptions()
```
    Returns an enumeration of all the available options..
    
    Specified by:
    
    listOptions in interface weka.core.OptionHandler
    
    Overrides:
    
    listOptions in class AbstractEvaluator
    
    Returns:
    
    an enumeration of all available options.
  - setOptions
```
public void setOptions(String[] options)
                throws Exception
```
    Sets the options.
    
    Specified by:
    
    setOptions in interface weka.core.OptionHandler
    
    Overrides:
    
    setOptions in class AbstractEvaluator
    
    Parameters:
    
    options - the options to parse
    
    Throws:
    
    Exception - if parsing fails
  - getOptions
```
public String[] getOptions()
```
    Returns the options.
    
    Specified by:
    
    getOptions in interface weka.core.OptionHandler
    
    Overrides:
    
    getOptions in class AbstractEvaluator
    
    Returns:
    
    the current options
  - evaluateSequential
```
protected List<EvaluationStatistics> evaluateSequential(MultiLabelClassifier classifier,
                                                        weka.core.Instances dataset)
```
    Returns the evaluation statistics generated for the dataset (sequential execution).
    
    Parameters:
    
    classifier - the classifier to evaluate
    
    dataset - the dataset to evaluate on
    
    Returns:
    
    the statistics
  - evaluateParallel
```
protected List<EvaluationStatistics> evaluateParallel(MultiLabelClassifier classifier,
                                                      weka.core.Instances dataset)
```
    Returns the evaluation statistics generated for the dataset (parallel execution).
    
    Parameters:
    
    classifier - the classifier to evaluate
    
    dataset - the dataset to evaluate on
    
    Returns:
    
    the statistics
  - evaluate
```
public List<EvaluationStatistics> evaluate(MultiLabelClassifier classifier,
                                           weka.core.Instances dataset)
```
    Returns the evaluation statistics generated for the dataset.
    
    Specified by:
    
    evaluate in interface Evaluator
    
    Parameters:
    
    classifier - the classifier to evaluate
    
    dataset - the dataset to evaluate on
    
    Returns:
    
    the statistics
  - stop
```
public void stop()
```
    Stops the evaluation, if possible.
    
    Specified by:
    
    stop in interface Evaluator
    
    Overrides:
    
    stop in class AbstractEvaluator

Class CrossValidation

Field Summary

Fields inherited from class meka.experiment.evaluators.AbstractEvaluator

Fields inherited from class meka.events.LogObject

Constructor Summary

Method Summary

Methods inherited from class meka.experiment.evaluators.AbstractEvaluator

Methods inherited from class meka.events.LogObject

Methods inherited from class java.lang.Object

Methods inherited from interface meka.events.LogSupporter

Field Detail

KEY_FOLD

m_NumFolds

m_PreserveOrder

m_Seed

m_NumThreads

m_ActualNumThreads

m_Executor

m_Threshold

m_Verbosity

Constructor Detail

CrossValidation

Method Detail

globalInfo

getDefaultNumFolds

setNumFolds

getNumFolds

numFoldsTipText

setPreserveOrder

getPreserveOrder

preserveOrderTipText

getDefaultSeed

setSeed

getSeed

seedTipText

getDefaultNumThreads

setNumThreads

getNumThreads

numThreadsTipText

getDefaultThreshold

setThreshold

getThreshold

thresholdTipText

getDefaultVerbosity

setVerbosity

getVerbosity

verbosityTipText

listOptions

setOptions

getOptions

evaluateSequential

evaluateParallel

evaluate

stop