summaryrefslogblamecommitdiff
path: root/site/docs/1.5.0/api/java/org/apache/spark/mllib/optimization/LBFGS.html
blob: 1d700c55bf68bfd898d06a990d3f70c4b221f6b8 (plain) (tree)
1
2
3
4
5
6
7



                                                                                                      
                                                                                
                    
                                       






























                                                                                                                                                                                    
                                                                                                                                                                                               

































































































































































































































































































































































































                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       
                                                                                                                                                                                               








































                                                                                                                                                                                               
<!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 (version 1.7.0_51) on Wed Sep 16 10:26:34 PDT 2015 -->
<title>LBFGS</title>
<meta name="date" content="2015-09-16">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="LBFGS";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="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/spark/mllib/optimization/L1Updater.html" title="class in org.apache.spark.mllib.optimization"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/mllib/optimization/LeastSquaresGradient.html" title="class in org.apache.spark.mllib.optimization"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/mllib/optimization/LBFGS.html" target="_top">Frames</a></li>
<li><a href="LBFGS.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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.spark.mllib.optimization</div>
<h2 title="Class LBFGS" class="title">Class LBFGS</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.spark.mllib.optimization.LBFGS</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, <a href="../../../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a>, <a href="../../../../../org/apache/spark/mllib/optimization/Optimizer.html" title="interface in org.apache.spark.mllib.optimization">Optimizer</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">LBFGS</span>
extends java.lang.Object
implements <a href="../../../../../org/apache/spark/mllib/optimization/Optimizer.html" title="interface in org.apache.spark.mllib.optimization">Optimizer</a>, <a href="../../../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a></pre>
<div class="block">:: DeveloperApi ::
 Class used to solve an optimization problem using Limited-memory BFGS.
 Reference: <code>http://en.wikipedia.org/wiki/Limited-memory_BFGS</code>
 param:  gradient Gradient function to be used.
 param:  updater Updater to be used to update weights after every iteration.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.spark.mllib.optimization.LBFGS">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html#LBFGS(org.apache.spark.mllib.optimization.Gradient, org.apache.spark.mllib.optimization.Updater)">LBFGS</a></strong>(<a href="../../../../../org/apache/spark/mllib/optimization/Gradient.html" title="class in org.apache.spark.mllib.optimization">Gradient</a>&nbsp;gradient,
     <a href="../../../../../org/apache/spark/mllib/optimization/Updater.html" title="class in org.apache.spark.mllib.optimization">Updater</a>&nbsp;updater)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html#optimize(org.apache.spark.rdd.RDD, org.apache.spark.mllib.linalg.Vector)">optimize</a></strong>(<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,<a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a>&gt;&gt;&nbsp;data,
        <a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a>&nbsp;initialWeights)</code>
<div class="block">Solve the provided convex optimization problem.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static scala.Tuple2&lt;<a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a>,double[]&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html#runLBFGS(org.apache.spark.rdd.RDD, org.apache.spark.mllib.optimization.Gradient, org.apache.spark.mllib.optimization.Updater, int, double, int, double, org.apache.spark.mllib.linalg.Vector)">runLBFGS</a></strong>(<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,<a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a>&gt;&gt;&nbsp;data,
        <a href="../../../../../org/apache/spark/mllib/optimization/Gradient.html" title="class in org.apache.spark.mllib.optimization">Gradient</a>&nbsp;gradient,
        <a href="../../../../../org/apache/spark/mllib/optimization/Updater.html" title="class in org.apache.spark.mllib.optimization">Updater</a>&nbsp;updater,
        int&nbsp;numCorrections,
        double&nbsp;convergenceTol,
        int&nbsp;maxNumIterations,
        double&nbsp;regParam,
        <a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a>&nbsp;initialWeights)</code>
<div class="block">Run Limited-memory BFGS (L-BFGS) in parallel.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html" title="class in org.apache.spark.mllib.optimization">LBFGS</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html#setConvergenceTol(double)">setConvergenceTol</a></strong>(double&nbsp;tolerance)</code>
<div class="block">Set the convergence tolerance of iterations for L-BFGS.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html" title="class in org.apache.spark.mllib.optimization">LBFGS</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html#setGradient(org.apache.spark.mllib.optimization.Gradient)">setGradient</a></strong>(<a href="../../../../../org/apache/spark/mllib/optimization/Gradient.html" title="class in org.apache.spark.mllib.optimization">Gradient</a>&nbsp;gradient)</code>
<div class="block">Set the gradient function (of the loss function of one single data example)
 to be used for L-BFGS.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html" title="class in org.apache.spark.mllib.optimization">LBFGS</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html#setMaxNumIterations(int)">setMaxNumIterations</a></strong>(int&nbsp;iters)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>use <a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html#setNumIterations(int)"><code>setNumIterations(int)</code></a> instead</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html" title="class in org.apache.spark.mllib.optimization">LBFGS</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html#setNumCorrections(int)">setNumCorrections</a></strong>(int&nbsp;corrections)</code>
