REPTree (interruptible-weka 0.1.4 API)

java.lang.Object
- weka.classifiers.AbstractClassifier
- - weka.classifiers.trees.REPTree

All Implemented Interfaces:: java.io.Serializable, java.lang.Cloneable, Classifier, Sourcable, AdditionalMeasureProducer, BatchPredictor, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, Drawable, OptionHandler, PartitionGenerator, Randomizable, RevisionHandler, WeightedInstancesHandler

public class REPTree
extends AbstractClassifier
implements OptionHandler, WeightedInstancesHandler, Drawable, AdditionalMeasureProducer, Sourcable, PartitionGenerator, Randomizable

Fast decision tree learner. Builds a decision/regression tree using information gain/variance and prunes it using reduced-error pruning (with backfitting). Only sorts values for numeric attributes once. Missing values are dealt with by splitting the corresponding instances into pieces (i.e. as in C4.5).

Valid options are:

 -M <minimum number of instances>
  Set minimum number of instances per leaf (default 2).

 -V <minimum variance for split>
  Set minimum numeric class variance proportion
  of train variance for split (default 1e-3).

 -N <number of folds>
  Number of folds for reduced error pruning (default 3).

 -S <seed>
  Seed for random data shuffling (default 1).

 -P
  No pruning.

 -L
  Maximum tree depth (default -1, no maximum)

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class REPTree.Tree
An inner class for building and storing the tree structure

Nested Classes
Modifier and Type	Class and Description
`protected class`	`REPTree.Tree` An inner class for building and storing the tree structure

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`m_InitialCount` The initial class count
`protected int`	`m_MaxDepth` Upper bound on the tree depth
`protected double`	`m_MinNum` The minimum number of instances per leaf.
`protected double`	`m_MinVarianceProp` The minimum proportion of the total variance (over all the data) required for split.
`protected boolean`	`m_NoPruning` Don't prune
`protected int`	`m_NumFolds` Number of folds for reduced error pruning.
`protected int`	`m_Seed` Seed for random data shuffling.
`protected boolean`	`m_SpreadInitialCount` Whether to spread initial count across all values
`protected REPTree.Tree`	`m_Tree` The Tree object
`protected ZeroR`	`m_zeroR` ZeroR model that is used if no attributes are present.

Fields inherited from class weka.classifiers.AbstractClassifier
BATCH_SIZE_DEFAULT, m_BatchSize, m_Debug, m_DoNotCheckCapabilities, m_numDecimalPlaces, NUM_DECIMAL_PLACES_DEFAULT

Fields inherited from interface weka.core.Drawable
BayesNet, Newick, NOT_DRAWABLE, TREE

Constructor Summary

Constructors
Constructor and Description

REPTree()

