learningrateresultproducer.html

weka是机器学习和数据挖掘领域最有影响力的开源项目之一

<DD><CODE>java.lang.Exception</CODE> - if an error occurs during preprocessing.</DL>
</DD>
</DL>
<HR>

<A NAME="postProcess(weka.experiment.ResultProducer)"><!-- --></A><H3>
postProcess</H3>
<PRE>
public void <B>postProcess</B>(<A HREF="../../weka/experiment/ResultProducer.html" title="interface in weka.experiment">ResultProducer</A>&nbsp;rp)
                 throws java.lang.Exception</PRE>
<DL>
<DD>When this method is called, it indicates that no more results
 will be sent that need to be grouped together in any way.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../weka/experiment/ResultListener.html#postProcess(weka.experiment.ResultProducer)">postProcess</A></CODE> in interface <CODE><A HREF="../../weka/experiment/ResultListener.html" title="interface in weka.experiment">ResultListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>rp</CODE> - the ResultProducer that generated the results
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE> - if an error occurs</DL>
</DD>
</DL>
<HR>

<A NAME="postProcess()"><!-- --></A><H3>
postProcess</H3>
<PRE>
public void <B>postProcess</B>()
                 throws java.lang.Exception</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../weka/experiment/ResultProducer.html#postProcess()">postProcess</A></CODE> in interface <CODE><A HREF="../../weka/experiment/ResultProducer.html" title="interface in weka.experiment">ResultProducer</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE> - if an error occurs</DL>
</DD>
</DL>
<HR>

<A NAME="acceptResult(weka.experiment.ResultProducer, java.lang.Object[], java.lang.Object[])"><!-- --></A><H3>
acceptResult</H3>
<PRE>
public void <B>acceptResult</B>(<A HREF="../../weka/experiment/ResultProducer.html" title="interface in weka.experiment">ResultProducer</A>&nbsp;rp,
                         java.lang.Object[]&nbsp;key,
                         java.lang.Object[]&nbsp;result)
                  throws java.lang.Exception</PRE>
<DL>
<DD>Accepts results from a ResultProducer.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../weka/experiment/ResultListener.html#acceptResult(weka.experiment.ResultProducer, java.lang.Object[], java.lang.Object[])">acceptResult</A></CODE> in interface <CODE><A HREF="../../weka/experiment/ResultListener.html" title="interface in weka.experiment">ResultListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>rp</CODE> - the ResultProducer that generated the results<DD><CODE>key</CODE> - an array of Objects (Strings or Doubles) that uniquely
 identify a result for a given ResultProducer with given compatibilityState<DD><CODE>result</CODE> - the results stored in an array. The objects stored in
 the array may be Strings, Doubles, or null (for the missing value).
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE> - if the result could not be accepted.</DL>
</DD>
</DL>
<HR>

<A NAME="isResultRequired(weka.experiment.ResultProducer, java.lang.Object[])"><!-- --></A><H3>
isResultRequired</H3>
<PRE>
public boolean <B>isResultRequired</B>(<A HREF="../../weka/experiment/ResultProducer.html" title="interface in weka.experiment">ResultProducer</A>&nbsp;rp,
                                java.lang.Object[]&nbsp;key)
                         throws java.lang.Exception</PRE>
<DL>
<DD>Determines whether the results for a specified key must be
 generated.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../weka/experiment/ResultListener.html#isResultRequired(weka.experiment.ResultProducer, java.lang.Object[])">isResultRequired</A></CODE> in interface <CODE><A HREF="../../weka/experiment/ResultListener.html" title="interface in weka.experiment">ResultListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>rp</CODE> - the ResultProducer wanting to generate the results<DD><CODE>key</CODE> - an array of Objects (Strings or Doubles) that uniquely
 identify a result for a given ResultProducer with given compatibilityState
<DT><B>Returns:</B><DD>true if the result should be generated
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE> - if it could not be determined if the result 
 is needed.</DL>
</DD>
</DL>
<HR>

