All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
weka.classifiers.meta.multisearch.AbstractSearch Maven / Gradle / Ivy
/*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see > m_Trace;
/**
* Container class for the search results.
*
* @author FracPete (fracpete at waikato dot ac dot nz)
* @version $Revision$
*/
public static class SearchResult
implements Serializable {
private static final long serialVersionUID = -5322332623001051928L;
public Classifier classifier = null;
public Performance performance = null;
public Point values = null;
}
/** the owner. */
protected transient MultiSearchCapable m_Owner;
/** the debug flag. */
protected boolean m_Debug;
/** the parameter space. */
protected Space m_Space;
/** the number of setups to evaluate. */
protected int m_NumSetups;
/** for storing the performances. */
protected Vector m_Performances;
/** the cache for points in the space that got calculated
* (raw points in space, not evaluated ones!). */
protected PerformanceCache m_Cache;
/** whether all performances in the space are the same. */
protected boolean m_UniformPerformance = false;
/** the best values. */
protected Point m_Values = null;
/**
* Returns a string describing the object.
*
* @return a description suitable for displaying in the
* explorer/experimenter gui
*/
public abstract String globalInfo();
/**
* Sets the owning classifier.
*
* @param value the owner
*/
public void setOwner(MultiSearchCapable value) {
m_Owner = value;
}
/**
* Returns the search dimensions
*
* @return a List with string values of the search dimensions
*/
public List getSearchDimensions() {
List dimensions = new ArrayList();
for (int i = 0; i < m_Space.dimensions(); ++i) {
dimensions.add(m_Space.getDimension(i).getLabel());
}
return dimensions;
}
/**
* Returns the current owner.
*
* @return the owner, null if none set
*/
public MultiSearchCapable retrieveOwner() {
return m_Owner;
}
/**
* Returns a clone of itself.
*
* @return a clone
*/
public Object clone() {
AbstractSearch result;
try {
result = (AbstractSearch) getClass().newInstance();
result.setOptions(getOptions());
}
catch (Exception e) {
result = null;
e.printStackTrace();
}
return result;
}
/**
* Gets an enumeration describing the available options.
*
* @return an enumeration of all the available options.
*/
@Override
public Enumeration listOptions() {
Vector result;
result = new Vector();
result.addElement(new Option(
"\tWhether to enable debugging output.\n"
+ "\t(default off)",
"D", 0, "-D"));
return result.elements();
}
/**
* returns the options of the current setup.
*
* @return the current options
*/
@Override
public String[] getOptions() {
List result;
result = new ArrayList();
if (getDebug())
result.add("-D");
return result.toArray(new String[result.size()]);
}
/**
* Parses the options for this object.
*
* @param options the options to use
* @throws Exception if setting of options fails
*/
@Override
public void setOptions(String[] options) throws Exception {
setDebug(Utils.getFlag("D", options));
Utils.checkForRemainingOptions(options);
}
/**
* Set debugging mode.
*
* @param debug true if debug output should be printed
*/
public void setDebug(boolean debug) {
m_Debug = debug;
}
/**
* Get whether debugging is turned on.
*
* @return true if debugging output is on
*/
public boolean getDebug() {
return m_Debug;
}
/**
* Returns the tip text for this property
*
* @return tip text for this property suitable for displaying in the
* explorer/experimenter gui
*/
public String debugTipText() {
return "If set to true, search may output additional info to the console.";
}
/**
* prints the specified message to stdout if debug is on and can also dump
* the message to a log file.
*
* @param message the message to print or store in a log file
*/
public void log(String message) {
m_Owner.log(message);
}
/**
* prints the specified message to stdout if debug is on and can also dump
* the message to a log file.
*
* @param message the message to print or store in a log file
* @param onlyLog if true the message will only be put into the log file
* but not to stdout
*/
public void log(String message, boolean onlyLog) {
m_Owner.log(message, onlyLog);
}
/**
* generates a table string for all the performances in the space and returns
* that.
*
* @param space the current space to align the performances to
* @param performances the performances to align
* @param type the type of performance
* @return the table string
*/
protected String logPerformances(Space space, Vector performances, Tag type) {
return m_Owner.logPerformances(space, performances, type);
}
/**
* aligns all performances in the space and prints those tables to the log
* file.
*
* @param space the current space to align the performances to
* @param performances the performances to align
*/
protected void logPerformances(Space space, Vector performances) {
m_Owner.logPerformances(space, performances);
}
/**
* Adds the performance to the cache and the current list of performances.
*
* @param performance the performance to add
* @param folds the number of folds
*/
public void addPerformance(Performance performance, int folds) {
m_Performances.add(performance);
m_Cache.add(folds, performance);
m_Trace.add(new AbstractMap.SimpleEntry(folds, performance));
}
/**
* returns the parameter values that were found to work best.
*
* @return the best parameter combination
*/
public Point getValues() {
return m_Values;
}
/**
* Returns the size of m_Trace, which is technically the amount of
* setups that where tested in order to find the best.
*/
public int getTraceSize() {
return m_Trace.size();
}
/**
* Returns the CLI string of a given item in the trace.
*
* @param index the index of the trace item to obtain
*/
public String getTraceClassifierAsCli(int index) {
return getCommandline(m_Trace.get(index).getValue().getClassifier());
}
/**
* Returns the performance score of a given item in the trace.
*
* @param index the index of the trace item to obtain
*/
public Double getTraceValue(int index) {
return m_Trace.get(index).getValue().getPerformance();
}
/**
* Returns the folds of a given item in the trace.
*
* @param index the index of the trace item to obtain
*/
public Integer getTraceFolds(int index) {
return m_Trace.get(index).getKey();
}
/**
* Returns the parameter settings in structured way
*
* @param index the index of the trace item to obtain
* @return the parameter settings
*/
public List> getTraceParameterSettings(int index) {
List> result = new ArrayList>();
List dimensions = getSearchDimensions();
for (int i = 0; i < dimensions.size(); ++i) {
String parameter = dimensions.get(i);
Object value = m_Trace.get(index).getValue().getValues().getValue(i);
Map.Entry current = new AbstractMap.SimpleEntry(parameter,value);
result.add(i, current);
}
return result;
}
/**
* Returns the full trace.
*/
public List> getTrace() {
return m_Trace;
}
/**
* Returns the commandline of the given object.
*
* @param obj the object to create the commandline for
* @return the commandline
*/
public String getCommandline(Object obj) {
return m_Owner.getCommandline(obj);
}
/**
* Hook method for performing checks.
* ();
m_Trace = new ArrayList>();
m_Owner.getGenerator().reset();
m_Space = m_Owner.getGenerator().getSpace();
}
/**
* Performs the actual search and returns the best setup.
*
* @param data the dataset to use
* @return the best classifier setup
* @throws Exception if search fails
*/
public abstract SearchResult doSearch(Instances data) throws Exception;
/**
* Called after the search has been executed.
*