<div class="block">Set the number of corrections used in the LBFGS update.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html" title="class in org.apache.spark.mllib.optimization">LBFGS</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html#setNumIterations(int)">setNumIterations</a></strong>(int&nbsp;iters)</code>
<div class="block">Set the maximal number of iterations for L-BFGS.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html" title="class in org.apache.spark.mllib.optimization">LBFGS</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html#setRegParam(double)">setRegParam</a></strong>(double&nbsp;regParam)</code>
<div class="block">Set the regularization parameter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html" title="class in org.apache.spark.mllib.optimization">LBFGS</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html#setUpdater(org.apache.spark.mllib.optimization.Updater)">setUpdater</a></strong>(<a href="../../../../../org/apache/spark/mllib/optimization/Updater.html" title="class in org.apache.spark.mllib.optimization">Updater</a>&nbsp;updater)</code>
<div class="block">Set the updater function to actually perform a gradient step in a given direction.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.Logging">
<!--   -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.spark.<a href="../../../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a></h3>
<code><a href="../../../../../org/apache/spark/Logging.html#initializeIfNecessary()">initializeIfNecessary</a>, <a href="../../../../../org/apache/spark/Logging.html#initializeLogging()">initializeLogging</a>, <a href="../../../../../org/apache/spark/Logging.html#isTraceEnabled()">isTraceEnabled</a>, <a href="../../../../../org/apache/spark/Logging.html#log_()">log_</a>, <a href="../../../../../org/apache/spark/Logging.html#log()">log</a>, <a href="../../../../../org/apache/spark/Logging.html#logDebug(scala.Function0)">logDebug</a>, <a href="../../../../../org/apache/spark/Logging.html#logDebug(scala.Function0, java.lang.Throwable)">logDebug</a>, <a href="../../../../../org/apache/spark/Logging.html#logError(scala.Function0)">logError</a>, <a href="../../../../../org/apache/spark/Logging.html#logError(scala.Function0, java.lang.Throwable)">logError</a>, <a href="../../../../../org/apache/spark/Logging.html#logInfo(scala.Function0)">logInfo</a>, <a href="../../../../../org/apache/spark/Logging.html#logInfo(scala.Function0, java.lang.Throwable)">logInfo</a>, <a href="../../../../../org/apache/spark/Logging.html#logName()">logName</a>, <a href="../../../../../org/apache/spark/Logging.html#logTrace(scala.Function0)">logTrace</a>, <a href="../../../../../org/apache/spark/Logging.html#logTrace(scala.Function0, java.lang.Throwable)">logTrace</a>, <a href="../../../../../org/apache/spark/Logging.html#logWarning(scala.Function0)">logWarning</a>, <a href="../../../../../org/apache/spark/Logging.html#logWarning(scala.Function0, java.lang.Throwable)">logWarning</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="LBFGS(org.apache.spark.mllib.optimization.Gradient, org.apache.spark.mllib.optimization.Updater)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LBFGS</h4>
<pre>public&nbsp;LBFGS(<a href="../../../../../org/apache/spark/mllib/optimization/Gradient.html" title="class in org.apache.spark.mllib.optimization">Gradient</a>&nbsp;gradient,
     <a href="../../../../../org/apache/spark/mllib/optimization/Updater.html" title="class in org.apache.spark.mllib.optimization">Updater</a>&nbsp;updater)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="runLBFGS(org.apache.spark.rdd.RDD, org.apache.spark.mllib.optimization.Gradient, org.apache.spark.mllib.optimization.Updater, int, double, int, double, org.apache.spark.mllib.linalg.Vector)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>runLBFGS</h4>
<pre>public static&nbsp;scala.Tuple2&lt;<a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a>,double[]&gt;&nbsp;runLBFGS(<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,<a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a>&gt;&gt;&nbsp;data,
                                     <a href="../../../../../org/apache/spark/mllib/optimization/Gradient.html" title="class in org.apache.spark.mllib.optimization">Gradient</a>&nbsp;gradient,
                                     <a href="../../../../../org/apache/spark/mllib/optimization/Updater.html" title="class in org.apache.spark.mllib.optimization">Updater</a>&nbsp;updater,
                                     int&nbsp;numCorrections,
                                     double&nbsp;convergenceTol,
                                     int&nbsp;maxNumIterations,
                                     double&nbsp;regParam,
                                     <a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a>&nbsp;initialWeights)</pre>
<div class="block">Run Limited-memory BFGS (L-BFGS) in parallel.
 Averaging the subgradients over different partitions is performed using one standard
 spark map-reduce in each iteration.
 <p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - - Input data for L-BFGS. RDD of the set of data examples, each of
               the form (label, [feature values]).</dd><dd><code>gradient</code> - - Gradient object (used to compute the gradient of the loss function of
                   one single data example)</dd><dd><code>updater</code> - - Updater function to actually perform a gradient step in a given direction.</dd><dd><code>numCorrections</code> - - The number of corrections used in the L-BFGS update.</dd><dd><code>convergenceTol</code> - - The convergence tolerance of iterations for L-BFGS which is must be
                         nonnegative. Lower values are less tolerant and therefore generally
                         cause more iterations to be run.</dd><dd><code>maxNumIterations</code> - - Maximal number of iterations that L-BFGS can be run.</dd><dd><code>regParam</code> - - Regularization parameter
 <p></dd><dd><code>initialWeights</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>A tuple containing two elements. The first element is a column matrix containing
         weights for every feature, and the second element is an array containing the loss
         computed for every iteration.</dd></dl>
