| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_121) on Fri Apr 14 22:11:36 PDT 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>AbstractOnlineLogisticRegression (Mahout Map-Reduce 0.13.0 API)</title> |
| <meta name="date" content="2017-04-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AbstractOnlineLogisticRegression (Mahout Map-Reduce 0.13.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":6,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9,"i14":9,"i15":10,"i16":10,"i17":10,"i18":6,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AbstractOnlineLogisticRegression.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../org/apache/mahout/classifier/sgd/AdaptiveLogisticRegression.html" title="class in org.apache.mahout.classifier.sgd"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html" target="_top">Frames</a></li> |
| <li><a href="AbstractOnlineLogisticRegression.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.mahout.classifier.sgd</div> |
| <h2 title="Class AbstractOnlineLogisticRegression" class="title">Class AbstractOnlineLogisticRegression</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html" title="class in org.apache.mahout.classifier">org.apache.mahout.classifier.AbstractVectorClassifier</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.mahout.classifier.sgd.AbstractOnlineLogisticRegression</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="../../../../../org/apache/mahout/classifier/OnlineLearner.html" title="interface in org.apache.mahout.classifier">OnlineLearner</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/apache/mahout/classifier/sgd/OnlineLogisticRegression.html" title="class in org.apache.mahout.classifier.sgd">OnlineLogisticRegression</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">AbstractOnlineLogisticRegression</span> |
| extends <a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html" title="class in org.apache.mahout.classifier">AbstractVectorClassifier</a> |
| implements <a href="../../../../../org/apache/mahout/classifier/OnlineLearner.html" title="interface in org.apache.mahout.classifier">OnlineLearner</a></pre> |
| <div class="block">Generic definition of a 1 of n logistic regression classifier that returns probabilities in |
| response to a feature vector. This classifier uses 1 of n-1 coding where the 0-th category |
| is not stored explicitly. |
| <p/> |
| Provides the SGD based algorithm for learning a logistic regression, but omits all |
| annealing of learning rates. Any extension of this abstract class must define the overall |
| and per-term annealing for themselves.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Matrix.html?is-external=true" title="class or interface in org.apache.mahout.math">Matrix</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#beta">beta</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#numCategories">numCategories</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/mahout/classifier/sgd/PriorFunction.html" title="interface in org.apache.mahout.classifier.sgd">PriorFunction</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#prior">prior</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#step">step</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#updateCounts">updateCounts</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#updateSteps">updateSteps</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.mahout.classifier.AbstractVectorClassifier"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.mahout.classifier.<a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html" title="class in org.apache.mahout.classifier">AbstractVectorClassifier</a></h3> |
| <code><a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html#MIN_LOG_LIKELIHOOD">MIN_LOG_LIKELIHOOD</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#AbstractOnlineLogisticRegression--">AbstractOnlineLogisticRegression</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#classify-org.apache.mahout.math.Vector-">classify</a></span>(<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> instance)</code> |
| <div class="block">Returns n-1 probabilities, one for each category but the 0-th.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#classifyNoLink-org.apache.mahout.math.Vector-">classifyNoLink</a></span>(<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> instance)</code> |
| <div class="block">Compute and return a vector of scores before applying the inverse link |
| function.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#classifyScalar-org.apache.mahout.math.Vector-">classifyScalar</a></span>(<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> instance)</code> |
| <div class="block">Returns a single scalar probability in the case where we have two categories.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#classifyScalarNoLink-org.apache.mahout.math.Vector-">classifyScalarNoLink</a></span>(<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> instance)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#close--">close</a></span>()</code> |
| <div class="block">Prepares the classifier for classification and deallocates any temporary data structures.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#copyFrom-org.apache.mahout.classifier.sgd.AbstractOnlineLogisticRegression-">copyFrom</a></span>(<a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html" title="class in org.apache.mahout.classifier.sgd">AbstractOnlineLogisticRegression</a> other)</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#currentLearningRate--">currentLearningRate</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Matrix.html?is-external=true" title="class or interface in org.apache.mahout.math">Matrix</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#getBeta--">getBeta</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#getLambda--">getLambda</a></span>()</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/mahout/classifier/sgd/PriorFunction.html" title="interface in org.apache.mahout.classifier.sgd">PriorFunction</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#getPrior--">getPrior</a></span>()</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#getStep--">getStep</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#isSealed--">isSealed</a></span>()</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html" title="class in org.apache.mahout.classifier.sgd">AbstractOnlineLogisticRegression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#lambda-double-">lambda</a></span>(double lambda)</code> |
| <div class="block">Chainable configuration option.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#link-double-">link</a></span>(double r)</code> |
| <div class="block">Computes the binomial logistic inverse link function.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#link-org.apache.mahout.math.Vector-">link</a></span>(<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> v)</code> |
| <div class="block">Computes the inverse link function, by default the logistic link function.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#nextStep--">nextStep</a></span>()</code> </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#numCategories--">numCategories</a></span>()</code> |
| <div class="block">Returns the number of categories that a target variable can be assigned to.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#numFeatures--">numFeatures</a></span>()</code> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>abstract double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#perTermLearningRate-int-">perTermLearningRate</a></span>(int j)</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#regularize-org.apache.mahout.math.Vector-">regularize</a></span>(<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> instance)</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#setBeta-int-int-double-">setBeta</a></span>(int i, |
| int j, |
| double betaIJ)</code> </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#setGradient-org.apache.mahout.classifier.sgd.Gradient-">setGradient</a></span>(<a href="../../../../../org/apache/mahout/classifier/sgd/Gradient.html" title="interface in org.apache.mahout.classifier.sgd">Gradient</a> gradient)</code> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#setPrior-org.apache.mahout.classifier.sgd.PriorFunction-">setPrior</a></span>(<a href="../../../../../org/apache/mahout/classifier/sgd/PriorFunction.html" title="interface in org.apache.mahout.classifier.sgd">PriorFunction</a> prior)</code> </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#train-int-org.apache.mahout.math.Vector-">train</a></span>(int actual, |
| <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> instance)</code> |
| <div class="block">Updates the model using a particular target variable value and a feature vector.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#train-long-int-org.apache.mahout.math.Vector-">train</a></span>(long trackingKey, |
| int actual, |
| <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> instance)</code> |
| <div class="block">Updates the model using a particular target variable value and a feature vector.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#train-long-java.lang.String-int-org.apache.mahout.math.Vector-">train</a></span>(long trackingKey, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> groupKey, |
| int actual, |
| <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> instance)</code> |
| <div class="block">Updates the model using a particular target variable value and a feature vector.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#unseal--">unseal</a></span>()</code> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html#validModel--">validModel</a></span>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.mahout.classifier.AbstractVectorClassifier"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.mahout.classifier.<a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html" title="class in org.apache.mahout.classifier">AbstractVectorClassifier</a></h3> |
| <code><a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html#classify-org.apache.mahout.math.Matrix-">classify</a>, <a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html#classifyFull-org.apache.mahout.math.Matrix-">classifyFull</a>, <a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html#classifyFull-org.apache.mahout.math.Vector-">classifyFull</a>, <a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html#classifyFull-org.apache.mahout.math.Vector-org.apache.mahout.math.Vector-">classifyFull</a>, <a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html#classifyScalar-org.apache.mahout.math.Matrix-">classifyScalar</a>, <a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html#logLikelihood-int-org.apache.mahout.math.Vector-">logLikelihood</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="beta"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>beta</h4> |
| <pre>protected <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Matrix.html?is-external=true" title="class or interface in org.apache.mahout.math">Matrix</a> beta</pre> |
| </li> |
| </ul> |
| <a name="numCategories"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>numCategories</h4> |
| <pre>protected int numCategories</pre> |
| </li> |
| </ul> |
| <a name="step"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>step</h4> |
| <pre>protected int step</pre> |
| </li> |
| </ul> |
| <a name="updateSteps"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateSteps</h4> |
| <pre>protected <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> updateSteps</pre> |
| </li> |
| </ul> |
| <a name="updateCounts"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateCounts</h4> |
| <pre>protected <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> updateCounts</pre> |
| </li> |
| </ul> |
| <a name="prior"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>prior</h4> |
| <pre>protected <a href="../../../../../org/apache/mahout/classifier/sgd/PriorFunction.html" title="interface in org.apache.mahout.classifier.sgd">PriorFunction</a> prior</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AbstractOnlineLogisticRegression--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractOnlineLogisticRegression</h4> |
| <pre>public AbstractOnlineLogisticRegression()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="lambda-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>lambda</h4> |
| <pre>public <a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html" title="class in org.apache.mahout.classifier.sgd">AbstractOnlineLogisticRegression</a> lambda(double lambda)</pre> |
| <div class="block">Chainable configuration option.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>lambda</code> - New value of lambda, the weighting factor for the prior distribution.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This, so other configurations can be chained.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="link-org.apache.mahout.math.Vector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>link</h4> |
| <pre>public static <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> link(<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> v)</pre> |
| <div class="block">Computes the inverse link function, by default the logistic link function.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>v</code> - The output of the linear combination in a GLM. Note that the value |
| of v is disturbed.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A version of v with the link function applied.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="link-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>link</h4> |
| <pre>public static double link(double r)</pre> |
| <div class="block">Computes the binomial logistic inverse link function.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>r</code> - The value to transform.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The logit of r.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="classifyNoLink-org.apache.mahout.math.Vector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>classifyNoLink</h4> |
| <pre>public <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> classifyNoLink(<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> instance)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html#classifyNoLink-org.apache.mahout.math.Vector-">AbstractVectorClassifier</a></code></span></div> |
| <div class="block">Compute and return a vector of scores before applying the inverse link |
| function. For logistic regression and other generalized linear models, this |
| is just the linear part of the classification. |
| |
| <p> |
| The implementation of this method provided by <code>AbstractVectorClassifier</code> throws an |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a>. Your subclass must explicitly override this method to support |
| this operation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html#classifyNoLink-org.apache.mahout.math.Vector-">classifyNoLink</a></code> in class <code><a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html" title="class in org.apache.mahout.classifier">AbstractVectorClassifier</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>instance</code> - A feature vector to be classified.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A vector of scores. If transformed by the link function, these will become probabilities.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="classifyScalarNoLink-org.apache.mahout.math.Vector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>classifyScalarNoLink</h4> |
| <pre>public double classifyScalarNoLink(<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> instance)</pre> |
| </li> |
| </ul> |
| <a name="classify-org.apache.mahout.math.Vector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>classify</h4> |
| <pre>public <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> classify(<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> instance)</pre> |
| <div class="block">Returns n-1 probabilities, one for each category but the 0-th. The probability of the 0-th |
| category is 1 - sum(this result).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html#classify-org.apache.mahout.math.Vector-">classify</a></code> in class <code><a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html" title="class in org.apache.mahout.classifier">AbstractVectorClassifier</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>instance</code> - A vector of features to be classified.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A vector of probabilities, one for each of the first n-1 categories.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="classifyScalar-org.apache.mahout.math.Vector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>classifyScalar</h4> |
| <pre>public double classifyScalar(<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> instance)</pre> |
| <div class="block">Returns a single scalar probability in the case where we have two categories. Using this |
| method avoids an extra vector allocation as opposed to calling classify() or an extra two |
| vector allocations relative to classifyFull().</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html#classifyScalar-org.apache.mahout.math.Vector-">classifyScalar</a></code> in class <code><a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html" title="class in org.apache.mahout.classifier">AbstractVectorClassifier</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>instance</code> - The vector of features to be classified.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The probability of the first of two categories.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - If the classifier doesn't have two categories.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html#classify-org.apache.mahout.math.Vector-"><code>AbstractVectorClassifier.classify(Vector)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="train-long-java.lang.String-int-org.apache.mahout.math.Vector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>train</h4> |
| <pre>public void train(long trackingKey, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> groupKey, |
| int actual, |
| <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> instance)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/mahout/classifier/OnlineLearner.html#train-long-java.lang.String-int-org.apache.mahout.math.Vector-">OnlineLearner</a></code></span></div> |
| <div class="block">Updates the model using a particular target variable value and a feature vector. |
| <p/> |
| There may an assumption that if multiple passes through the training data are necessary that |
| the tracking key for a record will be the same for each pass and that there will be a |
| relatively large number of distinct tracking keys and that the low-order bits of the tracking |
| keys will not correlate with any of the input variables. This tracking key is used to assign |
| training examples to different test/training splits. |
| <p/> |
| Examples of useful tracking keys include id-numbers for the training records derived from |
| a database id for the base table from the which the record is derived, or the offset of |
| the original data record in a data file.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/mahout/classifier/OnlineLearner.html#train-long-java.lang.String-int-org.apache.mahout.math.Vector-">train</a></code> in interface <code><a href="../../../../../org/apache/mahout/classifier/OnlineLearner.html" title="interface in org.apache.mahout.classifier">OnlineLearner</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>trackingKey</code> - The tracking key for this training example.</dd> |
| <dd><code>groupKey</code> - An optional value that allows examples to be grouped in the computation of |
| the update to the model.</dd> |
| <dd><code>actual</code> - The value of the target variable. This value should be in the half-open |
| interval [0..n) where n is the number of target categories.</dd> |
| <dd><code>instance</code> - The feature vector for this example.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="train-long-int-org.apache.mahout.math.Vector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>train</h4> |
| <pre>public void train(long trackingKey, |
| int actual, |
| <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> instance)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/mahout/classifier/OnlineLearner.html#train-long-int-org.apache.mahout.math.Vector-">OnlineLearner</a></code></span></div> |
| <div class="block">Updates the model using a particular target variable value and a feature vector. |
| <p/> |
| There may an assumption that if multiple passes through the training data are necessary that |
| the tracking key for a record will be the same for each pass and that there will be a |
| relatively large number of distinct tracking keys and that the low-order bits of the tracking |
| keys will not correlate with any of the input variables. This tracking key is used to assign |
| training examples to different test/training splits. |
| <p/> |
| Examples of useful tracking keys include id-numbers for the training records derived from |
| a database id for the base table from the which the record is derived, or the offset of |
| the original data record in a data file.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/mahout/classifier/OnlineLearner.html#train-long-int-org.apache.mahout.math.Vector-">train</a></code> in interface <code><a href="../../../../../org/apache/mahout/classifier/OnlineLearner.html" title="interface in org.apache.mahout.classifier">OnlineLearner</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>trackingKey</code> - The tracking key for this training example.</dd> |
| <dd><code>actual</code> - The value of the target variable. This value should be in the half-open |
| interval [0..n) where n is the number of target categories.</dd> |
| <dd><code>instance</code> - The feature vector for this example.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="train-int-org.apache.mahout.math.Vector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>train</h4> |
| <pre>public void train(int actual, |
| <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> instance)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/mahout/classifier/OnlineLearner.html#train-int-org.apache.mahout.math.Vector-">OnlineLearner</a></code></span></div> |
| <div class="block">Updates the model using a particular target variable value and a feature vector. |
| <p/> |
| There may an assumption that if multiple passes through the training data are necessary, then |
| the training examples will be presented in the same order. This is because the order of |
| training examples may be used to assign records to different data splits for evaluation by |
| cross-validation. Without the order invariance, records might be assigned to training and test |
| splits and error estimates could be seriously affected. |
| <p/> |
| If re-ordering is necessary, then using the alternative API which allows a tracking key to be |
| added to the training example can be used.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/mahout/classifier/OnlineLearner.html#train-int-org.apache.mahout.math.Vector-">train</a></code> in interface <code><a href="../../../../../org/apache/mahout/classifier/OnlineLearner.html" title="interface in org.apache.mahout.classifier">OnlineLearner</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>actual</code> - The value of the target variable. This value should be in the half-open |
| interval [0..n) where n is the number of target categories.</dd> |
| <dd><code>instance</code> - The feature vector for this example.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="regularize-org.apache.mahout.math.Vector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>regularize</h4> |
| <pre>public void regularize(<a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Vector.html?is-external=true" title="class or interface in org.apache.mahout.math">Vector</a> instance)</pre> |
| </li> |
| </ul> |
| <a name="perTermLearningRate-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>perTermLearningRate</h4> |
| <pre>public abstract double perTermLearningRate(int j)</pre> |
| </li> |
| </ul> |
| <a name="currentLearningRate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>currentLearningRate</h4> |
| <pre>public abstract double currentLearningRate()</pre> |
| </li> |
| </ul> |
| <a name="setPrior-org.apache.mahout.classifier.sgd.PriorFunction-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrior</h4> |
| <pre>public void setPrior(<a href="../../../../../org/apache/mahout/classifier/sgd/PriorFunction.html" title="interface in org.apache.mahout.classifier.sgd">PriorFunction</a> prior)</pre> |
| </li> |
| </ul> |
| <a name="setGradient-org.apache.mahout.classifier.sgd.Gradient-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setGradient</h4> |
| <pre>public void setGradient(<a href="../../../../../org/apache/mahout/classifier/sgd/Gradient.html" title="interface in org.apache.mahout.classifier.sgd">Gradient</a> gradient)</pre> |
| </li> |
| </ul> |
| <a name="getPrior--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrior</h4> |
| <pre>public <a href="../../../../../org/apache/mahout/classifier/sgd/PriorFunction.html" title="interface in org.apache.mahout.classifier.sgd">PriorFunction</a> getPrior()</pre> |
| </li> |
| </ul> |
| <a name="getBeta--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBeta</h4> |
| <pre>public <a href="http://mahout.apache.org/mahout-math/apidocs/org/apache/mahout/math/Matrix.html?is-external=true" title="class or interface in org.apache.mahout.math">Matrix</a> getBeta()</pre> |
| </li> |
| </ul> |
| <a name="setBeta-int-int-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setBeta</h4> |
| <pre>public void setBeta(int i, |
| int j, |
| double betaIJ)</pre> |
| </li> |
| </ul> |
| <a name="numCategories--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>numCategories</h4> |
| <pre>public int numCategories()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html#numCategories--">AbstractVectorClassifier</a></code></span></div> |
| <div class="block">Returns the number of categories that a target variable can be assigned to. |
| A vector classifier will encode it's output as an integer from |
| <code>0</code> to <code>numCategories()-1</code> (inclusive).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html#numCategories--">numCategories</a></code> in class <code><a href="../../../../../org/apache/mahout/classifier/AbstractVectorClassifier.html" title="class in org.apache.mahout.classifier">AbstractVectorClassifier</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The number of categories.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="numFeatures--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>numFeatures</h4> |
| <pre>public int numFeatures()</pre> |
| </li> |
| </ul> |
| <a name="getLambda--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLambda</h4> |
| <pre>public double getLambda()</pre> |
| </li> |
| </ul> |
| <a name="getStep--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStep</h4> |
| <pre>public int getStep()</pre> |
| </li> |
| </ul> |
| <a name="nextStep--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nextStep</h4> |
| <pre>protected void nextStep()</pre> |
| </li> |
| </ul> |
| <a name="isSealed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSealed</h4> |
| <pre>public boolean isSealed()</pre> |
| </li> |
| </ul> |
| <a name="unseal--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unseal</h4> |
| <pre>protected void unseal()</pre> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/mahout/classifier/OnlineLearner.html#close--">OnlineLearner</a></code></span></div> |
| <div class="block">Prepares the classifier for classification and deallocates any temporary data structures. |
| |
| An online classifier should be able to accept more training after being closed, but |
| closing the classifier may make classification more efficient.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true#close--" title="class or interface in java.io">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/mahout/classifier/OnlineLearner.html#close--">close</a></code> in interface <code><a href="../../../../../org/apache/mahout/classifier/OnlineLearner.html" title="interface in org.apache.mahout.classifier">OnlineLearner</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="copyFrom-org.apache.mahout.classifier.sgd.AbstractOnlineLogisticRegression-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>copyFrom</h4> |
| <pre>public void copyFrom(<a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html" title="class in org.apache.mahout.classifier.sgd">AbstractOnlineLogisticRegression</a> other)</pre> |
| </li> |
| </ul> |
| <a name="validModel--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>validModel</h4> |
| <pre>public boolean validModel()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AbstractOnlineLogisticRegression.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../org/apache/mahout/classifier/sgd/AdaptiveLogisticRegression.html" title="class in org.apache.mahout.classifier.sgd"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html" target="_top">Frames</a></li> |
| <li><a href="AbstractOnlineLogisticRegression.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2008–2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
