weka.classifiers.meta.multisearch

Class AbstractSearch

java.lang.Object

weka.classifiers.meta.multisearch.AbstractSearch

All Implemented Interfaces:

Serializable, Cloneable, TraceableOptimizer, weka.core.OptionHandler

Direct Known Subclasses:

AbstractMultiThreadedSearch

public abstract class AbstractSearch
extends Object
implements Serializable, Cloneable, weka.core.OptionHandler, TraceableOptimizer

Ancestor for search algorithms.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractSearch.SearchResult Container class for the search results.

Constructor Summary

Constructors

Constructor and Description
AbstractSearch()

Method Summary

Modifier and Type	Method and Description
void	addPerformance(Performance performance, int folds) Adds the performance to the cache and the current list of performances.
void	cleanUpSearch() Called after the search regardless whether successful or failed.
Object	clone() Returns a clone of itself.
String	debugTipText() Returns the tip text for this property
abstract AbstractSearch.SearchResult	doSearch(weka.core.Instances data) Performs the actual search and returns the best setup.
String	getCommandline(Object obj) Returns the commandline of the given object.
boolean	getDebug() Get whether debugging is turned on.
String[]	getOptions() returns the options of the current setup.
List<String>	getSearchDimensions() Returns the search dimensions
List<Map.Entry<Integer,Performance>>	getTrace() Returns the full trace.
String	getTraceClassifierAsCli(int index) Returns the CLI string of a given item in the trace.
Integer	getTraceFolds(int index) Returns the folds of a given item in the trace.
List<Map.Entry<String,Object>>	getTraceParameterSettings(int index) Returns the parameter settings in structured way
int	getTraceSize() Returns the size of m_Trace, which is technically the amount of setups that where tested in order to find the best.
Double	getTraceValue(int index) Returns the performance score of a given item in the trace.
Point<Object>	getValues() returns the parameter values that were found to work best.
abstract String	globalInfo() Returns a string describing the object.
Enumeration	listOptions() Gets an enumeration describing the available options.
void	log(String message) prints the specified message to stdout if debug is on and can also dump the message to a log file.
void	log(String message, boolean onlyLog) prints the specified message to stdout if debug is on and can also dump the message to a log file.
AbstractSearch.SearchResult	postSearch(weka.core.Instances data, AbstractSearch.SearchResult best) Called after the search has been executed.
void	preSearch(weka.core.Instances data) Called before the search is executed.
MultiSearchCapable	retrieveOwner() Returns the current owner.
AbstractSearch.SearchResult	search(weka.core.Instances data) Performs the search and returns the best setup.
void	setDebug(boolean debug) Set debugging mode.
void	setOptions(String[] options) Parses the options for this object.
void	setOwner(MultiSearchCapable value) Sets the owning classifier.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractSearch

public AbstractSearch()

Method Detail

globalInfo

public abstract String globalInfo()

Returns a string describing the object.

Returns:

a description suitable for displaying in the explorer/experimenter gui

setOwner

public void setOwner(MultiSearchCapable value)

Sets the owning classifier.

Parameters:

value - the owner

getSearchDimensions

public List<String> getSearchDimensions()

Returns the search dimensions

Returns:

a List with string values of the search dimensions

retrieveOwner

public MultiSearchCapable retrieveOwner()

Returns the current owner.

Returns:

the owner, null if none set

clone

public Object clone()

Returns a clone of itself.

Overrides:

clone in class Object

Returns:

a clone

listOptions

public Enumeration listOptions()

Gets an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

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

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

Parameters:

options - the options to use

Throws:

Exception - if setting of options fails

setDebug

public void setDebug(boolean debug)

Set debugging mode.

Parameters:

debug - true if debug output should be printed

getDebug

public boolean getDebug()

Get whether debugging is turned on.

Returns:

true if debugging output is on

debugTipText

public String debugTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

log

public void log(String message)

prints the specified message to stdout if debug is on and can also dump the message to a log file.

Parameters:

message - the message to print or store in a log file

log

public void log(String message,
                boolean onlyLog)

prints the specified message to stdout if debug is on and can also dump the message to a log file.

Parameters:

message - the message to print or store in a log file

onlyLog - if true the message will only be put into the log file but not to stdout

addPerformance

public void addPerformance(Performance performance,
                           int folds)

Adds the performance to the cache and the current list of performances.

Parameters:

performance - the performance to add

folds - the number of folds

getValues

public Point<Object> getValues()

returns the parameter values that were found to work best.

Returns:

the best parameter combination

getTraceSize

public int getTraceSize()

Returns the size of m_Trace, which is technically the amount of setups that where tested in order to find the best.

Specified by:

getTraceSize in interface TraceableOptimizer

Returns:

the number of setups tested

getTraceClassifierAsCli

public String getTraceClassifierAsCli(int index)

Returns the CLI string of a given item in the trace.

Specified by:

getTraceClassifierAsCli in interface TraceableOptimizer

Parameters:

index - the index of the trace item to obtain

Returns:

the commandline

getTraceValue

public Double getTraceValue(int index)

Returns the performance score of a given item in the trace.

Specified by:

getTraceValue in interface TraceableOptimizer

Parameters:

index - the index of the trace item to obtain

Returns:

the trace value

getTraceFolds

public Integer getTraceFolds(int index)

Returns the folds of a given item in the trace.

Specified by:

getTraceFolds in interface TraceableOptimizer

Parameters:

index - the index of the trace item to obtain

Returns:

the number of folds

getTraceParameterSettings

public List<Map.Entry<String,Object>> getTraceParameterSettings(int index)

Returns the parameter settings in structured way

Specified by:

getTraceParameterSettings in interface TraceableOptimizer

Parameters:

index - the index of the trace item to obtain

Returns:

the parameter settings

getTrace

public List<Map.Entry<Integer,Performance>> getTrace()

Returns the full trace.

Specified by:

getTrace in interface TraceableOptimizer

Returns:

the full trace

getCommandline

public String getCommandline(Object obj)

Returns the commandline of the given object.

Parameters:

obj - the object to create the commandline for

Returns:

the commandline

preSearch

public void preSearch(weka.core.Instances data)
               throws Exception

Called before the search is executed.
Default implementation only initializes the trace.

Parameters:

data - the dataset to use

Throws:

Exception - if search fails

doSearch

public abstract AbstractSearch.SearchResult doSearch(weka.core.Instances data)
                                              throws Exception

Performs the actual search and returns the best setup.

Parameters:

data - the dataset to use

Returns:

the best classifier setup

Throws:

Exception - if search fails

postSearch

public AbstractSearch.SearchResult postSearch(weka.core.Instances data,
                                              AbstractSearch.SearchResult best)
                                       throws Exception

Called after the search has been executed.
Default implementation does nothing.

Parameters:

data - the dataset to use

best - the best classifier setup

Returns:

the best classifier setup

Throws:

Exception - if search fails

search

public AbstractSearch.SearchResult search(weka.core.Instances data)
                                   throws Exception

Performs the search and returns the best setup.

Parameters:

data - the dataset to use

Returns:

the best classifier setup

Throws:

Exception - if search fails

cleanUpSearch

public void cleanUpSearch()

Called after the search regardless whether successful or failed.
Default implementation does nothing.