</li>
</ul>
<a name="setNumCorrections(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNumCorrections</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html" title="class in org.apache.spark.mllib.optimization">LBFGS</a>&nbsp;setNumCorrections(int&nbsp;corrections)</pre>
<div class="block">Set the number of corrections used in the LBFGS update. Default 10.
 Values of numCorrections less than 3 are not recommended; large values
 of numCorrections will result in excessive computing time.
 3 < numCorrections < 10 is recommended.
 Restriction: numCorrections > 0</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>corrections</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setConvergenceTol(double)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConvergenceTol</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html" title="class in org.apache.spark.mllib.optimization">LBFGS</a>&nbsp;setConvergenceTol(double&nbsp;tolerance)</pre>
<div class="block">Set the convergence tolerance of iterations for L-BFGS. Default 1E-4.
 Smaller value will lead to higher accuracy with the cost of more iterations.
 This value must be nonnegative. Lower convergence values are less tolerant
 and therefore generally cause more iterations to be run.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tolerance</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setMaxNumIterations(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxNumIterations</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html" title="class in org.apache.spark.mllib.optimization">LBFGS</a>&nbsp;setMaxNumIterations(int&nbsp;iters)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>use <a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html#setNumIterations(int)"><code>setNumIterations(int)</code></a> instead</i></div>
<div class="block">Set the maximal number of iterations for L-BFGS. Default 100.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iters</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setNumIterations(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNumIterations</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html" title="class in org.apache.spark.mllib.optimization">LBFGS</a>&nbsp;setNumIterations(int&nbsp;iters)</pre>
<div class="block">Set the maximal number of iterations for L-BFGS. Default 100.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iters</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setRegParam(double)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRegParam</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html" title="class in org.apache.spark.mllib.optimization">LBFGS</a>&nbsp;setRegParam(double&nbsp;regParam)</pre>
<div class="block">Set the regularization parameter. Default 0.0.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>regParam</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setGradient(org.apache.spark.mllib.optimization.Gradient)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGradient</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html" title="class in org.apache.spark.mllib.optimization">LBFGS</a>&nbsp;setGradient(<a href="../../../../../org/apache/spark/mllib/optimization/Gradient.html" title="class in org.apache.spark.mllib.optimization">Gradient</a>&nbsp;gradient)</pre>
<div class="block">Set the gradient function (of the loss function of one single data example)
 to be used for L-BFGS.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>gradient</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setUpdater(org.apache.spark.mllib.optimization.Updater)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUpdater</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/mllib/optimization/LBFGS.html" title="class in org.apache.spark.mllib.optimization">LBFGS</a>&nbsp;setUpdater(<a href="../../../../../org/apache/spark/mllib/optimization/Updater.html" title="class in org.apache.spark.mllib.optimization">Updater</a>&nbsp;updater)</pre>
<div class="block">Set the updater function to actually perform a gradient step in a given direction.
 The updater is responsible to perform the update from the regularization term as well,
 and therefore determines what kind or regularization is used, if any.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>updater</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="optimize(org.apache.spark.rdd.RDD, org.apache.spark.mllib.linalg.Vector)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>optimize</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a>&nbsp;optimize(<a href="../../../../../org/apache/spark/rdd/RDD.html" title="class in org.apache.spark.rdd">RDD</a>&lt;scala.Tuple2&lt;java.lang.Object,<a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a>&gt;&gt;&nbsp;data,
              <a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a>&nbsp;initialWeights)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/spark/mllib/optimization/Optimizer.html#optimize(org.apache.spark.rdd.RDD, org.apache.spark.mllib.linalg.Vector)">Optimizer</a></code></strong></div>
<div class="block">Solve the provided convex optimization problem.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/mllib/optimization/Optimizer.html#optimize(org.apache.spark.rdd.RDD, org.apache.spark.mllib.linalg.Vector)">optimize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/spark/mllib/optimization/Optimizer.html" title="interface in org.apache.spark.mllib.optimization">Optimizer</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - (undocumented)</dd><dd><code>initialWeights</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="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/spark/mllib/optimization/L1Updater.html" title="class in org.apache.spark.mllib.optimization"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/mllib/optimization/LeastSquaresGradient.html" title="class in org.apache.spark.mllib.optimization"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/mllib/optimization/LBFGS.html" target="_top">Frames</a></li>
<li><a href="LBFGS.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<script defer="defer" type="text/javascript" src="../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../../lib/api-javadocs.js"></script></body>
</html>