| <!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_312) on Mon Jul 11 16:23:57 UTC 2022 --> |
| <title>GeneralizedLinearRegression (Spark 3.2.2 JavaDoc)</title> |
| <meta name="date" content="2022-07-11"> |
| <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="GeneralizedLinearRegression (Spark 3.2.2 JavaDoc)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":10,"i9":10,"i10":9,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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="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/ml/regression/GBTRegressor.html" title="class in org.apache.spark.ml.regression"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.Binomial$.html" title="class in org.apache.spark.ml.regression"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/spark/ml/regression/GeneralizedLinearRegression.html" target="_top">Frames</a></li> |
| <li><a href="GeneralizedLinearRegression.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </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>Field | </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.spark.ml.regression</div> |
| <h2 title="Class GeneralizedLinearRegression" class="title">Class GeneralizedLinearRegression</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">org.apache.spark.ml.PipelineStage</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/spark/ml/Estimator.html" title="class in org.apache.spark.ml">org.apache.spark.ml.Estimator</a><M></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/spark/ml/Predictor.html" title="class in org.apache.spark.ml">org.apache.spark.ml.Predictor</a><FeaturesType,Learner,M></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/spark/ml/regression/Regressor.html" title="class in org.apache.spark.ml.regression">org.apache.spark.ml.regression.Regressor</a><<a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a>,<a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a>,<a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionModel.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegressionModel</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.spark.ml.regression.GeneralizedLinearRegression</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable, org.apache.spark.internal.Logging, <a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasAggregationDepth.html" title="interface in org.apache.spark.ml.param.shared">HasAggregationDepth</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html" title="interface in org.apache.spark.ml.param.shared">HasFeaturesCol</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasFitIntercept.html" title="interface in org.apache.spark.ml.param.shared">HasFitIntercept</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html" title="interface in org.apache.spark.ml.param.shared">HasLabelCol</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html" title="interface in org.apache.spark.ml.param.shared">HasMaxIter</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html" title="interface in org.apache.spark.ml.param.shared">HasPredictionCol</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasRegParam.html" title="interface in org.apache.spark.ml.param.shared">HasRegParam</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasSolver.html" title="interface in org.apache.spark.ml.param.shared">HasSolver</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasTol.html" title="interface in org.apache.spark.ml.param.shared">HasTol</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html" title="interface in org.apache.spark.ml.param.shared">HasWeightCol</a>, <a href="../../../../../org/apache/spark/ml/PredictorParams.html" title="interface in org.apache.spark.ml">PredictorParams</a>, <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html" title="interface in org.apache.spark.ml.regression">GeneralizedLinearRegressionBase</a>, <a href="../../../../../org/apache/spark/ml/util/DefaultParamsWritable.html" title="interface in org.apache.spark.ml.util">DefaultParamsWritable</a>, <a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a>, <a href="../../../../../org/apache/spark/ml/util/MLWritable.html" title="interface in org.apache.spark.ml.util">MLWritable</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">GeneralizedLinearRegression</span> |
| extends <a href="../../../../../org/apache/spark/ml/regression/Regressor.html" title="class in org.apache.spark.ml.regression">Regressor</a><<a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a>,<a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a>,<a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionModel.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegressionModel</a>> |
| implements <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html" title="interface in org.apache.spark.ml.regression">GeneralizedLinearRegressionBase</a>, <a href="../../../../../org/apache/spark/ml/util/DefaultParamsWritable.html" title="interface in org.apache.spark.ml.util">DefaultParamsWritable</a>, org.apache.spark.internal.Logging</pre> |
| <div class="block">Fit a Generalized Linear Model |
| (see <a href="https://en.wikipedia.org/wiki/Generalized_linear_model"> |
| Generalized linear model (Wikipedia)</a>) |
| specified by giving a symbolic description of the linear |
| predictor (link function) and a description of the error distribution (family). |
| It supports "gaussian", "binomial", "poisson", "gamma" and "tweedie" as family. |
| Valid link functions for each family is listed below. The first link function of each family |
| is the default one. |
| - "gaussian" : "identity", "log", "inverse" |
| - "binomial" : "logit", "probit", "cloglog" |
| - "poisson" : "log", "identity", "sqrt" |
| - "gamma" : "inverse", "identity", "log" |
| - "tweedie" : power link function specified through "linkPower". The default link power in |
| the tweedie family is 1 - variancePower.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.spark.ml.regression.GeneralizedLinearRegression">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.Binomial$.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression.Binomial$</a></span></code> |
| <div class="block">Binomial exponential family distribution.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.CLogLog$.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression.CLogLog$</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.Family$.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression.Family$</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.FamilyAndLink$.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression.FamilyAndLink$</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.Gamma$.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression.Gamma$</a></span></code> |
| <div class="block">Gamma exponential family distribution.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.Gaussian$.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression.Gaussian$</a></span></code> |
| <div class="block">Gaussian exponential family distribution.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.Identity$.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression.Identity$</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.Inverse$.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression.Inverse$</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.Link$.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression.Link$</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.Log$.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression.Log$</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.Logit$.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression.Logit$</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.Poisson$.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression.Poisson$</a></span></code> |
| <div class="block">Poisson exponential family distribution.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.Probit$.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression.Probit$</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.Sqrt$.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression.Sqrt$</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.Tweedie$.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression.Tweedie$</a></span></code> </td> |
| </tr> |
| </table> |
| </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/spark/ml/regression/GeneralizedLinearRegression.html#GeneralizedLinearRegression--">GeneralizedLinearRegression</a></span>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#GeneralizedLinearRegression-java.lang.String-">GeneralizedLinearRegression</a></span>(String uid)</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="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="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#aggregationDepth--">aggregationDepth</a></span>()</code> |
| <div class="block">Param for suggested depth for treeAggregate (&gt;= 2).</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#copy-org.apache.spark.ml.param.ParamMap-">copy</a></span>(<a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a> extra)</code> |
| <div class="block">Creates a copy of this instance with the same UID and some extra params.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#family--">family</a></span>()</code> |
| <div class="block">Param for the name of family which is a description of the error distribution |
| to be used in the model.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/BooleanParam.html" title="class in org.apache.spark.ml.param">BooleanParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#fitIntercept--">fitIntercept</a></span>()</code> |
| <div class="block">Param for whether to fit an intercept term.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#link--">link</a></span>()</code> |
| <div class="block">Param for the name of link function which provides the relationship |
| between the linear predictor and the mean of the distribution function.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#linkPower--">linkPower</a></span>()</code> |
| <div class="block">Param for the index in the power link function.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#linkPredictionCol--">linkPredictionCol</a></span>()</code> |
| <div class="block">Param for link prediction (linear predictor) column name.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#load-java.lang.String-">load</a></span>(String path)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#maxIter--">maxIter</a></span>()</code> |
| <div class="block">Param for maximum number of iterations (&gt;= 0).</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#offsetCol--">offsetCol</a></span>()</code> |
| <div class="block">Param for offset column name.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/spark/ml/util/MLReader.html" title="class in org.apache.spark.ml.util">MLReader</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#read--">read</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#regParam--">regParam</a></span>()</code> |
| <div class="block">Param for regularization parameter (&gt;= 0).</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#setAggregationDepth-int-">setAggregationDepth</a></span>(int value)</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#setFamily-java.lang.String-">setFamily</a></span>(String value)</code> |
| <div class="block">Sets the value of param <code>family</code>.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#setFitIntercept-boolean-">setFitIntercept</a></span>(boolean value)</code> |
| <div class="block">Sets if we should fit the intercept.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#setLink-java.lang.String-">setLink</a></span>(String value)</code> |
| <div class="block">Sets the value of param <code>link</code>.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#setLinkPower-double-">setLinkPower</a></span>(double value)</code> |
| <div class="block">Sets the value of param <code>linkPower</code>.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#setLinkPredictionCol-java.lang.String-">setLinkPredictionCol</a></span>(String value)</code> |
| <div class="block">Sets the link prediction (linear predictor) column name.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#setMaxIter-int-">setMaxIter</a></span>(int value)</code> |
| <div class="block">Sets the maximum number of iterations (applicable for solver "irls").</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#setOffsetCol-java.lang.String-">setOffsetCol</a></span>(String value)</code> |
| <div class="block">Sets the value of param <code>offsetCol</code>.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#setRegParam-double-">setRegParam</a></span>(double value)</code> |
| <div class="block">Sets the regularization parameter for L2 regularization.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#setSolver-java.lang.String-">setSolver</a></span>(String value)</code> |
| <div class="block">Sets the solver algorithm used for optimization.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#setTol-double-">setTol</a></span>(double value)</code> |
| <div class="block">Sets the convergence tolerance of iterations.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#setVariancePower-double-">setVariancePower</a></span>(double value)</code> |
| <div class="block">Sets the value of param <code>variancePower</code>.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#setWeightCol-java.lang.String-">setWeightCol</a></span>(String value)</code> |
| <div class="block">Sets the value of param <code>weightCol</code>.</div> |
| </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#solver--">solver</a></span>()</code> |
| <div class="block">The solver algorithm for optimization.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#tol--">tol</a></span>()</code> |
| <div class="block">Param for the convergence tolerance for iterative algorithms (&gt;= 0).</div> |
| </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#uid--">uid</a></span>()</code> |
| <div class="block">An immutable unique ID for the object and its derivatives.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#variancePower--">variancePower</a></span>()</code> |
| <div class="block">Param for the power in the variance function of the Tweedie distribution which provides |
| the relationship between the variance and mean of the distribution.</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html#weightCol--">weightCol</a></span>()</code> |
| <div class="block">Param for weight column name.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.Predictor"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.spark.ml.<a href="../../../../../org/apache/spark/ml/Predictor.html" title="class in org.apache.spark.ml">Predictor</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/Predictor.html#featuresCol--">featuresCol</a>, <a href="../../../../../org/apache/spark/ml/Predictor.html#fit-org.apache.spark.sql.Dataset-">fit</a>, <a href="../../../../../org/apache/spark/ml/Predictor.html#labelCol--">labelCol</a>, <a href="../../../../../org/apache/spark/ml/Predictor.html#predictionCol--">predictionCol</a>, <a href="../../../../../org/apache/spark/ml/Predictor.html#setFeaturesCol-java.lang.String-">setFeaturesCol</a>, <a href="../../../../../org/apache/spark/ml/Predictor.html#setLabelCol-java.lang.String-">setLabelCol</a>, <a href="../../../../../org/apache/spark/ml/Predictor.html#setPredictionCol-java.lang.String-">setPredictionCol</a>, <a href="../../../../../org/apache/spark/ml/Predictor.html#transformSchema-org.apache.spark.sql.types.StructType-">transformSchema</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.Estimator"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.spark.ml.<a href="../../../../../org/apache/spark/ml/Estimator.html" title="class in org.apache.spark.ml">Estimator</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamMap-">fit</a>, <a href="../../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamPair-org.apache.spark.ml.param.ParamPair...-">fit</a>, <a href="../../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-org.apache.spark.ml.param.ParamPair-scala.collection.Seq-">fit</a>, <a href="../../../../../org/apache/spark/ml/Estimator.html#fit-org.apache.spark.sql.Dataset-scala.collection.Seq-">fit</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.PipelineStage"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.spark.ml.<a href="../../../../../org/apache/spark/ml/PipelineStage.html" title="class in org.apache.spark.ml">PipelineStage</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/PipelineStage.html#params--">params</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class Object</h3> |
| <code>equals, 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.ml.regression.GeneralizedLinearRegressionBase"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.regression.<a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html" title="interface in org.apache.spark.ml.regression">GeneralizedLinearRegressionBase</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#getFamily--">getFamily</a>, <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#getLink--">getLink</a>, <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#getLinkPower--">getLinkPower</a>, <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#getLinkPredictionCol--">getLinkPredictionCol</a>, <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#getOffsetCol--">getOffsetCol</a>, <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#getVariancePower--">getVariancePower</a>, <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#hasLinkPredictionCol--">hasLinkPredictionCol</a>, <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#hasOffsetCol--">hasOffsetCol</a>, <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#hasWeightCol--">hasWeightCol</a>, <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#validateAndTransformSchema-org.apache.spark.sql.types.StructType-boolean-org.apache.spark.sql.types.DataType-">validateAndTransformSchema</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.PredictorParams"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.<a href="../../../../../org/apache/spark/ml/PredictorParams.html" title="interface in org.apache.spark.ml">PredictorParams</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/PredictorParams.html#extractInstances-org.apache.spark.sql.Dataset-">extractInstances</a>, <a href="../../../../../org/apache/spark/ml/PredictorParams.html#extractInstances-org.apache.spark.sql.Dataset-scala.Function1-">extractInstances</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasLabelCol"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html" title="interface in org.apache.spark.ml.param.shared">HasLabelCol</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html#getLabelCol--">getLabelCol</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasLabelCol.html#labelCol--">labelCol</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasFeaturesCol"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html" title="interface in org.apache.spark.ml.param.shared">HasFeaturesCol</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html#featuresCol--">featuresCol</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasFeaturesCol.html#getFeaturesCol--">getFeaturesCol</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasPredictionCol"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html" title="interface in org.apache.spark.ml.param.shared">HasPredictionCol</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html#getPredictionCol--">getPredictionCol</a>, <a href="../../../../../org/apache/spark/ml/param/shared/HasPredictionCol.html#predictionCol--">predictionCol</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.Params"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.<a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/Params.html#clear-org.apache.spark.ml.param.Param-">clear</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#copyValues-T-org.apache.spark.ml.param.ParamMap-">copyValues</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#defaultCopy-org.apache.spark.ml.param.ParamMap-">defaultCopy</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#defaultParamMap--">defaultParamMap</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#explainParam-org.apache.spark.ml.param.Param-">explainParam</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#explainParams--">explainParams</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#extractParamMap--">extractParamMap</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#extractParamMap-org.apache.spark.ml.param.ParamMap-">extractParamMap</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#get-org.apache.spark.ml.param.Param-">get</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#getDefault-org.apache.spark.ml.param.Param-">getDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#getOrDefault-org.apache.spark.ml.param.Param-">getOrDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#getParam-java.lang.String-">getParam</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#hasDefault-org.apache.spark.ml.param.Param-">hasDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#hasParam-java.lang.String-">hasParam</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#isDefined-org.apache.spark.ml.param.Param-">isDefined</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#isSet-org.apache.spark.ml.param.Param-">isSet</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#paramMap--">paramMap</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#params--">params</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#set-org.apache.spark.ml.param.Param-T-">set</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#set-org.apache.spark.ml.param.ParamPair-">set</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#set-java.lang.String-java.lang.Object-">set</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#setDefault-org.apache.spark.ml.param.Param-T-">setDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#setDefault-scala.collection.Seq-">setDefault</a>, <a href="../../../../../org/apache/spark/ml/param/Params.html#shouldOwn-org.apache.spark.ml.param.Param-">shouldOwn</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.util.Identifiable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.util.<a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html#toString--">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasFitIntercept"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasFitIntercept.html" title="interface in org.apache.spark.ml.param.shared">HasFitIntercept</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/shared/HasFitIntercept.html#getFitIntercept--">getFitIntercept</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasMaxIter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html" title="interface in org.apache.spark.ml.param.shared">HasMaxIter</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html#getMaxIter--">getMaxIter</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasTol"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasTol.html" title="interface in org.apache.spark.ml.param.shared">HasTol</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/shared/HasTol.html#getTol--">getTol</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasRegParam"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasRegParam.html" title="interface in org.apache.spark.ml.param.shared">HasRegParam</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/shared/HasRegParam.html#getRegParam--">getRegParam</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasWeightCol"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html" title="interface in org.apache.spark.ml.param.shared">HasWeightCol</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html#getWeightCol--">getWeightCol</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasSolver"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasSolver.html" title="interface in org.apache.spark.ml.param.shared">HasSolver</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/shared/HasSolver.html#getSolver--">getSolver</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.param.shared.HasAggregationDepth"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.param.shared.<a href="../../../../../org/apache/spark/ml/param/shared/HasAggregationDepth.html" title="interface in org.apache.spark.ml.param.shared">HasAggregationDepth</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/param/shared/HasAggregationDepth.html#getAggregationDepth--">getAggregationDepth</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.internal.Logging"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.internal.Logging</h3> |
| <code>$init$, initializeForcefully, initializeLogIfNecessary, initializeLogIfNecessary, initializeLogIfNecessary$default$2, initLock, isTraceEnabled, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning, org$apache$spark$internal$Logging$$log__$eq, org$apache$spark$internal$Logging$$log_, uninitialize</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.util.DefaultParamsWritable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.util.<a href="../../../../../org/apache/spark/ml/util/DefaultParamsWritable.html" title="interface in org.apache.spark.ml.util">DefaultParamsWritable</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/util/DefaultParamsWritable.html#write--">write</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.spark.ml.util.MLWritable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.spark.ml.util.<a href="../../../../../org/apache/spark/ml/util/MLWritable.html" title="interface in org.apache.spark.ml.util">MLWritable</a></h3> |
| <code><a href="../../../../../org/apache/spark/ml/util/MLWritable.html#save-java.lang.String-">save</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="GeneralizedLinearRegression-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>GeneralizedLinearRegression</h4> |
| <pre>public GeneralizedLinearRegression(String uid)</pre> |
| </li> |
| </ul> |
| <a name="GeneralizedLinearRegression--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>GeneralizedLinearRegression</h4> |
| <pre>public GeneralizedLinearRegression()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="load-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>load</h4> |
| <pre>public static <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a> load(String path)</pre> |
| </li> |
| </ul> |
| <a name="read--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>read</h4> |
| <pre>public static <a href="../../../../../org/apache/spark/ml/util/MLReader.html" title="class in org.apache.spark.ml.util">MLReader</a><T> read()</pre> |
| </li> |
| </ul> |
| <a name="family--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>family</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String> family()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#family--">GeneralizedLinearRegressionBase</a></code></span></div> |
| <div class="block">Param for the name of family which is a description of the error distribution |
| to be used in the model. |
| Supported options: "gaussian", "binomial", "poisson", "gamma" and "tweedie". |
| Default is "gaussian". |
| <p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#family--">family</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html" title="interface in org.apache.spark.ml.regression">GeneralizedLinearRegressionBase</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="variancePower--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>variancePower</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a> variancePower()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#variancePower--">GeneralizedLinearRegressionBase</a></code></span></div> |
| <div class="block">Param for the power in the variance function of the Tweedie distribution which provides |
| the relationship between the variance and mean of the distribution. |
| Only applicable to the Tweedie family. |
| (see <a href="https://en.wikipedia.org/wiki/Tweedie_distribution"> |
| Tweedie Distribution (Wikipedia)</a>) |
| Supported values: 0 and [1, Inf). |
| Note that variance power 0, 1, or 2 corresponds to the Gaussian, Poisson or Gamma |
| family, respectively. |
| <p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#variancePower--">variancePower</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html" title="interface in org.apache.spark.ml.regression">GeneralizedLinearRegressionBase</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="link--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>link</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String> link()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#link--">GeneralizedLinearRegressionBase</a></code></span></div> |
| <div class="block">Param for the name of link function which provides the relationship |
| between the linear predictor and the mean of the distribution function. |
| Supported options: "identity", "log", "inverse", "logit", "probit", "cloglog" and "sqrt". |
| This is used only when family is not "tweedie". The link function for the "tweedie" family |
| must be specified through <code>linkPower</code>. |
| <p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#link--">link</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html" title="interface in org.apache.spark.ml.regression">GeneralizedLinearRegressionBase</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="linkPower--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>linkPower</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a> linkPower()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#linkPower--">GeneralizedLinearRegressionBase</a></code></span></div> |
| <div class="block">Param for the index in the power link function. Only applicable to the Tweedie family. |
| Note that link power 0, 1, -1 or 0.5 corresponds to the Log, Identity, Inverse or Sqrt |
| link, respectively. |
| When not set, this value defaults to 1 - <code>variancePower</code>, which matches the R "statmod" |
| package. |
| <p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#linkPower--">linkPower</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html" title="interface in org.apache.spark.ml.regression">GeneralizedLinearRegressionBase</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="linkPredictionCol--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>linkPredictionCol</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String> linkPredictionCol()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#linkPredictionCol--">GeneralizedLinearRegressionBase</a></code></span></div> |
| <div class="block">Param for link prediction (linear predictor) column name. |
| Default is not set, which means we do not output link prediction. |
| <p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#linkPredictionCol--">linkPredictionCol</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html" title="interface in org.apache.spark.ml.regression">GeneralizedLinearRegressionBase</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="offsetCol--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>offsetCol</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String> offsetCol()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#offsetCol--">GeneralizedLinearRegressionBase</a></code></span></div> |
| <div class="block">Param for offset column name. If this is not set or empty, we treat all instance offsets |
| as 0.0. The feature specified as offset has a constant coefficient of 1.0. |
| <p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#offsetCol--">offsetCol</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html" title="interface in org.apache.spark.ml.regression">GeneralizedLinearRegressionBase</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="solver--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>solver</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String> solver()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#solver--">GeneralizedLinearRegressionBase</a></code></span></div> |
| <div class="block">The solver algorithm for optimization. |
| Supported options: "irls" (iteratively reweighted least squares). |
| Default: "irls" |
| <p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/param/shared/HasSolver.html#solver--">solver</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/param/shared/HasSolver.html" title="interface in org.apache.spark.ml.param.shared">HasSolver</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html#solver--">solver</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionBase.html" title="interface in org.apache.spark.ml.regression">GeneralizedLinearRegressionBase</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="aggregationDepth--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>aggregationDepth</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a> aggregationDepth()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/param/shared/HasAggregationDepth.html#aggregationDepth--">HasAggregationDepth</a></code></span></div> |
| <div class="block">Param for suggested depth for treeAggregate (&gt;= 2).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/param/shared/HasAggregationDepth.html#aggregationDepth--">aggregationDepth</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/param/shared/HasAggregationDepth.html" title="interface in org.apache.spark.ml.param.shared">HasAggregationDepth</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="weightCol--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>weightCol</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/Param.html" title="class in org.apache.spark.ml.param">Param</a><String> weightCol()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html#weightCol--">HasWeightCol</a></code></span></div> |
| <div class="block">Param for weight column name. If this is not set or empty, we treat all instance weights as 1.0.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html#weightCol--">weightCol</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/param/shared/HasWeightCol.html" title="interface in org.apache.spark.ml.param.shared">HasWeightCol</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="regParam--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>regParam</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a> regParam()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/param/shared/HasRegParam.html#regParam--">HasRegParam</a></code></span></div> |
| <div class="block">Param for regularization parameter (&gt;= 0).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/param/shared/HasRegParam.html#regParam--">regParam</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/param/shared/HasRegParam.html" title="interface in org.apache.spark.ml.param.shared">HasRegParam</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="tol--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>tol</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/DoubleParam.html" title="class in org.apache.spark.ml.param">DoubleParam</a> tol()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/param/shared/HasTol.html#tol--">HasTol</a></code></span></div> |
| <div class="block">Param for the convergence tolerance for iterative algorithms (&gt;= 0).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/param/shared/HasTol.html#tol--">tol</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/param/shared/HasTol.html" title="interface in org.apache.spark.ml.param.shared">HasTol</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="maxIter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>maxIter</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/IntParam.html" title="class in org.apache.spark.ml.param">IntParam</a> maxIter()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html#maxIter--">HasMaxIter</a></code></span></div> |
| <div class="block">Param for maximum number of iterations (&gt;= 0).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html#maxIter--">maxIter</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/param/shared/HasMaxIter.html" title="interface in org.apache.spark.ml.param.shared">HasMaxIter</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fitIntercept--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fitIntercept</h4> |
| <pre>public final <a href="../../../../../org/apache/spark/ml/param/BooleanParam.html" title="class in org.apache.spark.ml.param">BooleanParam</a> fitIntercept()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/param/shared/HasFitIntercept.html#fitIntercept--">HasFitIntercept</a></code></span></div> |
| <div class="block">Param for whether to fit an intercept term.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/param/shared/HasFitIntercept.html#fitIntercept--">fitIntercept</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/param/shared/HasFitIntercept.html" title="interface in org.apache.spark.ml.param.shared">HasFitIntercept</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="uid--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>uid</h4> |
| <pre>public String uid()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html#uid--">Identifiable</a></code></span></div> |
| <div class="block">An immutable unique ID for the object and its derivatives.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html#uid--">uid</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFamily-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFamily</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a> setFamily(String value)</pre> |
| <div class="block">Sets the value of param <code>family</code>. |
| Default is "gaussian". |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setVariancePower-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setVariancePower</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a> setVariancePower(double value)</pre> |
| <div class="block">Sets the value of param <code>variancePower</code>. |
| Used only when family is "tweedie". |
| Default is 0.0, which corresponds to the "gaussian" family. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLinkPower-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLinkPower</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a> setLinkPower(double value)</pre> |
| <div class="block">Sets the value of param <code>linkPower</code>. |
| Used only when family is "tweedie". |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLink-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLink</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a> setLink(String value)</pre> |
| <div class="block">Sets the value of param <code>link</code>. |
| Used only when family is not "tweedie". |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setFitIntercept-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFitIntercept</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a> setFitIntercept(boolean value)</pre> |
| <div class="block">Sets if we should fit the intercept. |
| Default is true. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxIter-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxIter</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a> setMaxIter(int value)</pre> |
| <div class="block">Sets the maximum number of iterations (applicable for solver "irls"). |
| Default is 25. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTol-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTol</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a> setTol(double value)</pre> |
| <div class="block">Sets the convergence tolerance of iterations. |
| Smaller value will lead to higher accuracy with the cost of more iterations. |
| Default is 1E-6. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">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 <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a> setRegParam(double value)</pre> |
| <div class="block">Sets the regularization parameter for L2 regularization. |
| The regularization term is |
| <blockquote> |
| $$ |
| 0.5 * regParam * L2norm(coefficients)^2 |
| $$ |
| </blockquote> |
| Default is 0.0. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setWeightCol-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setWeightCol</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a> setWeightCol(String value)</pre> |
| <div class="block">Sets the value of param <code>weightCol</code>. |
| If this is not set or empty, we treat all instance weights as 1.0. |
| Default is not set, so all instances have weight one. |
| In the Binomial family, weights correspond to number of trials and should be integer. |
| Non-integer weights are rounded to integer in AIC calculation. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setOffsetCol-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setOffsetCol</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a> setOffsetCol(String value)</pre> |
| <div class="block">Sets the value of param <code>offsetCol</code>. |
| If this is not set or empty, we treat all instance offsets as 0.0. |
| Default is not set, so all instances have offset 0.0. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSolver-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSolver</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a> setSolver(String value)</pre> |
| <div class="block">Sets the solver algorithm used for optimization. |
| Currently only supports "irls" which is also the default solver. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setLinkPredictionCol-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLinkPredictionCol</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a> setLinkPredictionCol(String value)</pre> |
| <div class="block">Sets the link prediction (linear predictor) column name. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAggregationDepth-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAggregationDepth</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a> setAggregationDepth(int value)</pre> |
| </li> |
| </ul> |
| <a name="copy-org.apache.spark.ml.param.ParamMap-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>copy</h4> |
| <pre>public <a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a> copy(<a href="../../../../../org/apache/spark/ml/param/ParamMap.html" title="class in org.apache.spark.ml.param">ParamMap</a> extra)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/param/Params.html#copy-org.apache.spark.ml.param.ParamMap-">Params</a></code></span></div> |
| <div class="block">Creates a copy of this instance with the same UID and some extra params. |
| Subclasses should implement this method and set the return type properly. |
| See <code>defaultCopy()</code>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/param/Params.html#copy-org.apache.spark.ml.param.ParamMap-">copy</a></code> in interface <code><a href="../../../../../org/apache/spark/ml/param/Params.html" title="interface in org.apache.spark.ml.param">Params</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/spark/ml/Predictor.html#copy-org.apache.spark.ml.param.ParamMap-">copy</a></code> in class <code><a href="../../../../../org/apache/spark/ml/Predictor.html" title="class in org.apache.spark.ml">Predictor</a><<a href="../../../../../org/apache/spark/ml/linalg/Vector.html" title="interface in org.apache.spark.ml.linalg">Vector</a>,<a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegression</a>,<a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegressionModel.html" title="class in org.apache.spark.ml.regression">GeneralizedLinearRegressionModel</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>extra</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">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> |
| <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="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/ml/regression/GBTRegressor.html" title="class in org.apache.spark.ml.regression"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/spark/ml/regression/GeneralizedLinearRegression.Binomial$.html" title="class in org.apache.spark.ml.regression"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/spark/ml/regression/GeneralizedLinearRegression.html" target="_top">Frames</a></li> |
| <li><a href="GeneralizedLinearRegression.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </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>Field | </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 ======= --> |
| <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> |
