HotSpot

java.lang.Object
- weka.associations.HotSpot

All Implemented Interfaces:

java.io.Serializable, weka.associations.AssociationRulesProducer, weka.associations.Associator, weka.core.CapabilitiesHandler, weka.core.CapabilitiesIgnorer, weka.core.Drawable, weka.core.OptionHandler, weka.core.RevisionHandler
```
public class HotSpot
extends java.lang.Object
implements weka.associations.Associator, weka.core.OptionHandler, weka.core.RevisionHandler, weka.core.CapabilitiesHandler, weka.core.CapabilitiesIgnorer, weka.core.Drawable, weka.associations.AssociationRulesProducer, java.io.Serializable
```
HotSpot learns a set of rules (displayed in a tree-like structure) that maximize/minimize a target variable/value of interest. With a nominal target, one might want to look for segments of the data where there is a high probability of a minority value occuring (given the constraint of a minimum support). For a numeric target, one might be interested in finding segments where this is higher on average than in the whole data set. For example, in a health insurance scenario, find which health insurance groups are at the highest risk (have the highest claim ratio), or, which groups have the highest average insurance payout. This algorithm is similar in spirit to the PRIM bump hunting algorithm described by Friedman and Fisher (1999).
Valid options are:
```
 -c <num | first | last>
  The target index. (default = last)
 
```
```
 -V <num | first | last>
  The target value (nominal target only, default = first)
 
```
```
 -L
  Minimize rather than maximize.
 
```
```
 -S <num>
  Minimum value count (nominal target)/segment size (numeric target).
  Values between 0 and 1 are 
  interpreted as a percentage of 
  the total population; values > 1 are 
  interpreted as an absolute number of 
  instances (default = 0.3)
 
```
```
 -M <num>
  Maximum branching factor (default = 2)
 
```
```
 -I <num>
  Minimum improvement in target value in order 
  to add a new branch/test (default = 0.01 (1%))
 
```
```
 -D
  Output debugging info (duplicate rule lookup 
  hash table stats)
 
```
Version:

$Revision: 11008 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}org

See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description

HotSpot()
Constructor

Constructors
Constructor and Description
`HotSpot()` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`buildAssociations(weka.core.Instances instances)` Build the tree
`boolean`	`canProduceRules()` Returns true if this AssociationRulesProducer can actually produce rules.
`java.lang.String`	`debugTipText()` Returns the tip text for this property
`java.lang.String`	`doNotCheckCapabilitiesTipText()` Returns the tip text for this property
`weka.associations.AssociationRules`	`getAssociationRules()` Gets the list of mined association rules.
`weka.core.Capabilities`	`getCapabilities()` Returns default capabilities of HotSpot
`boolean`	`getDebug()` Get whether debugging info is output
`boolean`	`getDoNotCheckCapabilities()` Get whether capabilities checking is turned off.
`int`	`getMaxBranchingFactor()` Get the maximum branching factor
`int`	`getMaxRuleLength()` Get the maximum rule length
`boolean`	`getMinimizeTarget()` Get whether to minimize the target rather than maximize
`double`	`getMinImprovement()` Get the minimum improvement in the target necessary to add a test
`java.lang.String[]`	`getOptions()` Gets the current settings of HotSpot.
`boolean`	`getOutputRules()`
`java.lang.String`	`getRevision()` Returns the revision string.
`java.lang.String[]`	`getRuleMetricNames()` Gets a list of the names of the metrics output for each rule.
`java.lang.String`	`getSupport()` Get the minimum support
`java.lang.String`	`getTarget()` Get the target index as a string
`java.lang.String`	`getTargetIndex()` For a nominal target, get the index of the value of interest (1-based)
`boolean`	`getTreatZeroAsMissing()` Get whether to treat zero as missing.
`java.lang.String`	`globalInfo()` Returns a string describing this classifier
`java.lang.String`	`graph()`
`int`	`graphType()` Returns the type of graph this scheme represents.
`java.util.Enumeration<weka.core.Option>`	`listOptions()` Returns an enumeration describing the available options.
`static void`	`main(java.lang.String[] args)` Main method for testing this class.
`java.lang.String`	`maxBranchingFactorTipText()` Returns the tip text for this property
`java.lang.String`	`maxRuleLengthTipText()` Returns the tip text for this property
`java.lang.String`	`minimizeTargetTipText()` Returns the tip text for this property
`java.lang.String`	`minImprovementTipText()` Returns the tip text for this property
`java.lang.String`	`outputRulesTipText()` Returns the tip text for this property
`void`	`resetOptions()` Reset options to their defaults
`void`	`setDebug(boolean d)` Set whether debugging info is output
`void`	`setDoNotCheckCapabilities(boolean doNotCheck)` Set whether capabilities checking is turned off.
`void`	`setMaxBranchingFactor(int b)` Set the maximum branching factor
`void`	`setMaxRuleLength(int l)` Set the maximum rule length
`void`	`setMinimizeTarget(boolean m)` Set whether to minimize the target rather than maximize
`void`	`setMinImprovement(double i)` Set the minimum improvement in the target necessary to add a test
`void`	`setOptions(java.lang.String[] options)` Parses a given list of options.
`void`	`setOutputRules(boolean r)`
`void`	`setSupport(java.lang.String s)` Set the minimum support
`void`	`setTarget(java.lang.String target)` Set the target index
`void`	`setTargetIndex(java.lang.String index)` For a nominal target, set the index of the value of interest (1-based)
`void`	`setTreatZeroAsMissing(boolean t)` Set whether to treat zero as missing.
`java.lang.String`	`supportTipText()` Returns the tip text for this property
`java.lang.String`	`targetIndexTipText()` Returns the tip text for this property
`java.lang.String`	`targetTipText()` Returns the tip text for this property
`java.lang.String`	`toString()` Return the tree as a string
`java.lang.String`	`treatZeroAsMissingTipText()` Returns the tip text for this property

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

