edu.udo.cs.yale.operator.meta
Class XVPrediction

java.lang.Object
  edu.udo.cs.yale.operator.Operator
      edu.udo.cs.yale.operator.OperatorChain
          edu.udo.cs.yale.operator.meta.XVPrediction

All Implemented Interfaces:

ConfigurationListener

public class XVPrediction
extends OperatorChain

Operator chain that splits an ExampleSet into a training and test sets similar to XValidation, but returns the test set predictions instead of a performance vector. The inner two operators must be a learner returning a Model and an operator or operator chain that can apply this model (usually a model applier)

Version:

$Id: XVPrediction.java,v 1.12 2006/10/01 12:09:23 ingomierswa Exp $

Author:

Stefan Rueping

Field Summary

private static java.lang.Class[]	INPUT_CLASSES
private int	iteration
private int	number
private static java.lang.Class[]	OUTPUT_CLASSES

Constructor Summary

XVPrediction(OperatorDescription description)

Method Summary

IOObject[]	apply() Applies all inner operators.
private Operator	getApplier() Returns the second encapsulated inner operator (or operator chain), i.e.
InnerOperatorCondition	getInnerOperatorCondition() Must return a condition of the IO behaviour of all desired inner operators.
java.lang.Class[]	getInputClasses() returns the the classes this operator provides as output.
private Operator	getLearner() Returns the first encapsulated inner operator (or operator chain), i.e.
int	getMaxNumberOfInnerOperators() Returns the maximum number of innner operators.
int	getMinNumberOfInnerOperators() Returns the minimum number of innner operators.
int	getNumberOfSteps() Returns getNumberOfValidationSteps() * getNumberOfChildrensSteps() + 1.
int	getNumberOfValidationSteps()
java.lang.Class[]	getOutputClasses() returns the the classes this operator expects as input.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.

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

addAddListener, addOperator, addOperator, 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, 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

INPUT_CLASSES

private static final java.lang.Class[] INPUT_CLASSES

OUTPUT_CLASSES

private static final java.lang.Class[] OUTPUT_CLASSES

number

private int number

iteration

private int iteration

Constructor Detail

XVPrediction

public XVPrediction(OperatorDescription description)

Method Detail

getNumberOfValidationSteps

public int getNumberOfValidationSteps()

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

getInputClasses

public java.lang.Class[] getInputClasses()

returns the the classes this operator provides as output.

Specified by:

getInputClasses in class Operator

getOutputClasses

public java.lang.Class[] getOutputClasses()

returns the the classes this operator expects as input.

Specified by:

getOutputClasses 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

getLearner

private Operator getLearner()

Returns the first encapsulated inner operator (or operator chain), i.e. the learning operator (chain).

getApplier

private Operator getApplier()

Returns the second encapsulated inner operator (or operator chain), i.e. the application and evaluation operator (chain)

apply

public IOObject[] apply()
                 throws OperatorException

Description copied from class: OperatorChain

Applies all inner operators. The input to this operator becomes the input of the first inner operator. The latter's output is passed to the second inner operator and so on. Note to subclassers: If subclasses (for example wrappers) want to make use of this method remember to call exactly this method (super.apply()) and do not call super.apply(IOContainer) erroneously which will result in an infinite loop. Subclasses who override this method without invoking super.apply() should at least invoke the method OperatorChain.clearStepCounter().

Overrides:

apply in class OperatorChain

Returns:

the last inner operator's output or the input itself if the chain is empty.

Throws:

OperatorException

getNumberOfSteps

public int getNumberOfSteps()

Returns getNumberOfValidationSteps() * getNumberOfChildrensSteps() + 1.

Specified by:

getNumberOfSteps in class OperatorChain

getParameterTypes

public java.util.List<ParameterType> getParameterTypes()

Description copied from class: Operator

Returns a list of ParameterTypes describing the parameters of this operator. The default implementation returns an empty list if no input objects can be retained and special parameters for those input objects which can be prevented from being consumed.

Overrides:

getParameterTypes in class Operator