Class SMOTE

java.lang.Object
weka.filters.Filter
weka.filters.supervised.instance.SMOTE
All Implemented Interfaces:
Serializable, CapabilitiesHandler, OptionHandler, RevisionHandler, TechnicalInformationHandler, SupervisedFilter

public class SMOTE extends Filter implements SupervisedFilter, OptionHandler, TechnicalInformationHandler
Resamples a dataset by applying the Synthetic Minority Oversampling TEchnique (SMOTE). The original dataset must fit entirely in memory. The amount of SMOTE and number of nearest neighbors may be specified. For more information, see

Nitesh V. Chawla et. al. (2002). Synthetic Minority Over-sampling Technique. Journal of Artificial Intelligence Research. 16:321-357.

BibTeX:

 @article{al.2002,
    author = {Nitesh V. Chawla et. al.},
    journal = {Journal of Artificial Intelligence Research},
    pages = {321-357},
    title = {Synthetic Minority Over-sampling Technique},
    volume = {16},
    year = {2002}
 }
 

Valid options are:

 -S <num>
  Specifies the random number seed
  (default 1)
 
 -P <percentage>
  Specifies percentage of SMOTE instances to create.
  (default 100.0)
 
 -K <nearest-neighbors>
  Specifies the number of nearest neighbors to use.
  (default 5)
 
 -C <value-index>
  Specifies the index of the nominal class value to SMOTE
  (default 0: auto-detect non-empty minority class))
 
Version:
$Revision: 9657 $
Author:
Ryan Lichtenwalter (rlichtenwalter@gmail.com)
See Also:
  • Constructor Details

    • SMOTE

      public SMOTE()
  • Method Details

    • globalInfo

      public String globalInfo()
      Returns a string describing this classifier.
      Returns:
      a description of the classifier suitable for displaying in the explorer/experimenter gui
    • getTechnicalInformation

      public TechnicalInformation getTechnicalInformation()
      Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.
      Specified by:
      getTechnicalInformation in interface TechnicalInformationHandler
      Returns:
      the technical information about this class
    • getRevision

      public String getRevision()
      Returns the revision string.
      Specified by:
      getRevision in interface RevisionHandler
      Overrides:
      getRevision in class Filter
      Returns:
      the revision
    • getCapabilities

      public Capabilities getCapabilities()
      Returns the Capabilities of this filter.
      Specified by:
      getCapabilities in interface CapabilitiesHandler
      Overrides:
      getCapabilities in class Filter
      Returns:
      the capabilities of this object
      See Also:
    • listOptions

      public Enumeration listOptions()
      Returns an enumeration describing the available options.
      Specified by:
      listOptions in interface OptionHandler
      Returns:
      an enumeration of all the available options.
    • setOptions

      public void setOptions(String[] options) throws Exception
      Parses a given list of options. Valid options are:

       -S <num>
        Specifies the random number seed
        (default 1)
       
       -P <percentage>
        Specifies percentage of SMOTE instances to create.
        (default 100.0)
       
       -K <nearest-neighbors>
        Specifies the number of nearest neighbors to use.
        (default 5)
       
       -C <value-index>
        Specifies the index of the nominal class value to SMOTE
        (default 0: auto-detect non-empty minority class))
       
      Specified by:
      setOptions in interface OptionHandler
      Parameters:
      options - the list of options as an array of strings
      Throws:
      Exception - if an option is not supported
    • getOptions

      public String[] getOptions()
      Gets the current settings of the filter.
      Specified by:
      getOptions in interface OptionHandler
      Returns:
      an array of strings suitable for passing to setOptions
    • randomSeedTipText

      public String randomSeedTipText()
      Returns the tip text for this property.
      Returns:
      tip text for this property suitable for displaying in the explorer/experimenter gui
    • getRandomSeed

      public int getRandomSeed()
      Gets the random number seed.
      Returns:
      the random number seed.
    • setRandomSeed

      public void setRandomSeed(int value)
      Sets the random number seed.
      Parameters:
      value - the new random number seed.
    • percentageTipText

      public String percentageTipText()
      Returns the tip text for this property.
      Returns:
      tip text for this property suitable for displaying in the explorer/experimenter gui
    • setPercentage

      public void setPercentage(double value)
      Sets the percentage of SMOTE instances to create.
      Parameters:
      value - the percentage to use
    • getPercentage

      public double getPercentage()
      Gets the percentage of SMOTE instances to create.
      Returns:
      the percentage of SMOTE instances to create
    • nearestNeighborsTipText

      public String nearestNeighborsTipText()
      Returns the tip text for this property.
      Returns:
      tip text for this property suitable for displaying in the explorer/experimenter gui
    • setNearestNeighbors

      public void setNearestNeighbors(int value)
      Sets the number of nearest neighbors to use.
      Parameters:
      value - the number of nearest neighbors to use
    • getNearestNeighbors

      public int getNearestNeighbors()
      Gets the number of nearest neighbors to use.
      Returns:
      the number of nearest neighbors to use
    • classValueTipText

      public String classValueTipText()
      Returns the tip text for this property.
      Returns:
      tip text for this property suitable for displaying in the explorer/experimenter gui
    • setClassValue

      public void setClassValue(String value)
      Sets the index of the class value to which SMOTE should be applied.
      Parameters:
      value - the class value index
    • getClassValue

      public String getClassValue()
      Gets the index of the class value to which SMOTE should be applied.
      Returns:
      the index of the clas value to which SMOTE should be applied
    • setInputFormat

      public boolean setInputFormat(Instances instanceInfo) throws Exception
      Sets the format of the input instances.
      Overrides:
      setInputFormat in class Filter
      Parameters:
      instanceInfo - an Instances object containing the input instance structure (any instances contained in the object are ignored - only the structure is required).
      Returns:
      true if the outputFormat may be collected immediately
      Throws:
      Exception - if the input format can't be set successfully
    • input

      public boolean input(Instance instance)
      Input an instance for filtering. Filter requires all training instances be read before producing output.
      Overrides:
      input in class Filter
      Parameters:
      instance - the input instance
      Returns:
      true if the filtered instance may now be collected with output().
      Throws:
      IllegalStateException - if no input structure has been defined
    • batchFinished

      public boolean batchFinished() throws Exception
      Signify that this batch of input to the filter is finished. If the filter requires all instances prior to filtering, output() may now be called to retrieve the filtered instances.
      Overrides:
      batchFinished in class Filter
      Returns:
      true if there are instances pending output
      Throws:
      IllegalStateException - if no input structure has been defined
      Exception - if provided options cannot be executed on input instances
    • main

      public static void main(String[] args)
      Main method for running this filter.
      Parameters:
      args - should contain arguments to the filter: use -h for help