<A NAME="getKeyNames()"><!-- --></A><H3>
getKeyNames</H3>
<PRE>
public java.lang.String[] <B>getKeyNames</B>()
                               throws java.lang.Exception</PRE>
<DL>
<DD>Gets the names of each of the columns produced for a single run.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../weka/experiment/ResultProducer.html#getKeyNames()">getKeyNames</A></CODE> in interface <CODE><A HREF="../../weka/experiment/ResultProducer.html" title="interface in weka.experiment">ResultProducer</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an array containing the name of each column
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE> - if key names cannot be generated</DL>
</DD>
</DL>
<HR>

<A NAME="getKeyTypes()"><!-- --></A><H3>
getKeyTypes</H3>
<PRE>
public java.lang.Object[] <B>getKeyTypes</B>()
                               throws java.lang.Exception</PRE>
<DL>
<DD>Gets the data types of each of the columns produced for a single run.
 This method should really be static.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../weka/experiment/ResultProducer.html#getKeyTypes()">getKeyTypes</A></CODE> in interface <CODE><A HREF="../../weka/experiment/ResultProducer.html" title="interface in weka.experiment">ResultProducer</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an array containing objects of the type of each column. The 
 objects should be Strings, or Doubles.
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE> - if the key types could not be determined (perhaps
 because of a problem from a nested sub-resultproducer)</DL>
</DD>
</DL>
<HR>

<A NAME="getResultNames()"><!-- --></A><H3>
getResultNames</H3>
<PRE>
public java.lang.String[] <B>getResultNames</B>()
                                  throws java.lang.Exception</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../weka/experiment/ResultProducer.html#getResultNames()">getResultNames</A></CODE> in interface <CODE><A HREF="../../weka/experiment/ResultProducer.html" title="interface in weka.experiment">ResultProducer</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an array containing the name of each column
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE> - if the result names could not be determined (perhaps
 because of a problem from a nested sub-resultproducer)</DL>
</DD>
</DL>
<HR>

<A NAME="getResultTypes()"><!-- --></A><H3>
getResultTypes</H3>
<PRE>
public java.lang.Object[] <B>getResultTypes</B>()
                                  throws java.lang.Exception</PRE>
<DL>
<DD>Gets the data types of each of the columns produced for a single run.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../weka/experiment/ResultProducer.html#getResultTypes()">getResultTypes</A></CODE> in interface <CODE><A HREF="../../weka/experiment/ResultProducer.html" title="interface in weka.experiment">ResultProducer</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an array containing objects of the type of each column. The 
 objects should be Strings, or Doubles.
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE> - if the result types could not be determined (perhaps
 because of a problem from a nested sub-resultproducer)</DL>
</DD>
</DL>
<HR>

<A NAME="getCompatibilityState()"><!-- --></A><H3>
getCompatibilityState</H3>
<PRE>
public java.lang.String <B>getCompatibilityState</B>()</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../weka/experiment/ResultProducer.html#getCompatibilityState()">getCompatibilityState</A></CODE> in interface <CODE><A HREF="../../weka/experiment/ResultProducer.html" title="interface in weka.experiment">ResultProducer</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the description of the ResultProducer state, or null
 if no state is defined</DL>
</DD>
</DL>
<HR>

<A NAME="listOptions()"><!-- --></A><H3>
listOptions</H3>
<PRE>
public java.util.Enumeration <B>listOptions</B>()</PRE>
<DL>
<DD>Returns an enumeration describing the available options..
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../weka/core/OptionHandler.html#listOptions()">listOptions</A></CODE> in interface <CODE><A HREF="../../weka/core/OptionHandler.html" title="interface in weka.core">OptionHandler</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an enumeration of all the available options.</DL>
</DD>
</DL>
<HR>

<A NAME="setOptions(java.lang.String[])"><!-- --></A><H3>
setOptions</H3>
<PRE>
public void <B>setOptions</B>(java.lang.String[]&nbsp;options)
                throws java.lang.Exception</PRE>
