Github user MechCoder commented on a diff in the pull request:
https://github.com/apache/spark/pull/8197#discussion_r37347889
--- Diff: docs/ml-linear-methods.md ---
@@ -118,12 +133,114 @@ lrModel = lr.fit(training)
print("Weights: " + str(lrModel.weights))
print("Intercept: " + str(lrModel.intercept))
{% endhighlight %}
+</div>
</div>
+The `spark.ml` implementation of logistic regression also supports
+extracting a summary of the model over the training set. Note that the
+predictions and metrics which are stored as `Datafram`s in
+`BinaryLogisticRegressionSummary` are annoted `@transient` and hence
+only available on the driver.
+
+<div class="codetabs">
+
+<div data-lang="scala" markdown="1">
+
+[`LogisticRegressionTrainingSummary`](api/scala/index.html#org.apache.spark.ml.classification.LogisticRegressionTrainingSummary)
+provides a summary for a
+[`LogisticRegressionModel`](api/scala/index.html#org.apache.spark.ml.classification.LogisticRegressionModel).
+Currently, only binary classification is supported and the
+summary must be explicitly cast to
+[`BinaryLogisticRegressionTrainingSummary`](api/scala/index.html#org.apache.spark.ml.classification.BinaryLogisticRegressionTrainingSummary).
+This will likely change when multiclass classification is supported.
--- End diff --
The other option would be just to make all metrics available in
`LogisticRegressionSummary`and raise errors when multiclass data is used. In
that case there would have not been a need for a
`BinaryLogisticRegressionSummary`. However this was preferred.
See:
https://github.com/apache/spark/pull/7538#issuecomment-128445916 and
https://github.com/apache/spark/pull/7538#issuecomment-127395327 and
https://github.com/apache/spark/pull/7538#issuecomment-127427628
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
