All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home

Class weka.experiment.LearningRateResultProducer

java.lang.Object
    |
    +----weka.experiment.LearningRateResultProducer

public class LearningRateResultProducer
extends java.lang.Object
implements ResultListener, ResultProducer, OptionHandler, AdditionalMeasureProducer
LearningRateResultProducer takes the results from a ResultProducer and submits the average to the result listener. For non-numeric result fields, the first value is used.

Version:
$Revision: 1.4 $
Author:
Len Trigg (trigg@cs.waikato.ac.nz)

Variable Index

 o STEP_FIELD_NAME
 

Constructor Index

 o LearningRateResultProducer()
 

Method Index

 o acceptResult(ResultProducer, Object[], Object[])
Accepts results from a ResultProducer.
 o determineColumnConstraints(ResultProducer)
Determines if there are any constraints (imposed by the destination) on the result columns to be produced by resultProducers.
 o doRun(int)
Gets the results for a specified run number.
 o doRunKeys(int)
Gets the keys for a specified run number.
 o enumerateMeasures()
Returns an enumeration of any additional measure names that might be in the result producer
 o getCompatibilityState()
Gets a description of the internal settings of the result producer, sufficient for distinguishing a ResultProducer instance from another with different settings (ignoring those settings set through this interface).
 o getKeyNames()
Gets the names of each of the columns produced for a single run.
 o getKeyTypes()
Gets the data types of each of the columns produced for a single run.
 o getLowerSize()
Get the value of LowerSize.
 o getMeasure(String)
Returns the value of the named measure
 o getOptions()
Gets the current settings of the result producer.
 o getResultNames()
Gets the names of each of the columns produced for a single run.
 o getResultProducer()
Get the ResultProducer.
 o getResultTypes()
Gets the data types of each of the columns produced for a single run.
 o getStepSize()
Get the value of StepSize.
 o getUpperSize()
Get the value of UpperSize.
 o globalInfo()
Returns a string describing this result producer
 o isResultRequired(ResultProducer, Object[])
Determines whether the results for a specified key must be generated.
 o listOptions()
Returns an enumeration describing the available options.
 o lowerSizeTipText()
Returns the tip text for this property
 o postProcess()
When this method is called, it indicates that no more requests to generate results for the current experiment will be sent.
 o postProcess(ResultProducer)
When this method is called, it indicates that no more results will be sent that need to be grouped together in any way.
 o preProcess()
Prepare to generate results.
 o preProcess(ResultProducer)
Prepare for the results to be received.
 o resultProducerTipText()
Returns the tip text for this property
 o setAdditionalMeasures(String[])
Set a list of method names for additional measures to look for in SplitEvaluators.
 o setInstances(Instances)
Sets the dataset that results will be obtained for.
 o setLowerSize(int)
Set the value of LowerSize.
 o setOptions(String[])
Parses a given list of options.
 o setResultListener(ResultListener)
Sets the object to send results of each run to.
 o setResultProducer(ResultProducer)
Set the ResultProducer.
 o setStepSize(int)
Set the value of StepSize.
 o setUpperSize(int)
Set the value of UpperSize.
 o stepSizeTipText()
Returns the tip text for this property
 o toString()
Gets a text descrption of the result producer.
 o upperSizeTipText()
Returns the tip text for this property

Field Detail

 o STEP_FIELD_NAME
public static java.lang.String STEP_FIELD_NAME

Constructor Detail

 o LearningRateResultProducer
public LearningRateResultProducer()

Method Detail

 o globalInfo
public java.lang.String globalInfo()
          Returns a string describing this result producer
Returns:
a description of the result producer suitable for displaying in the explorer/experimenter gui
 o determineColumnConstraints
public java.lang.String[] determineColumnConstraints(ResultProducer rp) throws java.lang.Exception
          Determines if there are any constraints (imposed by the destination) on the result columns to be produced by resultProducers. Null should be returned if there are NO constraints, otherwise a list of column names should be returned as an array of Strings.
Parameters:
rp - the ResultProducer to which the constraints will apply
Returns:
an array of column names to which resutltProducer's results will be restricted.
Throws:
java.lang.Exception - if constraints can't be determined
 o doRunKeys