<DL>
<DD>Parses a given list of options. <p/>

   <!-- options-start -->
 Valid options are: <p/>
 
 <pre> -X &lt;num steps&gt;
  The number of steps in the learning rate curve.
  (default 10)</pre>
 
 <pre> -W &lt;class name&gt;
  The full class name of a ResultProducer.
  eg: weka.experiment.CrossValidationResultProducer</pre>
 
 <pre> 
 Options specific to result producer weka.experiment.AveragingResultProducer:
 </pre>
 
 <pre> -F &lt;field name&gt;
  The name of the field to average over.
  (default "Fold")</pre>
 
 <pre> -X &lt;num results&gt;
  The number of results expected per average.
  (default 10)</pre>
 
 <pre> -S
  Calculate standard deviations.
  (default only averages)</pre>
 
 <pre> -W &lt;class name&gt;
  The full class name of a ResultProducer.
  eg: weka.experiment.CrossValidationResultProducer</pre>
 
 <pre> 
 Options specific to result producer weka.experiment.CrossValidationResultProducer:
 </pre>
 
 <pre> -X &lt;number of folds&gt;
  The number of folds to use for the cross-validation.
  (default 10)</pre>
 
 <pre> -D
 Save raw split evaluator output.</pre>
 
 <pre> -O &lt;file/directory name/path&gt;
  The filename where raw output will be stored.
  If a directory name is specified then then individual
  outputs will be gzipped, otherwise all output will be
  zipped to the named file. Use in conjuction with -D. (default splitEvalutorOut.zip)</pre>
 
 <pre> -W &lt;class name&gt;
  The full class name of a SplitEvaluator.
  eg: weka.experiment.ClassifierSplitEvaluator</pre>
 
 <pre> 
 Options specific to split evaluator weka.experiment.ClassifierSplitEvaluator:
 </pre>
 
 <pre> -W &lt;class name&gt;
  The full class name of the classifier.
  eg: weka.classifiers.bayes.NaiveBayes</pre>
 
 <pre> -C &lt;index&gt;
  The index of the class for which IR statistics
  are to be output. (default 1)</pre>
 
 <pre> -I &lt;index&gt;
  The index of an attribute to output in the
  results. This attribute should identify an
  instance in order to know which instances are
  in the test set of a cross validation. if 0
  no output (default 0).</pre>
 
 <pre> -P
  Add target and prediction columns to the result
  for each fold.</pre>
 
 <pre> 
 Options specific to classifier weka.classifiers.rules.ZeroR:
 </pre>
 
 <pre> -D
  If set, classifier is run in debug mode and
  may output additional info to the console</pre>
 
   <!-- options-end -->

 All options after -- will be passed to the result producer.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../weka/core/OptionHandler.html#setOptions(java.lang.String[])">setOptions</A></CODE> in interface <CODE><A HREF="../../weka/core/OptionHandler.html" title="interface in weka.core">OptionHandler</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>options</CODE> - the list of options as an array of strings
<DT><B>Throws:</B>
<DD><CODE>java.lang.Exception</CODE> - if an option is not supported</DL>
</DD>
</DL>
<HR>

<A NAME="getOptions()"><!-- --></A><H3>
getOptions</H3>
<PRE>
public java.lang.String[] <B>getOptions</B>()</PRE>
<DL>
<DD>Gets the current settings of the result producer.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../weka/core/OptionHandler.html#getOptions()">getOptions</A></CODE> in interface <CODE><A HREF="../../weka/core/OptionHandler.html" title="interface in weka.core">OptionHandler</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an array of strings suitable for passing to setOptions</DL>
</DD>
</DL>
<HR>

<A NAME="setAdditionalMeasures(java.lang.String[])"><!-- --></A><H3>
setAdditionalMeasures</H3>
<PRE>
public void <B>setAdditionalMeasures</B>(java.lang.String[]&nbsp;additionalMeasures)</PRE>
<DL>
<DD>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.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../weka/experiment/ResultProducer.html#setAdditionalMeasures(java.lang.String[])">setAdditionalMeasures</A></CODE> in interface <CODE><A HREF="../../weka/experiment/ResultProducer.html" title="interface in weka.experiment">ResultProducer</A></CODE></DL>
</DD>