RandomSearch (multisearch 2021.2.17 API)

java.lang.Object
- weka.classifiers.meta.multisearch.AbstractSearch
- - weka.classifiers.meta.multisearch.AbstractMultiThreadedSearch
  - - weka.classifiers.meta.multisearch.RandomSearch

All Implemented Interfaces:: Serializable, Cloneable, TraceableOptimizer, weka.core.OptionHandler

public class RandomSearch
extends AbstractMultiThreadedSearch

Performs a search of an arbitrary number of parameters of a classifier and chooses the best pair found for the actual filtering and training.

Valid options are:

 -sample-size <num>
  The size (in percent) of the sample to search the inital space with.
  (default: 100)

 -num-folds <num>
  The number of cross-validation folds for the search space.
  Numbers smaller than 2 turn off cross-validation and
  just perform evaluation on the training set.
  (default: 2)

 -test-set <filename>
  The (optional) test set to use for the search space.
  Gets ignored if pointing to a file. Overrides cross-validation.
  (default: .)

 -num-iterations <num>
  The number parameter settings that are tried (i.e., number of points in the search space are checked).
  (default: 100)

 -S <num>
  The random seed

 -num-slots <num>
  Number of execution slots.
  (default 1 - i.e. no parallelism)

 -D
  Whether to enable debugging output.
  (default off)

General notes:

Turn the debug flag on in order to see some progress output in the console

Author:: FracPete (fracpete at waikato dot ac dot nz)
See Also:: Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class weka.classifiers.meta.multisearch.AbstractSearch
  AbstractSearch.SearchResult

Constructor Summary

Constructors
Constructor and Description

RandomSearch()

Constructors
Constructor and Description
`RandomSearch()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AbstractSearch.SearchResult`	`doSearch(weka.core.Instances data)` Performs the actual search and returns the best setup.
`int`	`getNumIterations()` Gets the number of iterations.
`String[]`	`getOptions()` returns the options of the current setup.
`Vector<Performance>`	`getPerformances()` Returns the performances of the last determineBestInSpace run, if this was ran with postClean argument set to false (for testing)
`int`	`getRandomSeed()` Gets the number of iterations.
`double`	`getSampleSizePercent()` Gets the sample size for the search space search.
`int`	`getSearchSpaceNumFolds()` Gets the number of CV folds for the search space.
`File`	`getSearchSpaceTestSet()` Gets the test set to use for the search space.
`String`	`globalInfo()` Returns a string describing the object.
`Enumeration`	`listOptions()` Gets an enumeration describing the available options.
`String`	`numIterationsTipText()` Returns the tip text for this property.
`String`	`randomSeedTipText()` Returns the tip text for this property.
`String`	`sampleSizePercentTipText()` Returns the tip text for this property.
`String`	`searchSpaceNumFoldsTipText()` Returns the tip text for this property.
`String`	`searchSpaceTestSetTipText()` Returns the tip text for this property.
`void`	`setNumIterations(int value)` Sets the number of iterations.
`void`	`setOptions(String[] options)` Parses the options for this object.
`void`	`setRandomSeed(int value)` Sets the random seed.
`void`	`setSampleSizePercent(double value)` Sets the sample size for the search space search.
`void`	`setSearchSpaceNumFolds(int value)` Sets the number of CV folds for the search space.
`void`	`setSearchSpaceTestSet(File value)` Sets the test set to use folds for the search space.

Methods inherited from class weka.classifiers.meta.multisearch.AbstractMultiThreadedSearch
cleanUpSearch, getNumExecutionSlots, numExecutionSlotsTipText, preSearch, setNumExecutionSlots

Methods inherited from class weka.classifiers.meta.multisearch.AbstractSearch
addPerformance, clone, debugTipText, getCommandline, getDebug, getSearchDimensions, getTrace, getTraceClassifierAsCli, getTraceFolds, getTraceParameterSettings, getTraceSize, getTraceValue, getValues, log, log, postSearch, retrieveOwner, search, setDebug, setOwner

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

Methods inherited from interface weka.core.OptionHandler
makeCopy

- Constructor Detail
  - RandomSearch