Methods inherited from interface weka.core.OptionHandler
makeCopy

- Constructor Detail
  - HotSpot
```
public HotSpot()
```
    Constructor
- Method Detail
  - globalInfo
```
public java.lang.String globalInfo()
```
    Returns a string describing this classifier
    
    Returns:
    
    a description of the classifier suitable for displaying in the explorer/experimenter gui
  - getCapabilities
```
public weka.core.Capabilities getCapabilities()
```
    Returns default capabilities of HotSpot
    
    Specified by:
    
    getCapabilities in interface weka.associations.Associator
    
    Specified by:
    
    getCapabilities in interface weka.core.CapabilitiesHandler
    
    Returns:
    
    the capabilities of HotSpot
  - buildAssociations
```
public void buildAssociations(weka.core.Instances instances)
                       throws java.lang.Exception
```
    Build the tree
    
    Specified by:
    
    buildAssociations in interface weka.associations.Associator
    
    Parameters:
    
    instances - the training instances
    
    Throws:
    
    java.lang.Exception - if something goes wrong
  - toString
```
public java.lang.String toString()
```
    Return the tree as a string
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a String containing the tree
  - graph
```
public java.lang.String graph()
                       throws java.lang.Exception
```
    Specified by:
    
    graph in interface weka.core.Drawable
    
    Throws:
    
    java.lang.Exception
  - targetTipText
```
public java.lang.String targetTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setTarget
```
public void setTarget(java.lang.String target)
```
    Set the target index
    
    Parameters:
    
    target - the target index as a string (1-based)
  - getTarget
```
public java.lang.String getTarget()
```
    Get the target index as a string
    
    Returns:
    
    the target index (1-based)
  - targetIndexTipText
```
public java.lang.String targetIndexTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setTargetIndex
```
public void setTargetIndex(java.lang.String index)
```
    For a nominal target, set the index of the value of interest (1-based)
    
    Parameters:
    
    index - the index of the nominal value of interest
  - getTargetIndex
```
public java.lang.String getTargetIndex()
```
    For a nominal target, get the index of the value of interest (1-based)
    
    Returns:
    
    the index of the nominal value of interest
  - minimizeTargetTipText