public void doRunKeys(int run) throws java.lang.Exception
          Gets the keys for a specified run number. Different run numbers correspond to different randomizations of the data. Keys produced should be sent to the current ResultListener
Parameters:
run - the run number to get keys for.
Throws:
java.lang.Exception - if a problem occurs while getting the keys
 o doRun
public void doRun(int run) throws java.lang.Exception
          Gets the results for a specified run number. Different run numbers correspond to different randomizations of the data. Results produced should be sent to the current ResultListener
Parameters:
run - the run number to get results for.
Throws:
java.lang.Exception - if a problem occurs while getting the results
 o preProcess
public void preProcess(ResultProducer rp) throws java.lang.Exception
          Prepare for the results to be received.
Parameters:
rp - the ResultProducer that will generate the results
Throws:
java.lang.Exception - if an error occurs during preprocessing.
 o preProcess
public void preProcess() throws java.lang.Exception
          Prepare to generate results. The ResultProducer should call preProcess(this) on the ResultListener it is to send results to.
Throws:
java.lang.Exception - if an error occurs during preprocessing.
 o postProcess
public void postProcess(ResultProducer rp) throws java.lang.Exception
          When this method is called, it indicates that no more results will be sent that need to be grouped together in any way.
Parameters:
rp - the ResultProducer that generated the results
Throws:
java.lang.Exception - if an error occurs
 o postProcess
public void postProcess() throws java.lang.Exception
          When this method is called, it indicates that no more requests to generate results for the current experiment will be sent. The ResultProducer should call preProcess(this) on the ResultListener it is to send results to.
Throws:
java.lang.Exception - if an error occurs
 o acceptResult
public void acceptResult(ResultProducer rp,
                         java.lang.Object key[],
                         java.lang.Object result[]) throws java.lang.Exception
          Accepts results from a ResultProducer.
Parameters:
rp - the ResultProducer that generated the results
key - an array of Objects (Strings or Doubles) that uniquely identify a result for a given ResultProducer with given compatibilityState
result - the results stored in an array. The objects stored in the array may be Strings, Doubles, or null (for the missing value).
Throws:
java.lang.Exception - if the result could not be accepted.
 o isResultRequired
public boolean isResultRequired(ResultProducer rp,
                                java.lang.Object key[]) throws java.lang.Exception
          Determines whether the results for a specified key must be generated.
Parameters:
rp - the ResultProducer wanting to generate the results
key - an array of Objects (Strings or Doubles) that uniquely identify a result for a given ResultProducer with given compatibilityState
Returns:
true if the result should be generated
Throws:
java.lang.Exception - if it could not be determined if the result is needed.
 o getKeyNames
public java.lang.String[] getKeyNames() throws java.lang.Exception
          Gets the names of each of the columns produced for a single run.
Returns:
an array containing the name of each column
Throws:
java.lang.Exception - if key names cannot be generated
 o getKeyTypes
public java.lang.Object[] getKeyTypes() throws java.lang.Exception
          Gets the data types of each of the columns produced for a single run. This method should really be static.
Returns:
an array containing objects of the type of each column. The objects should be Strings, or Doubles.
Throws:
java.lang.Exception - if the key types could not be determined (perhaps because of a problem from a nested sub-resultproducer)
 o getResultNames
public java.lang.String[] getResultNames() throws java.lang.Exception
          Gets the names of each of the columns produced for a single run. A new result field is added for the number of results used to produce each average. If only averages are being produced the names are not altered, if standard deviations are produced then "Dev_" and "Avg_" are prepended to each result deviation and average field respectively.
Returns:
an array containing the name of each column
Throws:
java.lang.Exception - if the result names could not be determined (perhaps because of a problem from a nested sub-resultproducer)
 o getResultTypes
public java.lang.Object[] getResultTypes() throws java.lang.Exception
          Gets the data types of each of the columns produced for a single run.
Returns:
an array containing objects of the type of each column. The objects should be Strings, or Doubles.
Throws:
java.lang.Exception - if the result types could not be determined (perhaps because of a problem from a nested sub-resultproducer)
 o getCompatibilityState
