Package weka.filters.supervised.instance
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:
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Signify that this batch of input to the filter is finished.Returns the tip text for this property.Returns the Capabilities of this filter.Gets the index of the class value to which SMOTE should be applied.int
Gets the number of nearest neighbors to use.String[]
Gets the current settings of the filter.double
Gets the percentage of SMOTE instances to create.int
Gets the random number seed.Returns the revision string.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.Returns a string describing this classifier.boolean
Input an instance for filtering.Returns an enumeration describing the available options.static void
Main method for running this filter.Returns the tip text for this property.Returns the tip text for this property.Returns the tip text for this property.void
setClassValue
(String value) Sets the index of the class value to which SMOTE should be applied.boolean
setInputFormat
(Instances instanceInfo) Sets the format of the input instances.void
setNearestNeighbors
(int value) Sets the number of nearest neighbors to use.void
setOptions
(String[] options) Parses a given list of options.void
setPercentage
(double value) Sets the percentage of SMOTE instances to create.void
setRandomSeed
(int value) Sets the random number seed.Methods inherited from class weka.filters.Filter
batchFilterFile, filterFile, getCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, numPendingOutput, output, outputPeek, toString, useFilter, wekaStaticWrapper
-
Constructor Details
-
SMOTE
public SMOTE()
-
-
Method Details
-
globalInfo
Returns a string describing this classifier.- Returns:
- a description of the classifier suitable for displaying in the explorer/experimenter gui
-
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 interfaceTechnicalInformationHandler
- Returns:
- the technical information about this class
-
getRevision
Returns the revision string.- Specified by:
getRevision
in interfaceRevisionHandler
- Overrides:
getRevision
in classFilter
- Returns:
- the revision
-
getCapabilities
Returns the Capabilities of this filter.- Specified by:
getCapabilities
in interfaceCapabilitiesHandler
- Overrides:
getCapabilities
in classFilter
- Returns:
- the capabilities of this object
- See Also:
-
listOptions
Returns an enumeration describing the available options.- Specified by:
listOptions
in interfaceOptionHandler
- Returns:
- an enumeration of all the available options.
-
setOptions
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 interfaceOptionHandler
- Parameters:
options
- the list of options as an array of strings- Throws:
Exception
- if an option is not supported
-
getOptions
Gets the current settings of the filter.- Specified by:
getOptions
in interfaceOptionHandler
- Returns:
- an array of strings suitable for passing to setOptions
-
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
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
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
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setClassValue
Sets the index of the class value to which SMOTE should be applied.- Parameters:
value
- the class value index
-
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
Sets the format of the input instances.- Overrides:
setInputFormat
in classFilter
- 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
Input an instance for filtering. Filter requires all training instances be read before producing output.- Overrides:
input
in classFilter
- 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
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 classFilter
- Returns:
- true if there are instances pending output
- Throws:
IllegalStateException
- if no input structure has been definedException
- if provided options cannot be executed on input instances
-
main
Main method for running this filter.- Parameters:
args
- should contain arguments to the filter: use -h for help
-