```
public java.lang.String minimizeTargetTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setMinimizeTarget
```
public void setMinimizeTarget(boolean m)
```
    Set whether to minimize the target rather than maximize
    
    Parameters:
    
    m - true if target is to be minimized
  - getMinimizeTarget
```
public boolean getMinimizeTarget()
```
    Get whether to minimize the target rather than maximize
    
    Returns:
    
    true if target is to be minimized
  - supportTipText
```
public java.lang.String supportTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getSupport
```
public java.lang.String getSupport()
```
    Get the minimum support
    
    Returns:
    
    the minimum support
  - setSupport
```
public void setSupport(java.lang.String s)
```
    Set the minimum support
    
    Parameters:
    
    s - the minimum support
  - maxBranchingFactorTipText
```
public java.lang.String maxBranchingFactorTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setMaxBranchingFactor
```
public void setMaxBranchingFactor(int b)
```
    Set the maximum branching factor
    
    Parameters:
    
    b - the maximum branching factor
  - getMaxBranchingFactor
```
public int getMaxBranchingFactor()
```
    Get the maximum branching factor
    
    Returns:
    
    the maximum branching factor
  - maxRuleLengthTipText
```
public java.lang.String maxRuleLengthTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setMaxRuleLength
```
public void setMaxRuleLength(int l)
```
    Set the maximum rule length
    
    Parameters:
    
    l - the maximum rule length
  - getMaxRuleLength
```
public int getMaxRuleLength()
```
    Get the maximum rule length
    
    Returns:
    
    the maximum rule length
  - treatZeroAsMissingTipText
```
public java.lang.String treatZeroAsMissingTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setTreatZeroAsMissing
```
public void setTreatZeroAsMissing(boolean t)
```
    Set whether to treat zero as missing.
    
    Parameters:
    
    t - true if zero (first value) for nominal attributes is to be treated like missing value.
  - getTreatZeroAsMissing
```
public boolean getTreatZeroAsMissing()
```
    Get whether to treat zero as missing.
    
    Returns:
    
    true if zero (first value) for nominal attributes is to be treated like missing value.
  - minImprovementTipText
```
public java.lang.String minImprovementTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setMinImprovement
```
public void setMinImprovement(double i)
```
    Set the minimum improvement in the target necessary to add a test
    
    Parameters:
    
    i - the minimum improvement
  - getMinImprovement
```
public double getMinImprovement()
```
    Get the minimum improvement in the target necessary to add a test
    
    Returns:
    
    the minimum improvement
  - debugTipText
```
public java.lang.String debugTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setDebug
```
public void setDebug(boolean d)
```
    Set whether debugging info is output
    
    Parameters:
    
    d - true to output debugging info
  - getDebug
```
public boolean getDebug()
```
    Get whether debugging info is output
    
    Returns:
    
    true if outputing debugging info
  - setOutputRules
```
public void setOutputRules(boolean r)
```
  - getOutputRules
```
public boolean getOutputRules()
```
  - outputRulesTipText
```
public java.lang.String outputRulesTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - doNotCheckCapabilitiesTipText
```
public java.lang.String doNotCheckCapabilitiesTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setDoNotCheckCapabilities
```
public void setDoNotCheckCapabilities(boolean doNotCheck)
```
    Set whether capabilities checking is turned off.
    
    Specified by:
    
    setDoNotCheckCapabilities in interface weka.core.CapabilitiesIgnorer
    
    Parameters:
    
    doNotCheck - true if capabilities checking is turned off.
  - getDoNotCheckCapabilities
```
public boolean getDoNotCheckCapabilities()
```
    Get whether capabilities checking is turned off.
    
    Specified by:
    
    getDoNotCheckCapabilities in interface weka.core.CapabilitiesIgnorer
    
    Returns:
    
    true if capabilities checking is turned off.
  - listOptions
```
public java.util.Enumeration<weka.core.Option> listOptions()
```
    Returns an enumeration describing the available options.
    
    Specified by:
    
    listOptions in interface weka.core.OptionHandler
    
    Returns:
    
    an enumeration of all the available options.
  - resetOptions
```
public void resetOptions()
```
    Reset options to their defaults
  - setOptions
```
public void setOptions(java.lang.String[] options)
                throws java.lang.Exception
```
    Parses a given list of options.
    Valid options are:
```
 -c <num | first | last>
  The target index. (default = last)
 
