edu.udo.cs.yale.operator.validation
Class WrapperValidationChain

java.lang.Object
  edu.udo.cs.yale.operator.Operator
      edu.udo.cs.yale.operator.OperatorChain
          edu.udo.cs.yale.operator.validation.WrapperValidationChain

All Implemented Interfaces:

ConfigurationListener

Direct Known Subclasses:

RandomSplitWrapperValidationChain, WrapperXValidation

public abstract class WrapperValidationChain
extends OperatorChain

This operator evaluates the performance of feature weighting algorithms including feature selection. The first inner operator is the algorithm to be evaluated itself. It must return an attribute weights vector which is applied on the data. The second operator is used to create a new model and a performance vector is retrieved using the third inner operator. This performance vector serves as a performance indicator for the actual algorithm.

Version:

$Id: WrapperValidationChain.java,v 1.10 2006/03/21 15:35:52 ingomierswa Exp $

Author:

Ingo Mierswa

Field Summary

private static java.lang.Class[]	INPUT_CLASSES
private PerformanceCriterion	lastPerformance
private IOContainer	learnResult
private IOContainer	methodResult
private static java.lang.Class[]	OUTPUT_CLASSES

Constructor Summary

WrapperValidationChain(OperatorDescription description)

Method Summary

(package private) IOContainer	evaluate(ExampleSet testSet) Applies the applier and evaluator.
private Operator	getEvaluator()
InnerOperatorCondition	getInnerOperatorCondition() Must return a condition of the IO behaviour of all desired inner operators.
java.lang.Class[]	getInputClasses() Returns the classes that are needed as input.
private Operator	getLearner()
int	getMaxNumberOfInnerOperators() Returns the maximum number of innner operators.
private Operator	getMethod()
int	getMinNumberOfInnerOperators() Returns the minimum number of innner operators.
int	getNumberOfSteps() Returns the number of steps performed by this chain.
abstract int	getNumberOfValidationSteps()
java.lang.Class[]	getOutputClasses() Returns the classes that are guaranteed to be returned by apply() as additional output.
(package private) IOContainer	learn(ExampleSet trainingSet) Applies the learner.
(package private) void	setResult(PerformanceCriterion pc) Can be used by subclasses to set the performance of the example set.
(package private) IOContainer	useMethod(ExampleSet methodTrainingSet) Applies the method.

Methods inherited from class edu.udo.cs.yale.operator.OperatorChain

addAddListener, addOperator, addOperator, apply, checkDeprecations, checkIO, checkNumberOfInnerOperators, checkProperties, clearErrorList, clearStepCounter, cloneOperator, countStep, createExperimentTree, delete, experimentFinished, experimentStarts, getAllInnerOperators, getCurrentStep, getIndexOfOperator, getInnerOperatorForName, getInnerOperatorsXML, getNumberOfAllOperators, getNumberOfChildrensSteps, getNumberOfOperators, getOperator, getOperatorFromAll, getOperators, isEnabled, performAdditionalChecks, removeAddListener, removeOperator, setEnabled, setExperiment, shouldReturnInnerOutput

Methods inherited from class edu.udo.cs.yale.operator.Operator

addError, addValue, addWarning, apply, createExperimentTree, createFromXML, createMarkedExperimentTree, getAddOnlyAdditionalOutput, getApplyCount, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getErrorList, getExperiment, getInput, getInput, getInput, getInputDescription, getIOContainerForInApplyLoopBreakpoint, getName, getOperatorClassName, getOperatorDescription, getParameter, getParameterAsBoolean, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsInt, getParameterAsString, getParameterList, getParameters, getParameterType, getParameterTypes, getParent, getStartTime, getStatus, getUserDescription, getValue, getValues, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isParameterSet, logMessage, register, remove, rename, resume, setBreakpoint, setInput, setListParameter, setOperatorParameters, setParameter, setParameters, setParent, setUserDescription, toString, writeXML

Methods inherited from class java.lang.Object

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

Field Detail

OUTPUT_CLASSES

private static final java.lang.Class[] OUTPUT_CLASSES

INPUT_CLASSES

private static final java.lang.Class[] INPUT_CLASSES

lastPerformance

private PerformanceCriterion lastPerformance

learnResult

private IOContainer learnResult

methodResult

private IOContainer methodResult

Constructor Detail

WrapperValidationChain

public WrapperValidationChain(OperatorDescription description)

Method Detail

getMaxNumberOfInnerOperators

public int getMaxNumberOfInnerOperators()

Returns the maximum number of innner operators.

Specified by:

getMaxNumberOfInnerOperators in class OperatorChain

getMinNumberOfInnerOperators

public int getMinNumberOfInnerOperators()

Returns the minimum number of innner operators.

Specified by:

getMinNumberOfInnerOperators in class OperatorChain

getOutputClasses

public java.lang.Class[] getOutputClasses()

Description copied from class: Operator

Returns the classes that are guaranteed to be returned by apply() as additional output. Please note that input object which should not be consumed must also be defined by this method (e.g. for preprocessing operators). The default behavior for input consumation is defined by Operator.getInputDescription(Class) and can be changed by overwriting this method. Objects which are not consumed must not be defined as additional output in this method. May be null or an empy array (no additional output is produced).

Specified by:

getOutputClasses in class Operator

getInputClasses

public java.lang.Class[] getInputClasses()

Description copied from class: Operator

Returns the classes that are needed as input. May be null or an empty (no desired input). As default, all delivered input objects are consumed and must be also delivered as output in both Operator.getOutputClasses() and Operator.apply() if this is necessary. This default behavior can be changed by overriding Operator.getInputDescription(Class). Subclasses which implement this method should not make use of parameters since this method is invoked by getParameterTypes(). Therefore, parameters are not fully available at this point of time and this might lead to exceptions. Please use InputDescriptions instead.

Specified by:

getInputClasses in class Operator

getInnerOperatorCondition

public InnerOperatorCondition getInnerOperatorCondition()

Description copied from class: OperatorChain

Must return a condition of the IO behaviour of all desired inner operators. If there are no "special" conditions and the chain works similar to a simple operator chain this method should at least return a SimpleChainInnerOperatorCondition. More than one condition should be combined with help of the class CombinedInnerOperatorCondition.

Specified by:

getInnerOperatorCondition in class OperatorChain

getMethod

private Operator getMethod()

getLearner

private Operator getLearner()

getEvaluator

private Operator getEvaluator()

setResult

void setResult(PerformanceCriterion pc)

Can be used by subclasses to set the performance of the example set. Will be used for plotting only.

useMethod

IOContainer useMethod(ExampleSet methodTrainingSet)
                throws OperatorException

Applies the method.

Throws:

OperatorException

learn

IOContainer learn(ExampleSet trainingSet)
            throws OperatorException

Applies the learner.

Throws:

OperatorException

evaluate

IOContainer evaluate(ExampleSet testSet)
               throws OperatorException

Applies the applier and evaluator.

Throws:

OperatorException

getNumberOfValidationSteps

public abstract int getNumberOfValidationSteps()

getNumberOfSteps

public int getNumberOfSteps()

Description copied from class: OperatorChain

Returns the number of steps performed by this chain.

Specified by:

getNumberOfSteps in class OperatorChain