public java.lang.String getCompatibilityState()
          Gets a description of the internal settings of the result producer, sufficient for distinguishing a ResultProducer instance from another with different settings (ignoring those settings set through this interface). For example, a cross-validation ResultProducer may have a setting for the number of folds. For a given state, the results produced should be compatible. Typically if a ResultProducer is an OptionHandler, this string will represent the command line arguments required to set the ResultProducer to that state.
Returns:
the description of the ResultProducer state, or null if no state is defined
 o listOptions
public java.util.Enumeration listOptions()
          Returns an enumeration describing the available options.
Returns:
an enumeration of all the available options
 o setOptions
public void setOptions(java.lang.String options[]) throws java.lang.Exception
          Parses a given list of options. Valid options are:

-L num
The lowest number of instances to use. (default 0 = stepsize)

-U num
The upper number of instances to use. (default -1 = no limit)

-S num
The number of instances to add at each step. (default 10)

-W classname
Specify the full class name of the result producer.

All option after -- will be passed to the result producer.

Parameters:
options - the list of options as an array of strings
Throws:
java.lang.Exception - if an option is not supported
 o getOptions
public java.lang.String[] getOptions()
          Gets the current settings of the result producer.
Returns:
an array of strings suitable for passing to setOptions
 o setAdditionalMeasures
public void setAdditionalMeasures(java.lang.String additionalMeasures[])
          Set a list of method names for additional measures to look for in SplitEvaluators. This could contain many measures (of which only a subset may be produceable by the current resultProducer) if an experiment is the type that iterates over a set of properties.
Parameters:
additionalMeasures - an array of measure names, null if none
 o enumerateMeasures
public java.util.Enumeration enumerateMeasures()
          Returns an enumeration of any additional measure names that might be in the result producer
Returns:
an enumeration of the measure names
 o getMeasure
public double getMeasure(java.lang.String additionalMeasureName)
          Returns the value of the named measure
Parameters:
measureName - the name of the measure to query for its value
Returns:
the value of the named measure
Throws:
java.lang.IllegalArgumentException - if the named measure is not supported
 o setInstances
public void setInstances(Instances instances)
          Sets the dataset that results will be obtained for.
Parameters:
instances - a value of type 'Instances'.
 o lowerSizeTipText
public java.lang.String lowerSizeTipText()
          Returns the tip text for this property
Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui
 o getLowerSize
public int getLowerSize()
          Get the value of LowerSize.
Returns:
Value of LowerSize.
 o setLowerSize
public void setLowerSize(int newLowerSize)
          Set the value of LowerSize.
Parameters:
newLowerSize - Value to assign to LowerSize.
 o upperSizeTipText
public java.lang.String upperSizeTipText()
          Returns the tip text for this property
Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui
 o getUpperSize
public int getUpperSize()
          Get the value of UpperSize.
Returns:
Value of UpperSize.
 o setUpperSize
public void setUpperSize(int newUpperSize)
          Set the value of UpperSize.
Parameters:
newUpperSize - Value to assign to UpperSize.
 o stepSizeTipText
public java.lang.String stepSizeTipText()
          Returns the tip text for this property
Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui
 o getStepSize
public int getStepSize()
          Get the value of StepSize.
Returns:
Value of StepSize.
 o setStepSize
public void setStepSize(int newStepSize)
          Set the value of StepSize.
Parameters:
newStepSize - Value to assign to StepSize.
 o setResultListener
public void setResultListener(ResultListener listener)
          Sets the object to send results of each run to.
Parameters:
listener - a value of type 'ResultListener'
 o resultProducerTipText
public java.lang.String resultProducerTipText()
          Returns the tip text for this property
Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui
 o getResultProducer
public ResultProducer getResultProducer()
          Get the ResultProducer.
Returns:
the ResultProducer.
 o setResultProducer
public void setResultProducer(ResultProducer newResultProducer)
          Set the ResultProducer.
Parameters:
newResultProducer - new ResultProducer to use.
 o toString
public java.lang.String toString()
          Gets a text descrption of the result producer.
Returns:
a text description of the result producer.
Overrides:
toString in class java.lang.Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home