```
```
 -V <num | first | last>
  The target value (nominal target only, default = first)
 
```
```
 -L
  Minimize rather than maximize.
 
```
```
 -S <num>
  Minimum value count (nominal target)/segment size (numeric target).
  Values between 0 and 1 are 
  interpreted as a percentage of 
  the total population; values > 1 are 
  interpreted as an absolute number of 
  instances (default = 0.3)
 
```
```
 -M <num>
  Maximum branching factor (default = 2)
 
```
```
 -I <num>
  Minimum improvement in target value in order 
  to add a new branch/test (default = 0.01 (1%))
 
```
```
 -D
  Output debugging info (duplicate rule lookup 
  hash table stats)
 
```
    Specified by:
    
    setOptions in interface weka.core.OptionHandler
    
    Parameters:
    
    options - the list of options as an array of strings
    
    Throws:
    
    java.lang.Exception - if an option is not supported
  - getOptions
```
public java.lang.String[] getOptions()
```
    Gets the current settings of HotSpot.
    
    Specified by:
    
    getOptions in interface weka.core.OptionHandler
    
    Returns:
    
    an array of strings suitable for passing to setOptions
  - getRevision
```
public java.lang.String getRevision()
```
    Returns the revision string.
    
    Specified by:
    
    getRevision in interface weka.core.RevisionHandler
    
    Returns:
    
    the revision
  - graphType
```
public int graphType()
```
    Returns the type of graph this scheme represents.
    
    Specified by:
    
    graphType in interface weka.core.Drawable
    
    Returns:
    
    Drawable.TREE
  - getAssociationRules
```
public weka.associations.AssociationRules getAssociationRules()
```
    Gets the list of mined association rules.
    
    Specified by:
    
    getAssociationRules in interface weka.associations.AssociationRulesProducer
    
    Returns:
    
    the list of association rules discovered during mining. Returns null if mining hasn't been performed yet.
  - canProduceRules
```
public boolean canProduceRules()
```
    Returns true if this AssociationRulesProducer can actually produce rules. Most implementing classes will always return true from this method (obviously :-)). However, an implementing class that actually acts as a wrapper around things that may or may not implement AssociationRulesProducer will want to return false if the thing they wrap can't produce rules.
    
    Specified by:
    
    canProduceRules in interface weka.associations.AssociationRulesProducer
    
    Returns:
    
    true if this producer can produce rules in its current configuration
  - getRuleMetricNames
```
public java.lang.String[] getRuleMetricNames()
```
    Gets a list of the names of the metrics output for each rule. This list should be the same (in terms of the names and order thereof) as that produced by AssociationRule.getMetricNamesForRule().
    
    Specified by:
    
    getRuleMetricNames in interface weka.associations.AssociationRulesProducer
    
    Returns:
    
    an array of the names of the metrics available for each rule learned by this producer.
  - main
```
public static void main(java.lang.String[] args)
```
    Main method for testing this class.
    
    Parameters:
    
    args - the options

Class HotSpot

Field Summary

Fields inherited from interface weka.core.Drawable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface weka.core.OptionHandler

Constructor Detail

HotSpot

Method Detail

globalInfo

getCapabilities

buildAssociations

toString

graph

targetTipText

setTarget

getTarget

targetIndexTipText

setTargetIndex

getTargetIndex

minimizeTargetTipText

setMinimizeTarget

getMinimizeTarget

supportTipText

getSupport

setSupport

maxBranchingFactorTipText

setMaxBranchingFactor

getMaxBranchingFactor

maxRuleLengthTipText

setMaxRuleLength

getMaxRuleLength

treatZeroAsMissingTipText

setTreatZeroAsMissing

getTreatZeroAsMissing

minImprovementTipText

setMinImprovement

getMinImprovement

debugTipText

setDebug

getDebug

setOutputRules

getOutputRules

outputRulesTipText

doNotCheckCapabilitiesTipText

setDoNotCheckCapabilities

getDoNotCheckCapabilities

listOptions

resetOptions

setOptions

getOptions

getRevision

graphType

getAssociationRules

canProduceRules

getRuleMetricNames

main