LogisticRegressionSummaryImpl (Spark 3.5.5 JavaDoc) (original) (raw)

• Object

• • org.apache.spark.ml.classification.LogisticRegressionSummaryImpl

• All Implemented Interfaces:
  java.io.Serializable, ClassificationSummary, LogisticRegressionSummary
  Direct Known Subclasses:
  BinaryLogisticRegressionSummaryImpl, LogisticRegressionTrainingSummaryImpl

public class LogisticRegressionSummaryImpl
extends Object
implements LogisticRegressionSummary
Multiclass logistic regression results for a given model.
param: predictions dataframe output by the model's transform method. param: probabilityCol field in "predictions" which gives the probability of each class as a vector. param: predictionCol field in "predictions" which gives the prediction for a data instance as a double. param: labelCol field in "predictions" which gives the true label of each instance. param: featuresCol field in "predictions" which gives the features of each instance as a vector. param: weightCol field in "predictions" which gives the weight of each instance.
See Also:
Serialized Form

• • Constructor Summary

  Constructors

  Constructor and Description
  LogisticRegressionSummaryImpl(Dataset<Row> predictions, String probabilityCol, String predictionCol, String labelCol, String featuresCol, String weightCol)

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method and Description
  String	featuresCol() Field in "predictions" which gives the features of each instance as a vector.
  String	labelCol() Field in "predictions" which gives the true label of each instance (if available).
  String	predictionCol() Field in "predictions" which gives the prediction of each class.
  Dataset<Row>	predictions() Dataframe output by the model's transform method.
  String	probabilityCol() Field in "predictions" which gives the probability of each class as a vector.
  String	weightCol() Field in "predictions" which gives the weight of each instance.

     * ### Methods inherited from class Object  
     `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`  
     * ### Methods inherited from interface org.apache.spark.ml.classification.[LogisticRegressionSummary](../../../../../org/apache/spark/ml/classification/LogisticRegressionSummary.html "interface in org.apache.spark.ml.classification")  
     `[asBinary](../../../../../org/apache/spark/ml/classification/LogisticRegressionSummary.html#asBinary--)`  
     * ### Methods inherited from interface org.apache.spark.ml.classification.[ClassificationSummary](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html "interface in org.apache.spark.ml.classification")  
     `[accuracy](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#accuracy--), [falsePositiveRateByLabel](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#falsePositiveRateByLabel--), [fMeasureByLabel](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#fMeasureByLabel--), [fMeasureByLabel](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#fMeasureByLabel-double-), [labels](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#labels--), [precisionByLabel](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#precisionByLabel--), [recallByLabel](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#recallByLabel--), [truePositiveRateByLabel](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#truePositiveRateByLabel--), [weightedFalsePositiveRate](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#weightedFalsePositiveRate--), [weightedFMeasure](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#weightedFMeasure--), [weightedFMeasure](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#weightedFMeasure-double-), [weightedPrecision](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#weightedPrecision--), [weightedRecall](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#weightedRecall--), [weightedTruePositiveRate](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#weightedTruePositiveRate--)`

• • Constructor Detail

     * #### LogisticRegressionSummaryImpl  
     public LogisticRegressionSummaryImpl([Dataset](../../../../../org/apache/spark/sql/Dataset.html "class in org.apache.spark.sql")<[Row](../../../../../org/apache/spark/sql/Row.html "interface in org.apache.spark.sql")> predictions,  
                                          String probabilityCol,  
                                          String predictionCol,  
                                          String labelCol,  
                                          String featuresCol,  
                                          String weightCol)  

  • Method Detail

    * #### featuresCol  
    public String featuresCol()  
    Field in "predictions" which gives the features of each instance as a vector.  
    Specified by:  
    `[featuresCol](../../../../../org/apache/spark/ml/classification/LogisticRegressionSummary.html#featuresCol--)` in interface `[LogisticRegressionSummary](../../../../../org/apache/spark/ml/classification/LogisticRegressionSummary.html "interface in org.apache.spark.ml.classification")`  
    * #### labelCol  
    public String labelCol()  
    Field in "predictions" which gives the true label of each instance (if available).  
    Specified by:  
    `[labelCol](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#labelCol--)` in interface `[ClassificationSummary](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html "interface in org.apache.spark.ml.classification")`  
    * #### predictionCol  
    public String predictionCol()  
    Field in "predictions" which gives the prediction of each class.  
    Specified by:  
    `[predictionCol](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#predictionCol--)` in interface `[ClassificationSummary](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html "interface in org.apache.spark.ml.classification")`  
    * #### predictions  
    public [Dataset](../../../../../org/apache/spark/sql/Dataset.html "class in org.apache.spark.sql")<[Row](../../../../../org/apache/spark/sql/Row.html "interface in org.apache.spark.sql")> predictions()  
    Dataframe output by the model's `transform` method.  
    Specified by:  
    `[predictions](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#predictions--)` in interface `[ClassificationSummary](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html "interface in org.apache.spark.ml.classification")`  
    Returns:  
    (undocumented)  
    * #### probabilityCol  
    public String probabilityCol()  
    Field in "predictions" which gives the probability of each class as a vector.  
    Specified by:  
    `[probabilityCol](../../../../../org/apache/spark/ml/classification/LogisticRegressionSummary.html#probabilityCol--)` in interface `[LogisticRegressionSummary](../../../../../org/apache/spark/ml/classification/LogisticRegressionSummary.html "interface in org.apache.spark.ml.classification")`  
    * #### weightCol  
    public String weightCol()  
    Field in "predictions" which gives the weight of each instance.  
    Specified by:  
    `[weightCol](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#weightCol--)` in interface `[ClassificationSummary](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html "interface in org.apache.spark.ml.classification")`