```
public RandomSearch()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Description copied from class: AbstractSearch
    
    Returns a string describing the object.
    
    Specified by:
    
    globalInfo in class AbstractSearch
    
    Returns:
    
    a description suitable for displaying in the explorer/experimenter gui
  - listOptions
```
public Enumeration listOptions()
```
    Gets an enumeration describing the available options.
    
    Specified by:
    
    listOptions in interface weka.core.OptionHandler
    
    Overrides:
    
    listOptions in class AbstractMultiThreadedSearch
    
    Returns:
    
    an enumeration of all the available options.
  - getOptions
```
public String[] getOptions()
```
    returns the options of the current setup.
    
    Specified by:
    
    getOptions in interface weka.core.OptionHandler
    
    Overrides:
    
    getOptions in class AbstractMultiThreadedSearch
    
    Returns:
    
    the current options
  - setOptions
```
public void setOptions(String[] options)
                throws Exception
```
    Parses the options for this object.
    
    Specified by:
    
    setOptions in interface weka.core.OptionHandler
    
    Overrides:
    
    setOptions in class AbstractMultiThreadedSearch
    
    Parameters:
    
    options - the options to use
    
    Throws:
    
    Exception - if setting of options fails
  - sampleSizePercentTipText
```
public String sampleSizePercentTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getSampleSizePercent
```
public double getSampleSizePercent()
```
    Gets the sample size for the search space search.
    
    Returns:
    
    the sample size.
  - setSampleSizePercent
```
public void setSampleSizePercent(double value)
```
    Sets the sample size for the search space search.
    
    Parameters:
    
    value - the sample size for the search space search.
  - searchSpaceNumFoldsTipText
```
public String searchSpaceNumFoldsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getSearchSpaceNumFolds
```
public int getSearchSpaceNumFolds()
```
    Gets the number of CV folds for the search space.
    
    Returns:
    
    the number of folds.
  - setSearchSpaceNumFolds
```
public void setSearchSpaceNumFolds(int value)
```
    Sets the number of CV folds for the search space.
    
    Parameters:
    
    value - the number of folds.
  - searchSpaceTestSetTipText
```
public String searchSpaceTestSetTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getSearchSpaceTestSet
```
public File getSearchSpaceTestSet()
```
    Gets the test set to use for the search space.
    
    Returns:
    
    the number of folds.
  - setSearchSpaceTestSet
```
public void setSearchSpaceTestSet(File value)
```
    Sets the test set to use folds for the search space.
    
    Parameters:
    
    value - the test set, ignored if dir.
  - numIterationsTipText
```
public String numIterationsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getNumIterations
```
public int getNumIterations()
```
    Gets the number of iterations.
    
    Returns:
    
    the number of folds.
  - setNumIterations
```
public void setNumIterations(int value)
```
    Sets the number of iterations.
    
    Parameters:
    
    value - the test set, ignored if dir.
  - 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 number of iterations.
    
    Returns:
    
    the number of folds.
  - setRandomSeed
```
public void setRandomSeed(int value)
```
    Sets the random seed.
    
    Parameters:
    
    value - the random seed
  - getPerformances
```
public Vector<Performance> getPerformances()
```
    Returns the performances of the last determineBestInSpace run, if this was ran with postClean argument set to false (for testing)
    
    Returns:
    
    vector of performances
  - doSearch
```
public AbstractSearch.SearchResult doSearch(weka.core.Instances data)
                                     throws Exception
```
    Performs the actual search and returns the best setup.
    
    Specified by:
    
    doSearch in class AbstractSearch
    
    Parameters:
    
    data - the dataset to use
    
    Returns:
    
    the best classifier setup
    
    Throws:
    
    Exception - if search fails

Class RandomSearch

Nested Class Summary

Nested classes/interfaces inherited from class weka.classifiers.meta.multisearch.AbstractSearch

Constructor Summary

Method Summary

Methods inherited from class weka.classifiers.meta.multisearch.AbstractMultiThreadedSearch

Methods inherited from class weka.classifiers.meta.multisearch.AbstractSearch

Methods inherited from class java.lang.Object

Methods inherited from interface weka.core.OptionHandler

Constructor Detail

RandomSearch

Method Detail

globalInfo

listOptions

getOptions

setOptions

sampleSizePercentTipText

getSampleSizePercent

setSampleSizePercent

searchSpaceNumFoldsTipText

getSearchSpaceNumFolds

setSearchSpaceNumFolds

searchSpaceTestSetTipText

getSearchSpaceTestSet

setSearchSpaceTestSet

numIterationsTipText

getNumIterations

setNumIterations

randomSeedTipText

getRandomSeed

setRandomSeed

getPerformances

doSearch