de.jstacs.classifier.assessment
Class KFoldCVAssessParameterSet

java.lang.Object
  de.jstacs.parameters.ParameterSet
      de.jstacs.classifier.assessment.ClassifierAssessmentAssessParameterSet
          de.jstacs.classifier.assessment.KFoldCVAssessParameterSet

All Implemented Interfaces:

RangeIterator, Storable, Cloneable

public class KFoldCVAssessParameterSet
extends ClassifierAssessmentAssessParameterSet

This class implements a ClassifierAssessmentAssessParameterSet that must be used to call method assess() of a KFoldCrossValidation.
It contains user-specific parameters necessary for a run of a KFoldCrossValidation.

Author:

andr|e gohr (a0coder (nospam:@) gmail (nospam:.) com)

Nested Class Summary

Nested classes/interfaces inherited from class de.jstacs.parameters.ParameterSet

ParameterSet.ParameterList

Field Summary

Fields inherited from class de.jstacs.parameters.ParameterSet

alternativeInstanceClass, errorMessage, parameters, parent, ranged

Constructor Summary

	KFoldCVAssessParameterSet() inherited from ClassifierAssessmentAssessParameterSet
protected	KFoldCVAssessParameterSet(Class alternativeInstanceClass) inherited from ClassifierAssessmentAssessParameterSet
	KFoldCVAssessParameterSet(Sample.PartitionMethod dataSplitMethod, int elementLength, boolean exceptionIfMPNotComputable, int k)
	KFoldCVAssessParameterSet(StringBuffer representation) inherited from ClassifierAssessmentAssessParameterSet

Method Summary

ArrayList<Result>	getAnnotation()
Sample.PartitionMethod	getDataSplitMethod()
String	getInstanceComment() Returns a comment (a textual description) of the class that can be constructed using this ParameterSet.
String	getInstanceName() Returns the name of an instance of the class that can be constructed using this ParameterSet.
int	getK()
protected void	initializeMyParametersArrayList() Initializes the list of Parameters in this ParameterSet.
protected void	loadParameters() Loads the parameters for this ParameterSet.

Methods inherited from class de.jstacs.classifier.assessment.ClassifierAssessmentAssessParameterSet

getAllClassifierAssessmentAssessParameterSets, getElementLength, getExceptionIfMPNotComputable

Methods inherited from class de.jstacs.parameters.ParameterSet

clone, fromXML, getErrorMessage, getId, getInstance, getInstanceClass, getNumberOfParameters, getNumberOfValues, getParameterAt, getParent, hasDefaultOrIsSet, initParameterList, initParameterList, isAtomic, isRanged, makeRanged, next, parametersLoaded, propagateId, recieveId, replaceParametersWithRangedInstance, reset, resetToFirst, setAlternativeInstanceClass, setParent, simplify, toXML, valuesToString

Methods inherited from class java.lang.Object

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

Constructor Detail

KFoldCVAssessParameterSet

protected KFoldCVAssessParameterSet(Class alternativeInstanceClass)

inherited from ClassifierAssessmentAssessParameterSet

KFoldCVAssessParameterSet

public KFoldCVAssessParameterSet()
                          throws UnsupportedOperationException

inherited from ClassifierAssessmentAssessParameterSet

Throws:

UnsupportedOperationException

KFoldCVAssessParameterSet

public KFoldCVAssessParameterSet(StringBuffer representation)
                          throws NonParsableException

inherited from ClassifierAssessmentAssessParameterSet

Throws:

NonParsableException

KFoldCVAssessParameterSet

public KFoldCVAssessParameterSet(Sample.PartitionMethod dataSplitMethod,
                                 int elementLength,
                                 boolean exceptionIfMPNotComputable,
                                 int k)
                          throws SimpleParameter.IllegalValueException

Parameters:

dataSplitMethod - defines the method used to split user-supplied data into k mutually exclusive, random-splits (available options are: Sample.PartitionMethod.PARTITION_BY_NUMBER_OF_ELEMENTS and Sample.PartitionMethod.PARTITION_BY_NUMBER_OF_SYMBOLS) See docu of Sample for further details.

elementLength - defines the length of elements (sequences) the classifiers to be assessed are able to classify

exceptionIfMPNotComputable - a KFoldCVAssessParameterSet is used in combination with an MeasureParameters-object to call assess-methods of KFoldCrossValidations. If exceptionIfMPNotComputable=true then an expection is thrown in case of a selected measure-parameters that could not be computed.

k - defines the number of mutually exclusive, random-splits of user supplied data. Each part is used once as a test-data-set and the union of the remaining k-1 patrs is once used as train-data-set. Thus k also defines how many (k) repeated classifier-trainings and classifier-evaluations (test) are performend.

Throws:

SimpleParameter.IllegalValueException - is thrown in case of out-of-range or invalid given parameters

Method Detail

initializeMyParametersArrayList

protected void initializeMyParametersArrayList()

Description copied from class: ClassifierAssessmentAssessParameterSet

Initializes the list of Parameters in this ParameterSet.

Overrides:

initializeMyParametersArrayList in class ClassifierAssessmentAssessParameterSet

loadParameters

protected void loadParameters()
                       throws Exception

Description copied from class: ParameterSet

Loads the parameters for this ParameterSet. This is in most cases done by simply creating a new ArrayList<Parameter> for the field parameters/code> and filling it with instances of subclasses of Parameter

Overrides:

loadParameters in class ClassifierAssessmentAssessParameterSet

Throws:

Exception - an Exception is thrown if the parameters could not be loaded

See Also:

ParameterSet.parameters, Parameter

getInstanceName

public String getInstanceName()

Description copied from class: ParameterSet

Returns the name of an instance of the class that can be constructed using this ParameterSet.

Overrides:

getInstanceName in class ClassifierAssessmentAssessParameterSet

Returns:

the name

getInstanceComment

public String getInstanceComment()

Description copied from class: ParameterSet

Returns a comment (a textual description) of the class that can be constructed using this ParameterSet.

Overrides:

getInstanceComment in class ClassifierAssessmentAssessParameterSet

Returns:

the comment

getK

public int getK()

Returns:

the number of mutually exclusive, random-splits of user-supplied data defined by this KFoldCVAssessParameterSet

getDataSplitMethod

public Sample.PartitionMethod getDataSplitMethod()

Returns:

The Sample.PartitionMethod defining how the mutually exclusive, random-splits of user-supplied data are generated. See class Sample for further details.

getAnnotation

public ArrayList<Result> getAnnotation()

Overrides:

getAnnotation in class ClassifierAssessmentAssessParameterSet

Returns:

collection of parameters containing informations about this ClassifierAssessmentAssessParameterSet