Constructors
Constructor and Description
`REPTree()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`buildClassifier(Instances data)` Builds classifier.
`double[]`	`distributionForInstance(Instance instance)` Computes class distribution of an instance using the tree.
`java.util.Enumeration<java.lang.String>`	`enumerateMeasures()` Returns an enumeration of the additional measure names.
`void`	`generatePartition(Instances data)` Builds the classifier to generate a partition.
`Capabilities`	`getCapabilities()` Returns default capabilities of the classifier.
`double`	`getInitialCount()` Get the value of InitialCount.
`int`	`getMaxDepth()` Get the value of MaxDepth.
`double`	`getMeasure(java.lang.String additionalMeasureName)` Returns the value of the named measure.
`double[]`	`getMembershipValues(Instance instance)` Computes array that indicates node membership.
`double`	`getMinNum()` Get the value of MinNum.
`double`	`getMinVarianceProp()` Get the value of MinVarianceProp.
`boolean`	`getNoPruning()` Get the value of NoPruning.
`int`	`getNumFolds()` Get the value of NumFolds.
`java.lang.String[]`	`getOptions()` Gets options from this classifier.
`java.lang.String`	`getRevision()` Returns the revision string.
`int`	`getSeed()` Get the value of Seed.
`boolean`	`getSpreadInitialCount()` Get the value of SpreadInitialCount.
`java.lang.String`	`globalInfo()` Returns a string describing classifier
`java.lang.String`	`graph()` Outputs the decision tree as a graph
`int`	`graphType()` Returns the type of graph this classifier represents.
`java.lang.String`	`initialCountTipText()` Returns the tip text for this property
`java.util.Enumeration<Option>`	`listOptions()` Lists the command-line options for this classifier.
`static void`	`main(java.lang.String[] argv)` Main method for this class.
`java.lang.String`	`maxDepthTipText()` Returns the tip text for this property
`java.lang.String`	`minNumTipText()` Returns the tip text for this property
`java.lang.String`	`minVariancePropTipText()` Returns the tip text for this property
`protected static long`	`nextID()` Gets the next unique node ID.
`java.lang.String`	`noPruningTipText()` Returns the tip text for this property
`int`	`numElements()` Returns the number of elements in the partition.
`java.lang.String`	`numFoldsTipText()` Returns the tip text for this property
`int`	`numNodes()` Computes size of the tree.
`protected static void`	`resetID()` resets the counter for the nodes
`java.lang.String`	`seedTipText()` Returns the tip text for this property
`void`	`setInitialCount(double newInitialCount)` Set the value of InitialCount.
`void`	`setMaxDepth(int newMaxDepth)` Set the value of MaxDepth.
`void`	`setMinNum(double newMinNum)` Set the value of MinNum.
`void`	`setMinVarianceProp(double newMinVarianceProp)` Set the value of MinVarianceProp.
`void`	`setNoPruning(boolean newNoPruning)` Set the value of NoPruning.
`void`	`setNumFolds(int newNumFolds)` Set the value of NumFolds.
`void`	`setOptions(java.lang.String[] options)` Parses a given list of options.
`void`	`setSeed(int newSeed)` Set the value of Seed.
`void`	`setSpreadInitialCount(boolean newSpreadInitialCount)` Set the value of SpreadInitialCount.
`java.lang.String`	`spreadInitialCountTipText()` Returns the tip text for this property
`java.lang.String`	`toSource(java.lang.String className)` Returns the tree as if-then statements.
`java.lang.String`	`toString()` Outputs the decision tree.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - m_zeroR
```
protected ZeroR m_zeroR
```
    ZeroR model that is used if no attributes are present.
  - m_Tree
```
protected REPTree.Tree m_Tree
```
    The Tree object
  - m_NumFolds
```
protected int m_NumFolds
```
    Number of folds for reduced error pruning.
  - m_Seed
```
protected int m_Seed
```
    Seed for random data shuffling.
  - m_NoPruning
```
protected boolean m_NoPruning
```
    Don't prune
  - m_MinNum
```
protected double m_MinNum
```
    The minimum number of instances per leaf.
  - m_MinVarianceProp
```
protected double m_MinVarianceProp
```
    The minimum proportion of the total variance (over all the data) required for split.
  - m_MaxDepth
```
protected int m_MaxDepth
```
    Upper bound on the tree depth
  - m_InitialCount
```
protected double m_InitialCount
```
    The initial class count
  - m_SpreadInitialCount
```
protected boolean m_SpreadInitialCount
```
    Whether to spread initial count across all values
- Constructor Detail
  - REPTree
```
public REPTree()
```
- Method Detail
  - globalInfo
```
public java.lang.String globalInfo()
```
    Returns a string describing classifier
    
    Returns:
    
    a description suitable for displaying in the explorer/experimenter gui
  - noPruningTipText
```
public java.lang.String noPruningTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getNoPruning
```
public boolean getNoPruning()
```
    Get the value of NoPruning.
    
    Returns:
    
    Value of NoPruning.
  - setNoPruning
```
public void setNoPruning(boolean newNoPruning)
```
    Set the value of NoPruning.
    
    Parameters:
    
    newNoPruning - Value to assign to NoPruning.
  - minNumTipText
```
public java.lang.String minNumTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getMinNum
```
public double getMinNum()
```
    Get the value of MinNum.
    
    Returns:
    
    Value of MinNum.
  - setMinNum
```
public void setMinNum(double newMinNum)
```
    Set the value of MinNum.
    
    Parameters:
    
    newMinNum - Value to assign to MinNum.
  - minVariancePropTipText
```
public java.lang.String minVariancePropTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getMinVarianceProp
```
public double getMinVarianceProp()
```
    Get the value of MinVarianceProp.
    
    Returns:
    
    Value of MinVarianceProp.
  - setMinVarianceProp
```
public void setMinVarianceProp(double newMinVarianceProp)
```
    Set the value of MinVarianceProp.
    
    Parameters:
    
    newMinVarianceProp - Value to assign to MinVarianceProp.
  - seedTipText
```
public java.lang.String seedTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getSeed
```
public int getSeed()
```
    Get the value of Seed.
    
    Specified by:
    
    getSeed in interface Randomizable
    
    Returns:
    
    Value of Seed.
  - setSeed
```
public void setSeed(int newSeed)
```
    Set the value of Seed.
    
    Specified by:
    
    setSeed in interface Randomizable
    
    Parameters:
    
    newSeed - Value to assign to Seed.
  - numFoldsTipText
```
public java.lang.String numFoldsTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getNumFolds
```
public int getNumFolds()
```
    Get the value of NumFolds.
    
    Returns:
    
    Value of NumFolds.
  - setNumFolds
