| <!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:37 PDT 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>org.apache.mahout.classifier.sgd (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="org.apache.mahout.classifier.sgd (Mahout Map-Reduce 0.13.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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><a href="../../../../../org/apache/mahout/classifier/sequencelearning/hmm/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/mahout/clustering/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mahout/classifier/sgd/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.mahout.classifier.sgd</h1> |
| <div class="docSummary"> |
| <div class="block">Implements a variety of on-line logistric regression classifiers using SGD-based algorithms.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/Gradient.html" title="interface in org.apache.mahout.classifier.sgd">Gradient</a></td> |
| <td class="colLast"> |
| <div class="block">Provides the ability to inject a gradient into the SGD logistic regresion.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/PriorFunction.html" title="interface in org.apache.mahout.classifier.sgd">PriorFunction</a></td> |
| <td class="colLast"> |
| <div class="block">A prior is used to regularize the learning algorithm.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/RecordFactory.html" title="interface in org.apache.mahout.classifier.sgd">RecordFactory</a></td> |
| <td class="colLast"> |
| <div class="block">A record factor understands how to convert a line of data into fields and then into a vector.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/AbstractOnlineLogisticRegression.html" title="class in org.apache.mahout.classifier.sgd">AbstractOnlineLogisticRegression</a></td> |
| <td class="colLast"> |
| <div class="block">Generic definition of a 1 of n logistic regression classifier that returns probabilities in |
| response to a feature vector.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/AdaptiveLogisticRegression.html" title="class in org.apache.mahout.classifier.sgd">AdaptiveLogisticRegression</a></td> |
| <td class="colLast"> |
| <div class="block">This is a meta-learner that maintains a pool of ordinary |
| <a href="../../../../../org/apache/mahout/classifier/sgd/OnlineLogisticRegression.html" title="class in org.apache.mahout.classifier.sgd"><code>OnlineLogisticRegression</code></a> learners.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/AdaptiveLogisticRegression.TrainingExample.html" title="class in org.apache.mahout.classifier.sgd">AdaptiveLogisticRegression.TrainingExample</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/AdaptiveLogisticRegression.Wrapper.html" title="class in org.apache.mahout.classifier.sgd">AdaptiveLogisticRegression.Wrapper</a></td> |
| <td class="colLast"> |
| <div class="block">Provides a shim between the EP optimization stuff and the CrossFoldLearner.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/CrossFoldLearner.html" title="class in org.apache.mahout.classifier.sgd">CrossFoldLearner</a></td> |
| <td class="colLast"> |
| <div class="block">Does cross-fold validation of log-likelihood and AUC on several online logistic regression |
| models.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/CsvRecordFactory.html" title="class in org.apache.mahout.classifier.sgd">CsvRecordFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Converts CSV data lines to vectors.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/DefaultGradient.html" title="class in org.apache.mahout.classifier.sgd">DefaultGradient</a></td> |
| <td class="colLast"> |
| <div class="block">Implements the basic logistic training law.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/ElasticBandPrior.html" title="class in org.apache.mahout.classifier.sgd">ElasticBandPrior</a></td> |
| <td class="colLast"> |
| <div class="block">Implements a linear combination of L1 and L2 priors.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/GradientMachine.html" title="class in org.apache.mahout.classifier.sgd">GradientMachine</a></td> |
| <td class="colLast"> |
| <div class="block">Online gradient machine learner that tries to minimize the label ranking hinge loss.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/L1.html" title="class in org.apache.mahout.classifier.sgd">L1</a></td> |
| <td class="colLast"> |
| <div class="block">Implements the Laplacian or bi-exponential prior.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/L2.html" title="class in org.apache.mahout.classifier.sgd">L2</a></td> |
| <td class="colLast"> |
| <div class="block">Implements the Gaussian prior.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/MixedGradient.html" title="class in org.apache.mahout.classifier.sgd">MixedGradient</a></td> |
| <td class="colLast"> |
| <div class="block">Provides a stochastic mixture of ranking updates and normal logistic updates.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/ModelDissector.html" title="class in org.apache.mahout.classifier.sgd">ModelDissector</a></td> |
| <td class="colLast"> |
| <div class="block">Uses sample data to reverse engineer a feature-hashed model.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/ModelDissector.Weight.html" title="class in org.apache.mahout.classifier.sgd">ModelDissector.Weight</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/ModelSerializer.html" title="class in org.apache.mahout.classifier.sgd">ModelSerializer</a></td> |
| <td class="colLast"> |
| <div class="block">Provides the ability to store SGD model-related objects as binary files.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/OnlineLogisticRegression.html" title="class in org.apache.mahout.classifier.sgd">OnlineLogisticRegression</a></td> |
| <td class="colLast"> |
| <div class="block">Extends the basic on-line logistic regression learner with a specific set of learning |
| rate annealing schedules.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/PassiveAggressive.html" title="class in org.apache.mahout.classifier.sgd">PassiveAggressive</a></td> |
| <td class="colLast"> |
| <div class="block">Online passive aggressive learner that tries to minimize the label ranking hinge loss.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/PolymorphicWritable.html" title="class in org.apache.mahout.classifier.sgd">PolymorphicWritable</a></td> |
| <td class="colLast"> |
| <div class="block">Utilities that write a class name and then serialize using writables.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/RankingGradient.html" title="class in org.apache.mahout.classifier.sgd">RankingGradient</a></td> |
| <td class="colLast"> |
| <div class="block">Uses the difference between this instance and recent history to get a |
| gradient that optimizes ranking performance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/TPrior.html" title="class in org.apache.mahout.classifier.sgd">TPrior</a></td> |
| <td class="colLast"> |
| <div class="block">Provides a t-distribution as a prior.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../org/apache/mahout/classifier/sgd/UniformPrior.html" title="class in org.apache.mahout.classifier.sgd">UniformPrior</a></td> |
| <td class="colLast"> |
| <div class="block">A uniform prior.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.mahout.classifier.sgd Description">Package org.apache.mahout.classifier.sgd Description</h2> |
| <div class="block"><p>Implements a variety of on-line logistric regression classifiers using SGD-based algorithms. |
| SGD stands for Stochastic Gradient Descent and refers to a class of learning algorithms |
| that make it relatively easy to build high speed on-line learning algorithms for a variety |
| of problems, notably including supervised learning for classification.</p> |
| |
| <p>The primary class of interest in the this package is |
| <a href="../../../../../org/apache/mahout/classifier/sgd/CrossFoldLearner.html" title="class in org.apache.mahout.classifier.sgd"><code>CrossFoldLearner</code></a> which contains a |
| number (typically 5) of sub-learners, each of which is given a different portion of the |
| training data. Each of these sub-learners can then be evaluated on the data it was not |
| trained on. This allows fully incremental learning while still getting cross-validated |
| performance estimates.</p> |
| |
| <p>The CrossFoldLearner implements <a href="../../../../../org/apache/mahout/classifier/OnlineLearner.html" title="interface in org.apache.mahout.classifier"><code>OnlineLearner</code></a> |
| and thus expects to be fed input in the form |
| of a target variable and a feature vector. The target variable is simply an integer in the |
| half-open interval [0..numFeatures) where numFeatures is defined when the CrossFoldLearner |
| is constructed. The creation of feature vectors is facilitated by the classes that inherit |
| from <a href="../../../../../org/apache/mahout/vectorizer/encoders/FeatureVectorEncoder.html" title="class in org.apache.mahout.vectorizer.encoders"><code>FeatureVectorEncoder</code></a>. |
| These classes currently implement a form of feature hashing with |
| multiple probes to limit feature ambiguity.</p></div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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><a href="../../../../../org/apache/mahout/classifier/sequencelearning/hmm/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../org/apache/mahout/clustering/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mahout/classifier/sgd/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <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> |
