类 SpreadSubsample

java.lang.Object
weka.filters.Filter
weka.filters.supervised.instance.SpreadSubsample
所有已实现的接口:
Serializable, CapabilitiesHandler, OptionHandler, RevisionHandler, SupervisedFilter

public class SpreadSubsample extends Filter implements SupervisedFilter, OptionHandler
Produces a random subsample of a dataset. The original dataset must fit entirely in memory. This filter allows you to specify the maximum "spread" between the rarest and most common class. For example, you may specify that there be at most a 2:1 difference in class frequencies. When used in batch mode, subsequent batches are NOT resampled.

Valid options are:

 -S <num>
  Specify the random number seed (default 1)
 -M <num>
  The maximum class distribution spread.
  0 = no maximum spread, 1 = uniform distribution, 10 = allow at most
  a 10:1 ratio between the classes (default 0)
 -W
  Adjust weights so that total weight per class is maintained.
  Individual instance weighting is not preserved. (default no
  weights adjustment
 -X <num>
  The maximum count for any class value (default 0 = unlimited).
 
版本:
$Revision: 5542 $
作者:
Stuart Inglis (stuart@reeltwo.com)
另请参阅:
  • 构造器详细资料

    • SpreadSubsample

      public SpreadSubsample()
  • 方法详细资料

    • globalInfo

      public String globalInfo()
      Returns a string describing this filter
      返回:
      a description of the filter suitable for displaying in the explorer/experimenter gui
    • adjustWeightsTipText

      public String adjustWeightsTipText()
      Returns the tip text for this property
      返回:
      tip text for this property suitable for displaying in the explorer/experimenter gui
    • getAdjustWeights

      public boolean getAdjustWeights()
      Returns true if instance weights will be adjusted to maintain total weight per class.
      返回:
      true if instance weights will be adjusted to maintain total weight per class.
    • setAdjustWeights

      public void setAdjustWeights(boolean newAdjustWeights)
      Sets whether the instance weights will be adjusted to maintain total weight per class.
      参数:
      newAdjustWeights - whether to adjust weights
    • listOptions

      public Enumeration listOptions()
      Returns an enumeration describing the available options.
      指定者:
      listOptions 在接口中 OptionHandler
      返回:
      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>
        Specify the random number seed (default 1)
       -M <num>
        The maximum class distribution spread.
        0 = no maximum spread, 1 = uniform distribution, 10 = allow at most
        a 10:1 ratio between the classes (default 0)
       -W
        Adjust weights so that total weight per class is maintained.
        Individual instance weighting is not preserved. (default no
        weights adjustment
       -X <num>
        The maximum count for any class value (default 0 = unlimited).
       
      指定者:
      setOptions 在接口中 OptionHandler
      参数:
      options - the list of options as an array of strings
      抛出:
      Exception - if an option is not supported
    • getOptions

      public String[] getOptions()
      Gets the current settings of the filter.
      指定者:
      getOptions 在接口中 OptionHandler
      返回:
      an array of strings suitable for passing to setOptions
    • distributionSpreadTipText

      public String distributionSpreadTipText()
      Returns the tip text for this property
      返回:
      tip text for this property suitable for displaying in the explorer/experimenter gui
    • setDistributionSpread

      public void setDistributionSpread(double spread)
      Sets the value for the distribution spread
      参数:
      spread - the new distribution spread
    • getDistributionSpread

      public double getDistributionSpread()
      Gets the value for the distribution spread
      返回:
      the distribution spread
    • maxCountTipText

      public String maxCountTipText()
      Returns the tip text for this property
      返回:
      tip text for this property suitable for displaying in the explorer/experimenter gui
    • setMaxCount

      public void setMaxCount(double maxcount)
      Sets the value for the max count
      参数:
      maxcount - the new max count
    • getMaxCount

      public double getMaxCount()
      Gets the value for the max count
      返回:
      the max count
    • randomSeedTipText

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

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

      public void setRandomSeed(int newSeed)
      Sets the random number seed.
      参数:
      newSeed - the new random number seed.
    • getCapabilities

      public Capabilities getCapabilities()
      Returns the Capabilities of this filter.
      指定者:
      getCapabilities 在接口中 CapabilitiesHandler
      覆盖:
      getCapabilities 在类中 Filter
      返回:
      the capabilities of this object
      另请参阅:
    • setInputFormat

      public boolean setInputFormat(Instances instanceInfo) throws Exception
      Sets the format of the input instances.
      覆盖:
      setInputFormat 在类中 Filter
      参数:
      instanceInfo - an Instances object containing the input instance structure (any instances contained in the object are ignored - only the structure is required).
      返回:
      true if the outputFormat may be collected immediately
      抛出:
      UnassignedClassException - if no class attribute has been set.
      UnsupportedClassTypeException - if the class attribute is not nominal.
      Exception - if the inputFormat 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.
      覆盖:
      input 在类中 Filter
      参数:
      instance - the input instance
      返回:
      true if the filtered instance may now be collected with output().
      抛出:
      IllegalStateException - if no input structure has been defined
    • batchFinished

      public boolean 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.
      覆盖:
      batchFinished 在类中 Filter
      返回:
      true if there are instances pending output
      抛出:
      IllegalStateException - if no input structure has been defined
    • getRevision

      public String getRevision()
      Returns the revision string.
      指定者:
      getRevision 在接口中 RevisionHandler
      覆盖:
      getRevision 在类中 Filter
      返回:
      the revision
    • main

      public static void main(String[] argv)
      Main method for testing this class.
      参数:
      argv - should contain arguments to the filter: use -h for help