<!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 15:55:11 PDT 2015 -->
<title>LogisticRegression</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="LogisticRegression";
}
//-->
</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/ml/classification/LogisticCostFun.html" title="class in org.apache.spark.ml.classification"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/ml/classification/LogisticRegressionModel.html" title="class in org.apache.spark.ml.classification"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/ml/classification/LogisticRegression.html" target="_top">Frames</a></li>
<li><a href="LogisticRegression.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>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.classification</div>
<h2 title="Class LogisticRegression" class="title">Class LogisticRegression</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.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,E,M></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/spark/ml/classification/Classifier.html" title="class in org.apache.spark.ml.classification">org.apache.spark.ml.classification.Classifier</a><FeaturesType,E,M></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/spark/ml/classification/ProbabilisticClassifier.html" title="class in org.apache.spark.ml.classification">org.apache.spark.ml.classification.ProbabilisticClassifier</a><<a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a>,<a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a>,<a href="../../../../../org/apache/spark/ml/classification/LogisticRegressionModel.html" title="class in org.apache.spark.ml.classification">LogisticRegressionModel</a>></li>
<li>
<ul class="inheritance">
<li>org.apache.spark.ml.classification.LogisticRegression</li>
</ul>
</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, <a href="../../../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a>, <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/util/Identifiable.html" title="interface in org.apache.spark.ml.util">Identifiable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">LogisticRegression</span>
extends <a href="../../../../../org/apache/spark/ml/classification/ProbabilisticClassifier.html" title="class in org.apache.spark.ml.classification">ProbabilisticClassifier</a><<a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a>,<a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a>,<a href="../../../../../org/apache/spark/ml/classification/LogisticRegressionModel.html" title="class in org.apache.spark.ml.classification">LogisticRegressionModel</a>>
implements <a href="../../../../../org/apache/spark/Logging.html" title="interface in org.apache.spark">Logging</a></pre>
<div class="block">:: Experimental ::
Logistic regression.
Currently, this class only supports binary classification. It will support multiclass
in the future.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.spark.ml.classification.LogisticRegression">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"> </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/ml/classification/LogisticRegression.html#LogisticRegression()">LogisticRegression</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#LogisticRegression(java.lang.String)">LogisticRegression</a></strong>(java.lang.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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#checkThresholdConsistency()">checkThresholdConsistency</a></strong>()</code>
<div class="block">If <code>threshold</code> and <code>thresholds</code> are both set, ensures they are consistent.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#copy(org.apache.spark.ml.param.ParamMap)">copy</a></strong>(<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 class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#getThreshold()">getThreshold</a></strong>()</code>
<div class="block">Get threshold for binary classification.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#getThresholds()">getThresholds</a></strong>()</code>
<div class="block">Get thresholds for binary or multiclass classification.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#setElasticNetParam(double)">setElasticNetParam</a></strong>(double value)</code>
<div class="block">Set the ElasticNet mixing parameter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#setFitIntercept(boolean)">setFitIntercept</a></strong>(boolean value)</code>
<div class="block">Whether to fit an intercept term.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#setMaxIter(int)">setMaxIter</a></strong>(int value)</code>
<div class="block">Set the maximum number of iterations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#setRegParam(double)">setRegParam</a></strong>(double value)</code>
<div class="block">Set the regularization parameter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#setStandardization(boolean)">setStandardization</a></strong>(boolean value)</code>
<div class="block">Whether to standardize the training features before fitting the model.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#setThreshold(double)">setThreshold</a></strong>(double value)</code>
<div class="block">Set threshold in binary classification, in range [0, 1].</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#setThresholds(double[])">setThresholds</a></strong>(double[] value)</code>
<div class="block">Set thresholds in multiclass (or binary) classification to adjust the probability of
predicting each class.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#setTol(double)">setTol</a></strong>(double value)</code>
<div class="block">Set the convergence tolerance of iterations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/spark/ml/classification/LogisticRegressionModel.html" title="class in org.apache.spark.ml.classification">LogisticRegressionModel</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#train(org.apache.spark.sql.DataFrame)">train</a></strong>(<a href="../../../../../org/apache/spark/sql/DataFrame.html" title="class in org.apache.spark.sql">DataFrame</a> dataset)</code>
<div class="block">Train a model using the given dataset and parameters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#uid()">uid</a></strong>()</code>
<div class="block">An immutable unique ID for the object and its derivatives.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#validateAndTransformSchema(org.apache.spark.sql.types.StructType, boolean, org.apache.spark.sql.types.DataType)">validateAndTransformSchema</a></strong>(<a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a> schema,
boolean fitting,
<a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a> featuresDataType)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#validateAndTransformSchema(org.apache.spark.sql.types.StructType, boolean, org.apache.spark.sql.types.DataType)">validateAndTransformSchema</a></strong>(<a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a> schema,
boolean fitting,
<a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a> featuresDataType)</code>
<div class="block">Validates and transforms the input schema with the provided param map.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html#validateParams()">validateParams</a></strong>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.ml.classification.ProbabilisticClassifier">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.spark.ml.classification.<a href="../../../../../org/apache/spark/ml/classification/ProbabilisticClassifier.html" title="class in org.apache.spark.ml.classification">ProbabilisticClassifier</a></h3>
<code><a href="../../../../../org/apache/spark/ml/classification/ProbabilisticClassifier.html#setProbabilityCol(java.lang.String)">setProbabilityCol</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.spark.ml.classification.Classifier">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.spark.ml.classification.<a href="../../../../../org/apache/spark/ml/classification/Classifier.html" title="class in org.apache.spark.ml.classification">Classifier</a></h3>
<code><a href="../../../../../org/apache/spark/ml/classification/Classifier.html#setRawPredictionCol(java.lang.String)">setRawPredictionCol</a></code></li>
</ul>
<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#extractLabeledPoints(org.apache.spark.sql.DataFrame)">extractLabeledPoints</a>, <a href="../../../../../org/apache/spark/ml/Predictor.html#fit(org.apache.spark.sql.DataFrame)">fit</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.DataFrame, org.apache.spark.ml.param.ParamMap)">fit</a>, <a href="../../../../../org/apache/spark/ml/Estimator.html#fit(org.apache.spark.sql.DataFrame, org.apache.spark.ml.param.ParamMap[])">fit</a>, <a href="../../../../../org/apache/spark/ml/Estimator.html#fit(org.apache.spark.sql.DataFrame, 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.DataFrame, org.apache.spark.ml.param.ParamPair, 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#transformSchema(org.apache.spark.sql.types.StructType, boolean)">transformSchema</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.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 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>
<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>, <a href="../../../../../org/apache/spark/ml/param/Params.html#validateParams()">validateParams</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>
</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="LogisticRegression(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LogisticRegression</h4>
<pre>public LogisticRegression(java.lang.String uid)</pre>
</li>
</ul>
<a name="LogisticRegression()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LogisticRegression</h4>
<pre>public LogisticRegression()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="uid()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>uid</h4>
<pre>public java.lang.String uid()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/util/Identifiable.html#uid()">Identifiable</a></code></strong></div>
<div class="block">An immutable unique ID for the object and its derivatives.</div>
<dl>
<dt><strong>Specified by:</strong></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="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 <a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a> setRegParam(double value)</pre>
<div class="block">Set the regularization parameter.
Default is 0.0.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setElasticNetParam(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setElasticNetParam</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a> setElasticNetParam(double value)</pre>
<div class="block">Set the ElasticNet mixing parameter.
For alpha = 0, the penalty is an L2 penalty. For alpha = 1, it is an L1 penalty.
For 0 < alpha < 1, the penalty is a combination of L1 and L2.
Default is 0.0 which is an L2 penalty.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - (undocumented)</dd>
<dt><span class="strong">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/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a> setMaxIter(int value)</pre>
<div class="block">Set the maximum number of iterations.
Default is 100.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - (undocumented)</dd>
<dt><span class="strong">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/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a> setTol(double value)</pre>
<div class="block">Set the convergence tolerance of iterations.
Smaller value will lead to higher accuracy with the cost of more iterations.
Default is 1E-6.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - (undocumented)</dd>
<dt><span class="strong">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/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a> setFitIntercept(boolean value)</pre>
<div class="block">Whether to fit an intercept term.
Default is true.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setStandardization(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStandardization</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a> setStandardization(boolean value)</pre>
<div class="block">Whether to standardize the training features before fitting the model.
The coefficients of models will be always returned on the original scale,
so it will be transparent for users. Note that with/without standardization,
the models should be always converged to the same solution when no regularization
is applied. In R's GLMNET package, the default behavior is true as well.
Default is true.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setThreshold(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setThreshold</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a> setThreshold(double value)</pre>
<div class="block">Set threshold in binary classification, in range [0, 1].
<p>
If the estimated probability of class label 1 is > threshold, then predict 1, else 0.
A high threshold encourages the model to predict 0 more often;
a low threshold encourages the model to predict 1 more often.
<p>
Note: Calling this with threshold p is equivalent to calling <code>setThresholds(Array(1-p, p))</code>.
When <code>setThreshold()</code> is called, any user-set value for <code>thresholds</code> will be cleared.
If both <code>threshold</code> and <code>thresholds</code> are set in a ParamMap, then they must be
equivalent.
<p>
Default is 0.5.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="getThreshold()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThreshold</h4>
<pre>public double getThreshold()</pre>
<div class="block">Get threshold for binary classification.
<p>
If <code>threshold</code> is set, returns that value.
Otherwise, if <code>thresholds</code> is set with length 2 (i.e., binary classification),
this returns the equivalent threshold: <pre><code>1 / (1 + thresholds(0) / thresholds(1))</code></pre>.
Otherwise, returns {@link threshold} default value.
@group getParam
@throws IllegalArgumentException if {@link thresholds} is set to an array of length other than 2.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="setThresholds(double[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setThresholds</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a> setThresholds(double[] value)</pre>
<div class="block">Set thresholds in multiclass (or binary) classification to adjust the probability of
predicting each class. Array must have length equal to the number of classes, with values >= 0.
The class with largest value p/t is predicted, where p is the original probability of that
class and t is the class' threshold.
<p>
Note: When <code>setThresholds()</code> is called, any user-set value for <code>threshold</code> will be cleared.
If both <code>threshold</code> and <code>thresholds</code> are set in a ParamMap, then they must be
equivalent.
<p></div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/classification/ProbabilisticClassifier.html#setThresholds(double[])">setThresholds</a></code> in class <code><a href="../../../../../org/apache/spark/ml/classification/ProbabilisticClassifier.html" title="class in org.apache.spark.ml.classification">ProbabilisticClassifier</a><<a href="../../../../../org/apache/spark/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a>,<a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a>,<a href="../../../../../org/apache/spark/ml/classification/LogisticRegressionModel.html" title="class in org.apache.spark.ml.classification">LogisticRegressionModel</a>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="getThresholds()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getThresholds</h4>
<pre>public double[] getThresholds()</pre>
<div class="block">Get thresholds for binary or multiclass classification.
<p>
If <code>thresholds</code> is set, return its value.
Otherwise, if <code>threshold</code> is set, return the equivalent thresholds for binary
classification: (1-threshold, threshold).
If neither are set, throw an exception.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<a name="train(org.apache.spark.sql.DataFrame)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>train</h4>
<pre>protected <a href="../../../../../org/apache/spark/ml/classification/LogisticRegressionModel.html" title="class in org.apache.spark.ml.classification">LogisticRegressionModel</a> train(<a href="../../../../../org/apache/spark/sql/DataFrame.html" title="class in org.apache.spark.sql">DataFrame</a> dataset)</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/spark/ml/Predictor.html#train(org.apache.spark.sql.DataFrame)">Predictor</a></code></strong></div>
<div class="block">Train a model using the given dataset and parameters.
Developers can implement this instead of <code>fit()</code> to avoid dealing with schema validation
and copying parameters into the model.
<p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/spark/ml/Predictor.html#train(org.apache.spark.sql.DataFrame)">train</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/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a>,<a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a>,<a href="../../../../../org/apache/spark/ml/classification/LogisticRegressionModel.html" title="class in org.apache.spark.ml.classification">LogisticRegressionModel</a>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>dataset</code> - Training dataset</dd>
<dt><span class="strong">Returns:</span></dt><dd>Fitted model</dd></dl>
</li>
</ul>
<a name="copy(org.apache.spark.ml.param.ParamMap)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre>public <a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</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"><strong>Description copied from interface: <code><a href="../../../../../org/apache/spark/ml/param/Params.html#copy(org.apache.spark.ml.param.ParamMap)">Params</a></code></strong></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.
<p></div>
<dl>
<dt><strong>Specified by:</strong></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><strong>Specified by:</strong></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/mllib/linalg/Vector.html" title="interface in org.apache.spark.mllib.linalg">Vector</a>,<a href="../../../../../org/apache/spark/ml/classification/LogisticRegression.html" title="class in org.apache.spark.ml.classification">LogisticRegression</a>,<a href="../../../../../org/apache/spark/ml/classification/LogisticRegressionModel.html" title="class in org.apache.spark.ml.classification">LogisticRegressionModel</a>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>extra</code> - (undocumented)</dd>
<dt><span class="strong">Returns:</span></dt><dd>(undocumented)</dd><dt><span class="strong">See Also:</span></dt><dd><code>defaultCopy()</code></dd></dl>
</li>
</ul>
<a name="checkThresholdConsistency()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkThresholdConsistency</h4>
<pre>public void checkThresholdConsistency()</pre>
<div class="block">If <code>threshold</code> and <code>thresholds</code> are both set, ensures they are consistent.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if <code>threshold</code> and <code>thresholds</code> are not equivalent</dd></dl>
</li>
</ul>
<a name="validateParams()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateParams</h4>
<pre>public void validateParams()</pre>
</li>
</ul>
<a name="validateAndTransformSchema(org.apache.spark.sql.types.StructType, boolean, org.apache.spark.sql.types.DataType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateAndTransformSchema</h4>
<pre>public <a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a> validateAndTransformSchema(<a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a> schema,
boolean fitting,
<a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a> featuresDataType)</pre>
</li>
</ul>
<a name="validateAndTransformSchema(org.apache.spark.sql.types.StructType, boolean, org.apache.spark.sql.types.DataType)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>validateAndTransformSchema</h4>
<pre>public <a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a> validateAndTransformSchema(<a href="../../../../../org/apache/spark/sql/types/StructType.html" title="class in org.apache.spark.sql.types">StructType</a> schema,
boolean fitting,
<a href="../../../../../org/apache/spark/sql/types/DataType.html" title="class in org.apache.spark.sql.types">DataType</a> featuresDataType)</pre>
<div class="block">Validates and transforms the input schema with the provided param map.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>schema</code> - input schema</dd><dd><code>fitting</code> - whether this is in fitting</dd><dd><code>featuresDataType</code> - SQL DataType for FeaturesType.
E.g., <a href="../../../../../org/apache/spark/mllib/linalg/VectorUDT.html" title="class in org.apache.spark.mllib.linalg"><code>VectorUDT</code></a> for vector features.</dd>
<dt><span class="strong">Returns:</span></dt><dd>output schema</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/ml/classification/LogisticCostFun.html" title="class in org.apache.spark.ml.classification"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/spark/ml/classification/LogisticRegressionModel.html" title="class in org.apache.spark.ml.classification"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/spark/ml/classification/LogisticRegression.html" target="_top">Frames</a></li>
<li><a href="LogisticRegression.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>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>