```
public void setNumFolds(int newNumFolds)
```
    Set the value of NumFolds.
    
    Parameters:
    
    newNumFolds - Value to assign to NumFolds.
  - maxDepthTipText
```
public java.lang.String maxDepthTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getMaxDepth
```
public int getMaxDepth()
```
    Get the value of MaxDepth.
    
    Returns:
    
    Value of MaxDepth.
  - setMaxDepth
```
public void setMaxDepth(int newMaxDepth)
```
    Set the value of MaxDepth.
    
    Parameters:
    
    newMaxDepth - Value to assign to MaxDepth.
  - initialCountTipText
```
public java.lang.String initialCountTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getInitialCount
```
public double getInitialCount()
```
    Get the value of InitialCount.
    
    Returns:
    
    Value of InitialCount.
  - setInitialCount
```
public void setInitialCount(double newInitialCount)
```
    Set the value of InitialCount.
    
    Parameters:
    
    newInitialCount - Value to assign to InitialCount.
  - spreadInitialCountTipText
```
public java.lang.String spreadInitialCountTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getSpreadInitialCount
```
public boolean getSpreadInitialCount()
```
    Get the value of SpreadInitialCount.
    
    Returns:
    
    Value of SpreadInitialCount.
  - setSpreadInitialCount
```
public void setSpreadInitialCount(boolean newSpreadInitialCount)
```
    Set the value of SpreadInitialCount.
    
    Parameters:
    
    newSpreadInitialCount - Value to assign to SpreadInitialCount.
  - listOptions
```
public java.util.Enumeration<Option> listOptions()
```
    Lists the command-line options for this classifier.
    
    Specified by:
    
    listOptions in interface OptionHandler
    
    Overrides:
    
    listOptions in class AbstractClassifier
    
    Returns:
    
    an enumeration over all commandline options
  - getOptions
```
public java.lang.String[] getOptions()
```
    Gets options from this classifier.
    
    Specified by:
    
    getOptions in interface OptionHandler
    
    Overrides:
    
    getOptions in class AbstractClassifier
    
    Returns:
    
    the options for the current setup
  - setOptions
```
public void setOptions(java.lang.String[] options)
                throws java.lang.Exception
```
    Parses a given list of options.
    Valid options are:
```
 -M <minimum number of instances>
  Set minimum number of instances per leaf (default 2).
 
```
```
 -V <minimum variance for split>
  Set minimum numeric class variance proportion
  of train variance for split (default 1e-3).
 
```
```
 -N <number of folds>
  Number of folds for reduced error pruning (default 3).
 
```
```
 -S <seed>
  Seed for random data shuffling (default 1).
 
```
```
 -P
  No pruning.
 
```
```
 -L
  Maximum tree depth (default -1, no maximum)
 
```
    Specified by:
    
    setOptions in interface OptionHandler
    
    Overrides:
    
    setOptions in class AbstractClassifier
    
    Parameters:
    
    options - the list of options as an array of strings
    
    Throws:
    
    java.lang.Exception - if an option is not supported
  - numNodes
```
public int numNodes()
```
    Computes size of the tree.
    
    Returns:
    
    the number of nodes
  - enumerateMeasures
```
public java.util.Enumeration<java.lang.String> enumerateMeasures()
```
    Returns an enumeration of the additional measure names.
    
    Specified by:
    
    enumerateMeasures in interface AdditionalMeasureProducer
    
    Returns:
    
    an enumeration of the measure names
  - getMeasure
```
public double getMeasure(java.lang.String additionalMeasureName)
```
    Returns the value of the named measure.
    
    Specified by:
    
    getMeasure in interface AdditionalMeasureProducer
    
    Parameters:
    
    additionalMeasureName - the name of the measure to query for its value
    
    Returns:
    
    the value of the named measure
    
    Throws:
    
    java.lang.IllegalArgumentException - if the named measure is not supported
  - getCapabilities
```
public Capabilities getCapabilities()
```
    Returns default capabilities of the classifier.
    
    Specified by:
    
    getCapabilities in interface Classifier
    
    Specified by:
    
    getCapabilities in interface CapabilitiesHandler
    
    Overrides:
    
    getCapabilities in class AbstractClassifier
    
    Returns:
    
    the capabilities of this classifier
    
    See Also:
    
    Capabilities
  - buildClassifier
```
public void buildClassifier(Instances data)
                     throws java.lang.Exception
