DefaultSearch (multisearch 2017.10.1 API)

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

All Implemented Interfaces:

Serializable, Cloneable, TraceableOptimizer, weka.core.OptionHandler
```
public class DefaultSearch
extends AbstractMultiThreadedSearch
```
Performs a search of an arbitrary number of parameters of a classifier and chooses the best setup found for the actual training.
The properties being explored are totally up to the user.

E.g., if you have a FilteredClassifier selected as base classifier, sporting a PLSFilter and you want to explore the number of PLS components, then your property will be made up of the following components:
- filter: referring to the FilteredClassifier's property (= PLSFilter)
- numComponents: the actual property of the PLSFilter that we want to modify
And assembled, the property looks like this:
filter.numComponents

The initial space is worked on with 2-fold CV to determine the values of the parameters for the selected type of evaluation (e.g., accuracy). The best point in the space is then taken as center and a 10-fold CV is performed with the adjacent parameters. If better parameters are found, then this will act as new center and another 10-fold CV will be performed (kind of hill-climbing). This process is repeated until no better pair is found or the best pair is on the border of the parameter space.
The number of CV-folds for the initial and subsequent spaces can be adjusted, of course.

Instead of using cross-validation, it is possible to specify test sets, for the initial space evaluation and the subsequent ones.

The outcome of a mathematical function (= double), MultiSearch will convert to integers (values are just cast to int), booleans (0 is false, otherwise true), float, char and long if necessary.
Via a user-supplied 'list' of parameters (blank-separated), one can also set strings and selected tags (drop-down comboboxes in Weka's GenericObjectEditor). Classnames with options (e.g., classifiers with their options) are possible as well.

Valid options are:
```
 -sample-size <num>
  The size (in percent) of the sample to search the inital space with.
  (default: 100)
```
```
 -initial-folds <num>
  The number of cross-validation folds for the initial space.
  Numbers smaller than 2 turn off cross-validation and just
  perform evaluation on the training set.
  (default: 2)
```
```
 -subsequent-folds <num>
  The number of cross-validation folds for the subsequent sub-spaces.
  Numbers smaller than 2 turn off cross-validation and just
  perform evaluation on the training set.
  (default: 10)
```
```
 -initial-test-set <filename>
  The (optional) test set to use for the initial space.
  Gets ignored if pointing to a file. Overrides cross-validation.
  (default: .)
```
```
 -subsequent-test-set <filename>
  The (optional) test set to use for the subsequent sub-spaces.
  Gets ignored if pointing to a file. Overrides cross-validation.
  (default: .)
```
```
 -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
Version:

$Revision$

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

DefaultSearch()

Constructors
Constructor and Description
`DefaultSearch()`

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`	`getInitialSpaceNumFolds()` Gets the number of CV folds for the initial space.
`File`	`getInitialSpaceTestSet()` Gets the test set to use for the initial space.
`String[]`	`getOptions()` returns the options of the current setup.
`double`	`getSampleSizePercent()` Gets the sample size for the initial space search.
`int`	`getSubsequentSpaceNumFolds()` Gets the number of CV folds for the sub-sequent sub-spaces.
`File`	`getSubsequentSpaceTestSet()` Gets the test set to use for the sub-sequent sub-spaces.
`String`	`globalInfo()` Returns a string describing the object.
`String`	`initialSpaceNumFoldsTipText()` Returns the tip text for this property.
`String`	`initialSpaceTestSetTipText()` Returns the tip text for this property.
`Enumeration`	`listOptions()` Gets an enumeration describing the available options.
`String`	`sampleSizePercentTipText()` Returns the tip text for this property.
`void`	`setInitialSpaceNumFolds(int value)` Sets the number of CV folds for the initial space.
`void`	`setInitialSpaceTestSet(File value)` Sets the test set to use folds for the initial space.
`void`	`setOptions(String[] options)` Parses the options for this object.
`void`	`setSampleSizePercent(double value)` Sets the sample size for the initial space search.
`void`	`setSubsequentSpaceNumFolds(int value)` Sets the number of CV folds for the sub-sequent sub-spaces.
`void`	`setSubsequentSpaceTestSet(File value)` Sets the test set to use for the sub-sequent sub-spaces.
`String`	`subsequentSpaceNumFoldsTipText()` Returns the tip text for this property.
`String`	`subsequentSpaceTestSetTipText()` Returns the tip text for this property.

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

- Constructor Detail
  - DefaultSearch
```
public DefaultSearch()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    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 initial space search.
    
    Returns:
    
    the sample size.
  - setSampleSizePercent
```
public void setSampleSizePercent(double value)
```
    Sets the sample size for the initial space search.
    
    Parameters:
    
    value - the sample size for the initial space search.
  - initialSpaceNumFoldsTipText
```
public String initialSpaceNumFoldsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getInitialSpaceNumFolds
```
public int getInitialSpaceNumFolds()
```
    Gets the number of CV folds for the initial space.
    
    Returns:
    
    the number of folds.
  - setInitialSpaceNumFolds
```
public void setInitialSpaceNumFolds(int value)
```
    Sets the number of CV folds for the initial space.
    
    Parameters:
    
    value - the number of folds.
  - subsequentSpaceNumFoldsTipText
```
public String subsequentSpaceNumFoldsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getSubsequentSpaceNumFolds
```
public int getSubsequentSpaceNumFolds()
```
    Gets the number of CV folds for the sub-sequent sub-spaces.
    
    Returns:
    
    the number of folds.
  - setSubsequentSpaceNumFolds
```
public void setSubsequentSpaceNumFolds(int value)
```
    Sets the number of CV folds for the sub-sequent sub-spaces.
    
    Parameters:
    
    value - the number of folds.
  - initialSpaceTestSetTipText
```
public String initialSpaceTestSetTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getInitialSpaceTestSet
```
public File getInitialSpaceTestSet()
```
    Gets the test set to use for the initial space.
    
    Returns:
    
    the number of folds.
  - setInitialSpaceTestSet
```
public void setInitialSpaceTestSet(File value)
```
    Sets the test set to use folds for the initial space.
    
    Parameters:
    
    value - the test set, ignored if dir.
  - subsequentSpaceTestSetTipText
```
public String subsequentSpaceTestSetTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getSubsequentSpaceTestSet
```
public File getSubsequentSpaceTestSet()
```
    Gets the test set to use for the sub-sequent sub-spaces.
    
    Returns:
    
    the test set, ignored if dir.
  - setSubsequentSpaceTestSet
```
public void setSubsequentSpaceTestSet(File value)
```
    Sets the test set to use for the sub-sequent sub-spaces.
    
    Parameters:
    
    value - the test set, ignored if dir.
  - 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 DefaultSearch

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

Constructor Detail

DefaultSearch

Method Detail

globalInfo

listOptions

getOptions

setOptions

sampleSizePercentTipText

getSampleSizePercent

setSampleSizePercent

initialSpaceNumFoldsTipText

getInitialSpaceNumFolds

setInitialSpaceNumFolds

subsequentSpaceNumFoldsTipText

getSubsequentSpaceNumFolds

setSubsequentSpaceNumFolds

initialSpaceTestSetTipText

getInitialSpaceTestSet

setInitialSpaceTestSet

subsequentSpaceTestSetTipText

getSubsequentSpaceTestSet

setSubsequentSpaceTestSet

doSearch