Package adams.gui.tools.wekamultiexperimenter.experiment

Class CrossValidationExperiment

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.tools.wekamultiexperimenter.experiment.AbstractExperiment

adams.gui.tools.wekamultiexperimenter.experiment.CrossValidationExperiment

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Stoppable, StoppableWithFeedback, SpreadSheetSupporter, ExperimentWithCustomizableRelationNames, ResettableExperiment, Serializable

public class CrossValidationExperiment
extends AbstractExperiment

Performs cross-validation. If only one dataset and one classifier specified, cross-validation is multi-threaded (in case experiment is multi-threaded).

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CrossValidationExperiment.CrossValidationExperimentJob	Performs cross-validation on the classifier/data combination.

Nested classes/interfaces inherited from class adams.gui.tools.wekamultiexperimenter.experiment.AbstractExperiment

AbstractExperiment.AbstractExperimentJob<T extends AbstractExperiment>

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_Folds	the number of folds.
protected CrossValidationFoldGenerator	m_Generator	the fold generator.

Fields inherited from class adams.gui.tools.wekamultiexperimenter.experiment.AbstractExperiment

m_ActualJobRunner, m_ClassAttribute, m_Classifiers, m_ClassLabelIndex, m_CommandLineHandler, m_Datasets, m_Generated, m_JobCounter, m_JobRunner, m_JobTotal, m_Notes, m_PrefixDatasetsWithIndex, m_ResetResults, m_Results, m_ResultsHandler, m_Running, m_Runs, m_StatusMessageHandler, m_Stopped, m_UseFilename

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
CrossValidationExperiment()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected CrossValidationExperiment.CrossValidationExperimentJob	evaluate(int currentRun, weka.classifiers.Classifier cls, weka.core.Instances data)	Evaluates the classifier on the dataset.
String	foldsTipText()	Returns the tip text for this property.
String	generatorTipText()	Returns the tip text for this property.
int	getFolds()	Returns the number of folds.
CrossValidationFoldGenerator	getGenerator()	Returns the scheme for generating the folds.
String	globalInfo()	Returns a string describing the object.
protected boolean	isComplete(int[] rows)	Checks whether the number of rows located in the current results are complete.
void	setFolds(int value)	Sets the number of folds.
void	setGenerator(CrossValidationFoldGenerator value)	Sets the scheme for generating the folds.

Methods inherited from class adams.gui.tools.wekamultiexperimenter.experiment.AbstractExperiment

addClassifier, addDataset, appendResults, classAttributeTipText, classifiersTipText, classLabelIndexTipText, clearProgress, configureRowFinder, datasetsTipText, doExecute, execute, getClassAttribute, getClassifiers, getClassLabelIndex, getDatasets, getJobRunner, getNotes, getPrefixDatasetsWithIndex, getResetResults, getResultsHandler, getRuns, getStatusMessageHandler, getUseFilename, incProgress, initExecute, initProgress, initResults, isRequired, isStopped, jobRunnerTipText, loadDataset, log, log, notesTipText, postExecute, preExecute, prefixDatasetsWithIndexTipText, removeIncomplete, resetResultsTipText, resultWriterTipText, runsTipText, setClassAttribute, setClassifiers, setClassLabelIndex, setDatasets, setJobRunner, setNotes, setPrefixDatasetsWithIndex, setResetResults, setResultsHandler, setRuns, setStatusMessageHandler, setUseFilename, shortenCommandLine, showProgress, stopExecution, toInstances, toSpreadSheet, useFilenameTipText

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Folds

protected int m_Folds

the number of folds.

m_Generator

protected CrossValidationFoldGenerator m_Generator

the fold generator.

Constructor Detail

CrossValidationExperiment

public CrossValidationExperiment()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractExperiment

setFolds

public void setFolds(int value)

Sets the number of folds.

Parameters:

value - the folds

getFolds

public int getFolds()

Returns the number of folds.

Returns:

the folds

foldsTipText

public String foldsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setGenerator

public void setGenerator(CrossValidationFoldGenerator value)

Sets the scheme for generating the folds.

Parameters:

value - the generator

getGenerator

public CrossValidationFoldGenerator getGenerator()

Returns the scheme for generating the folds.

Returns:

the generator

generatorTipText

public String generatorTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

isComplete

protected boolean isComplete(int[] rows)

Checks whether the number of rows located in the current results are complete.

Overrides:

isComplete in class AbstractExperiment

Parameters:

rows - the located results

Returns:

true if complete

evaluate

protected CrossValidationExperiment.CrossValidationExperimentJob evaluate(int currentRun,
                                                                          weka.classifiers.Classifier cls,
                                                                          weka.core.Instances data)

Evaluates the classifier on the dataset.

Specified by:

evaluate in class AbstractExperiment

Parameters:

currentRun - the current run

cls - the classifier to evaluate

data - the dataset to evaluate on

Returns:

null if successful, otherwise error message