Package adams.gui.tools.wekainvestigator.tab.classifytab.evaluation

Class TrainValidateTestSet

java.lang.Object

adams.core.logging.LoggingObject

adams.gui.tools.wekainvestigator.evaluation.AbstractEvaluation<ClassifyTab,ResultItem>

adams.gui.tools.wekainvestigator.tab.classifytab.evaluation.AbstractClassifierEvaluation

adams.gui.tools.wekainvestigator.tab.classifytab.evaluation.TrainValidateTestSet

All Implemented Interfaces:

adams.core.GlobalInfoSupporter, adams.core.logging.LoggingSupporter, adams.core.SizeOfHandler, adams.core.StatusMessageHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, Serializable

public class TrainValidateTestSet
extends AbstractClassifierEvaluation
implements adams.core.StoppableWithFeedback

Uses dedicated train/validate/test sets.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY_ADDITIONAL
static String	KEY_DISCARDPREDICTIONS
static String	KEY_TEST
static String	KEY_TRAIN
static String	KEY_VALIDATE
protected adams.gui.core.BaseCheckBox	m_CheckBoxDiscardPredictions	whether to discard the predictions.
protected adams.gui.core.BaseComboBox<String>	m_ComboBoxTest	the test set.
protected adams.gui.core.BaseComboBox<String>	m_ComboBoxTrain	the train set.
protected adams.gui.core.BaseComboBox<String>	m_ComboBoxValidate	the validate set.
protected StoppableEvaluation	m_Evaluation	the current evaluation.
protected weka.classifiers.Classifier	m_Model	the current model.
protected DefaultComboBoxModel<String>	m_ModelDatasets	the datasets model.
protected adams.gui.core.ParameterPanel	m_PanelParameters	the panel with the parameters.
protected adams.gui.chooser.SelectOptionPanel	m_SelectAdditionalAttributes	the additional attributes to store.
protected boolean	m_Stopped	whether the build was stopped.

Fields inherited from class adams.gui.tools.wekainvestigator.evaluation.AbstractEvaluation

m_Owner, m_PanelOptions

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
TrainValidateTestSet()

Method Summary

Modifier and Type	Method	Description
void	activate(int index)	Activates the specified dataset.
String	canEvaluate(weka.classifiers.Classifier classifier)	Tests whether the classifier can be evaluated.
void	deserialize(Map<String,Object> data, adams.core.MessageCollection errors)	Restores the objects.
protected void	doEvaluate(weka.classifiers.Classifier classifier, ResultItem item)	Evaluates the classifier and updates the result item.
String	getName()	Returns the name of the evaluation (displayed in combobox).
String	globalInfo()	Returns a string describing the object.
ResultItem	init(weka.classifiers.Classifier classifier)	Initializes the result item.
protected void	initGUI()	Initializes the widgets.
boolean	isStopped()	Whether the execution has been stopped.
Map<String,Object>	serialize(Set<AbstractInvestigatorTab.SerializationOption> options)	Returns the objects for serialization.
void	stopExecution()	Stops the execution.
void	update()	Updates the settings panel.

Methods inherited from class adams.gui.tools.wekainvestigator.tab.classifytab.evaluation.AbstractClassifierEvaluation

evaluate, fillWithAttributeNames, getEvaluations, transferAdditionalAttributes

Methods inherited from class adams.gui.tools.wekainvestigator.evaluation.AbstractEvaluation

addObjectSize, addToHistory, getOwner, getPanel, getProperties, getTestingUpdateInterval, initialize, isValidDataIndex, listOrArray, setOwner, showStatus, 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

Field Detail

KEY_TRAIN

public static final String KEY_TRAIN

See Also:

Constant Field Values

KEY_VALIDATE

public static final String KEY_VALIDATE

See Also:

Constant Field Values

KEY_TEST

public static final String KEY_TEST

See Also:

Constant Field Values

KEY_ADDITIONAL

public static final String KEY_ADDITIONAL

See Also:

Constant Field Values

KEY_DISCARDPREDICTIONS

public static final String KEY_DISCARDPREDICTIONS

See Also:

Constant Field Values

m_PanelParameters

protected adams.gui.core.ParameterPanel m_PanelParameters

the panel with the parameters.

m_ComboBoxTrain

protected adams.gui.core.BaseComboBox<String> m_ComboBoxTrain

the train set.

m_ComboBoxValidate

protected adams.gui.core.BaseComboBox<String> m_ComboBoxValidate

the validate set.

m_ComboBoxTest

protected adams.gui.core.BaseComboBox<String> m_ComboBoxTest

the test set.

m_ModelDatasets

protected DefaultComboBoxModel<String> m_ModelDatasets

the datasets model.

m_SelectAdditionalAttributes

protected adams.gui.chooser.SelectOptionPanel m_SelectAdditionalAttributes

the additional attributes to store.

m_CheckBoxDiscardPredictions

protected adams.gui.core.BaseCheckBox m_CheckBoxDiscardPredictions

whether to discard the predictions.

m_Model

protected transient weka.classifiers.Classifier m_Model

the current model.

m_Evaluation

protected transient StoppableEvaluation m_Evaluation

the current evaluation.

m_Stopped

protected boolean m_Stopped

whether the build was stopped.

Constructor Detail

TrainValidateTestSet

public TrainValidateTestSet()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Returns:

a description suitable for displaying in the gui

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class AbstractEvaluation<ClassifyTab,ResultItem>

getName

public String getName()

Returns the name of the evaluation (displayed in combobox).

Specified by:

getName in class AbstractEvaluation<ClassifyTab,ResultItem>

Returns:

the name

canEvaluate

public String canEvaluate(weka.classifiers.Classifier classifier)

Tests whether the classifier can be evaluated.

Specified by:

canEvaluate in class AbstractClassifierEvaluation

Returns:

null if successful, otherwise error message

init

public ResultItem init(weka.classifiers.Classifier classifier)
                throws Exception

Initializes the result item.

Specified by:

init in class AbstractClassifierEvaluation

Parameters:

classifier - the current classifier

Returns:

the initialized history item

Throws:

Exception - if initialization fails

doEvaluate

protected void doEvaluate(weka.classifiers.Classifier classifier,
                          ResultItem item)
                   throws Exception

Evaluates the classifier and updates the result item.

Specified by:

doEvaluate in class AbstractClassifierEvaluation

Parameters:

classifier - the current classifier

item - the item to update

Throws:

Exception - if evaluation fails

update

public void update()

Updates the settings panel.

Specified by:

update in class AbstractEvaluation<ClassifyTab,ResultItem>

activate

public void activate(int index)

Activates the specified dataset.

Specified by:

activate in class AbstractEvaluation<ClassifyTab,ResultItem>

Parameters:

index - the index of the dataset

stopExecution

public void stopExecution()

Stops the execution.

Specified by:

stopExecution in interface adams.core.Stoppable

isStopped

public boolean isStopped()

Whether the execution has been stopped.

Specified by:

isStopped in interface adams.core.StoppableWithFeedback

Returns:

true if stopped

serialize

public Map<String,Object> serialize(Set<AbstractInvestigatorTab.SerializationOption> options)

Returns the objects for serialization.

Overrides:

serialize in class AbstractEvaluation<ClassifyTab,ResultItem>

Parameters:

options - what to serialize

Returns:

the mapping of the objects to serialize

deserialize

public void deserialize(Map<String,Object> data,
                        adams.core.MessageCollection errors)

Restores the objects.

Overrides:

deserialize in class AbstractEvaluation<ClassifyTab,ResultItem>

Parameters:

data - the data to restore

errors - for storing errors