edu.udo.cs.yale.operator.learner.weka
Class GenericWekaMetaLearner

java.lang.Object
  edu.udo.cs.yale.operator.Operator
      edu.udo.cs.yale.operator.OperatorChain
          edu.udo.cs.yale.operator.learner.weka.GenericWekaMetaLearner

All Implemented Interfaces:

ConfigurationListener, Learner, weka.core.TechnicalInformationHandler

public class GenericWekaMetaLearner
extends OperatorChain
implements Learner, weka.core.TechnicalInformationHandler

Performs the meta learning scheme of Weka with the same name. Another non-meta learning scheme of Weka must be embedded as inner operator. See the Weka javadoc for further classifier and parameter descriptions.

Version:

$Id: GenericWekaMetaLearner.java,v 1.22 2006/04/05 09:42:02 ingomierswa Exp $

Author:

Ingo Mierswa

Field Summary

private static java.lang.Class[]	INPUT_CLASSES
private static java.lang.Class[]	OUTPUT_CLASSES
static java.lang.String[]	WEKA_CLASSIFIERS
private java.util.List<ParameterType>	wekaParameters The list with the weka parameters.

Constructor Summary

GenericWekaMetaLearner(OperatorDescription description)

Method Summary

IOObject[]	apply() Applies all inner operators.
PerformanceVector	getEstimatedPerformance() Returns the estimated performance.
InnerOperatorCondition	getInnerOperatorCondition() Returns a simple chain condition.
java.lang.Class[]	getInputClasses() Returns the classes that are needed as input.
InputDescription	getInputDescription(java.lang.Class cls) Indicates that the consumption of example sets can be user defined.
int	getMaxNumberOfInnerOperators() Returns the maximum number of innner operators.
int	getMinNumberOfInnerOperators() Returns the minimum number of innner operators.
int	getNumberOfSteps() Returns the number of steps performed by this chain.
java.lang.Class[]	getOutputClasses() Returns the classes that are guaranteed to be returned by apply() as additional output.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.
weka.core.TechnicalInformation	getTechnicalInformation()
AttributeWeights	getWeights(ExampleSet exampleSet) Returns the calculated weight vectors.
private weka.classifiers.Classifier	getWekaClassifier(java.lang.String[] parameters) Returns the Weka classifier based on the subtype of this operator.
java.lang.String	getWekaClassPath() This method is used by the GenericWekaMetaLearner to specify the learners name.
java.util.List	getWekaParameterList() This method is used by the GenericWekaMetaLearner to specify the learners parameters.
private java.lang.String[]	getWekaParameters() This method uses some tool methods and the parameters from the inner learning scheme to build the Weka parameter style.
Model	learn(ExampleSet exampleSet) Trains a model.
void	performAdditionalChecks() This method invokes the additional check method for each child.
boolean	shouldCalculateWeights() Returns true if the user wants to calculate feature weights (depending on a parameter).
boolean	shouldEstimatePerformance() Returns true if the user wants to estimate the performance (depending on a parameter).
boolean	supportsCapability(LearnerCapability capability) Checks for Learner capabilities.

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

Methods inherited from interface edu.udo.cs.yale.operator.learner.Learner

getName

Field Detail

INPUT_CLASSES

private static final java.lang.Class[] INPUT_CLASSES

OUTPUT_CLASSES

private static final java.lang.Class[] OUTPUT_CLASSES

WEKA_CLASSIFIERS

public static final java.lang.String[] WEKA_CLASSIFIERS

wekaParameters

private java.util.List<ParameterType> wekaParameters

The list with the weka parameters.

Constructor Detail

GenericWekaMetaLearner

public GenericWekaMetaLearner(OperatorDescription description)

Method Detail

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

learn

public Model learn(ExampleSet exampleSet)
            throws OperatorException

Description copied from interface: Learner

Trains a model. This method should be called by apply() and is implemented by subclasses.

Specified by:

learn in interface Learner

Throws:

OperatorException

getWekaClassPath

public java.lang.String getWekaClassPath()

This method is used by the GenericWekaMetaLearner to specify the learners name.

getWekaParameterList

public java.util.List getWekaParameterList()

This method is used by the GenericWekaMetaLearner to specify the learners parameters.

getWekaClassifier

private weka.classifiers.Classifier getWekaClassifier(java.lang.String[] parameters)
                                               throws OperatorException

Returns the Weka classifier based on the subtype of this operator.

Throws:

OperatorException

getTechnicalInformation

public weka.core.TechnicalInformation getTechnicalInformation()

Specified by:

getTechnicalInformation in interface weka.core.TechnicalInformationHandler

getWekaParameters

private java.lang.String[] getWekaParameters()
                                      throws OperatorException

This method uses some tool methods and the parameters from the inner learning scheme to build the Weka parameter style. If the inner operator is not of type GenericWekaLearner, null will be returned. Calling methods should usually throw an exception in this case.

Throws:

OperatorException

supportsCapability

public boolean supportsCapability(LearnerCapability capability)

Description copied from interface: Learner

Checks for Learner capabilities. Should return true if the given capability is supported.

Specified by:

supportsCapability in interface Learner

shouldEstimatePerformance

public boolean shouldEstimatePerformance()

Returns true if the user wants to estimate the performance (depending on a parameter). In this case the method getEstimatedPerformance() must also be overriden and deliver the estimated performance. The default implementation returns false.

Specified by:

shouldEstimatePerformance in interface Learner

shouldCalculateWeights

public boolean shouldCalculateWeights()

Returns true if the user wants to calculate feature weights (depending on a parameter). In this case the method getWeights() must also be overriden and deliver the calculated weights. The default implementation returns false.

Specified by:

shouldCalculateWeights in interface Learner

getEstimatedPerformance

public PerformanceVector getEstimatedPerformance()
                                          throws OperatorException

Returns the estimated performance. Subclasses which supports the capability to estimate learning performance must override this method. The default implementation throws an exception.

Specified by:

getEstimatedPerformance in interface Learner

Throws:

OperatorException

getWeights

public AttributeWeights getWeights(ExampleSet exampleSet)
                            throws OperatorException

Returns the calculated weight vectors. Subclasses which supports the capability to calculate feature weights must override this method. The default implementation throws an exception.

Specified by:

getWeights in interface Learner

Throws:

OperatorException

getInputDescription

public InputDescription getInputDescription(java.lang.Class cls)

Indicates that the consumption of example sets can be user defined.

Overrides:

getInputDescription in class Operator

getNumberOfSteps

public int getNumberOfSteps()

Description copied from class: OperatorChain

Returns the number of steps performed by this chain.

Specified by:

getNumberOfSteps in class OperatorChain

getMinNumberOfInnerOperators

public int getMinNumberOfInnerOperators()

Description copied from class: OperatorChain

Returns the minimum number of innner operators.

Specified by:

getMinNumberOfInnerOperators in class OperatorChain

getMaxNumberOfInnerOperators

public int getMaxNumberOfInnerOperators()

Description copied from class: OperatorChain

Returns the maximum number of innner operators.

Specified by:

getMaxNumberOfInnerOperators 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()

Returns a simple chain condition.

Specified by:

getInnerOperatorCondition in class OperatorChain

performAdditionalChecks

public void performAdditionalChecks()
                             throws UserError

Description copied from class: OperatorChain

This method invokes the additional check method for each child. Subclasses which override this method to perform a check should also invoke super.performAdditionalChecks()!

Overrides:

performAdditionalChecks in class OperatorChain

Throws:

UserError

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