```
    Builds classifier.
    
    Specified by:
    
    buildClassifier in interface Classifier
    
    Parameters:
    
    data - the data to train with
    
    Throws:
    
    java.lang.Exception - if building fails
  - distributionForInstance
```
public double[] distributionForInstance(Instance instance)
                                 throws java.lang.Exception
```
    Computes class distribution of an instance using the tree.
    
    Specified by:
    
    distributionForInstance in interface Classifier
    
    Overrides:
    
    distributionForInstance in class AbstractClassifier
    
    Parameters:
    
    instance - the instance to compute the distribution for
    
    Returns:
    
    the computed class probabilities
    
    Throws:
    
    java.lang.Exception - if computation fails
  - nextID
```
protected static long nextID()
```
    Gets the next unique node ID.
    
    Returns:
    
    the next unique node ID.
  - resetID
```
protected static void resetID()
```
    resets the counter for the nodes
  - toSource
```
public java.lang.String toSource(java.lang.String className)
                          throws java.lang.Exception
```
    Returns the tree as if-then statements.
    
    Specified by:
    
    toSource in interface Sourcable
    
    Parameters:
    
    className - the name for the generated class
    
    Returns:
    
    the tree as a Java if-then type statement
    
    Throws:
    
    java.lang.Exception - if something goes wrong
  - graphType
```
public int graphType()
```
    Returns the type of graph this classifier represents.
    
    Specified by:
    
    graphType in interface Drawable
    
    Returns:
    
    Drawable.TREE
  - graph
```
public java.lang.String graph()
                       throws java.lang.Exception
```
    Outputs the decision tree as a graph
    
    Specified by:
    
    graph in interface Drawable
    
    Returns:
    
    the tree as a graph
    
    Throws:
    
    java.lang.Exception - if generation fails
  - toString
```
public java.lang.String toString()
```
    Outputs the decision tree.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string representation of the classifier
  - generatePartition
```
public void generatePartition(Instances data)
                       throws java.lang.Exception
```
    Builds the classifier to generate a partition.
    
    Specified by:
    
    generatePartition in interface PartitionGenerator
    
    Throws:
    
    java.lang.Exception
  - getMembershipValues
```
public double[] getMembershipValues(Instance instance)
                             throws java.lang.Exception
```
    Computes array that indicates node membership. Array locations are allocated based on breadth-first exploration of the tree.
    
    Specified by:
    
    getMembershipValues in interface PartitionGenerator
    
    Throws:
    
    java.lang.Exception
  - numElements
```
public int numElements()
                throws java.lang.Exception
```
    Returns the number of elements in the partition.
    
    Specified by:
    
    numElements in interface PartitionGenerator
    
    Throws:
    
    java.lang.Exception
  - getRevision
```
public java.lang.String getRevision()
```
    Returns the revision string.
    
    Specified by:
    
    getRevision in interface RevisionHandler
    
    Overrides:
    
    getRevision in class AbstractClassifier
    
    Returns:
    
    the revision
  - main
```
public static void main(java.lang.String[] argv)
```
    Main method for this class.
    
    Parameters:
    
    argv - the commandline options

Class REPTree

Nested Class Summary

Field Summary

Fields inherited from class weka.classifiers.AbstractClassifier

Fields inherited from interface weka.core.Drawable

Constructor Summary

Method Summary

Methods inherited from class weka.classifiers.AbstractClassifier

Methods inherited from class java.lang.Object

Field Detail

m_zeroR

m_Tree

m_NumFolds

m_Seed

m_NoPruning

m_MinNum

m_MinVarianceProp

m_MaxDepth

m_InitialCount

m_SpreadInitialCount

Constructor Detail

REPTree

Method Detail

globalInfo

noPruningTipText

getNoPruning

setNoPruning

minNumTipText

getMinNum

setMinNum

minVariancePropTipText

getMinVarianceProp

setMinVarianceProp

seedTipText

getSeed

setSeed

numFoldsTipText

getNumFolds

setNumFolds

maxDepthTipText

getMaxDepth

setMaxDepth

initialCountTipText

getInitialCount

setInitialCount

spreadInitialCountTipText

getSpreadInitialCount

setSpreadInitialCount

listOptions

getOptions

setOptions

numNodes

enumerateMeasures

getMeasure

getCapabilities

buildClassifier

distributionForInstance

nextID

resetID

toSource

graphType

graph

toString

generatePartition

getMembershipValues

numElements

getRevision

main