BinaryLogisticRegressionTrainingSummaryImpl (Spark 3.5.5 JavaDoc) (original) (raw)

• Object

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

• All Implemented Interfaces:
  java.io.Serializable, BinaryClassificationSummary, BinaryLogisticRegressionSummary, BinaryLogisticRegressionTrainingSummary, ClassificationSummary, LogisticRegressionSummary, LogisticRegressionTrainingSummary, TrainingSummary

public class BinaryLogisticRegressionTrainingSummaryImpl
extends BinaryLogisticRegressionSummaryImpl
implements BinaryLogisticRegressionTrainingSummary
Binary logistic regression training results.
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. param: objectiveHistory objective function (scaled loss + regularization) at each iteration.
See Also:
Serialized Form

• • Constructor Summary

  Constructors

  Constructor and Description
  BinaryLogisticRegressionTrainingSummaryImpl(Dataset<Row> predictions, String probabilityCol, String predictionCol, String labelCol, String featuresCol, String weightCol, double[] objectiveHistory)

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method and Description
  double[]	objectiveHistory() objective function (scaled loss + regularization) at each iteration.

     * ### Methods inherited from class org.apache.spark.ml.classification.[BinaryLogisticRegressionSummaryImpl](../../../../../org/apache/spark/ml/classification/BinaryLogisticRegressionSummaryImpl.html "class in org.apache.spark.ml.classification")  
     `[areaUnderROC](../../../../../org/apache/spark/ml/classification/BinaryLogisticRegressionSummaryImpl.html#areaUnderROC--), [fMeasureByThreshold](../../../../../org/apache/spark/ml/classification/BinaryLogisticRegressionSummaryImpl.html#fMeasureByThreshold--), [pr](../../../../../org/apache/spark/ml/classification/BinaryLogisticRegressionSummaryImpl.html#pr--), [precisionByThreshold](../../../../../org/apache/spark/ml/classification/BinaryLogisticRegressionSummaryImpl.html#precisionByThreshold--), [recallByThreshold](../../../../../org/apache/spark/ml/classification/BinaryLogisticRegressionSummaryImpl.html#recallByThreshold--), [roc](../../../../../org/apache/spark/ml/classification/BinaryLogisticRegressionSummaryImpl.html#roc--)`  
     * ### Methods inherited from class org.apache.spark.ml.classification.[LogisticRegressionSummaryImpl](../../../../../org/apache/spark/ml/classification/LogisticRegressionSummaryImpl.html "class in org.apache.spark.ml.classification")  
     `[featuresCol](../../../../../org/apache/spark/ml/classification/LogisticRegressionSummaryImpl.html#featuresCol--), [labelCol](../../../../../org/apache/spark/ml/classification/LogisticRegressionSummaryImpl.html#labelCol--), [predictionCol](../../../../../org/apache/spark/ml/classification/LogisticRegressionSummaryImpl.html#predictionCol--), [predictions](../../../../../org/apache/spark/ml/classification/LogisticRegressionSummaryImpl.html#predictions--), [probabilityCol](../../../../../org/apache/spark/ml/classification/LogisticRegressionSummaryImpl.html#probabilityCol--), [weightCol](../../../../../org/apache/spark/ml/classification/LogisticRegressionSummaryImpl.html#weightCol--)`  
     * ### Methods inherited from class Object  
     `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`  
     * ### Methods inherited from interface org.apache.spark.ml.classification.[BinaryLogisticRegressionSummary](../../../../../org/apache/spark/ml/classification/BinaryLogisticRegressionSummary.html "interface in org.apache.spark.ml.classification")  
     `[scoreCol](../../../../../org/apache/spark/ml/classification/BinaryLogisticRegressionSummary.html#scoreCol--)`  
     * ### Methods inherited from interface org.apache.spark.ml.classification.[BinaryClassificationSummary](../../../../../org/apache/spark/ml/classification/BinaryClassificationSummary.html "interface in org.apache.spark.ml.classification")  
     `[areaUnderROC](../../../../../org/apache/spark/ml/classification/BinaryClassificationSummary.html#areaUnderROC--), [fMeasureByThreshold](../../../../../org/apache/spark/ml/classification/BinaryClassificationSummary.html#fMeasureByThreshold--), [pr](../../../../../org/apache/spark/ml/classification/BinaryClassificationSummary.html#pr--), [precisionByThreshold](../../../../../org/apache/spark/ml/classification/BinaryClassificationSummary.html#precisionByThreshold--), [recallByThreshold](../../../../../org/apache/spark/ml/classification/BinaryClassificationSummary.html#recallByThreshold--), [roc](../../../../../org/apache/spark/ml/classification/BinaryClassificationSummary.html#roc--)`  
     * ### 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--), [featuresCol](../../../../../org/apache/spark/ml/classification/LogisticRegressionSummary.html#featuresCol--), [probabilityCol](../../../../../org/apache/spark/ml/classification/LogisticRegressionSummary.html#probabilityCol--)`  
     * ### 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-), [labelCol](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#labelCol--), [labels](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#labels--), [precisionByLabel](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#precisionByLabel--), [predictionCol](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#predictionCol--), [predictions](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#predictions--), [recallByLabel](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#recallByLabel--), [truePositiveRateByLabel](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#truePositiveRateByLabel--), [weightCol](../../../../../org/apache/spark/ml/classification/ClassificationSummary.html#weightCol--), [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--)`  
     * ### Methods inherited from interface org.apache.spark.ml.classification.[TrainingSummary](../../../../../org/apache/spark/ml/classification/TrainingSummary.html "interface in org.apache.spark.ml.classification")  
     `[totalIterations](../../../../../org/apache/spark/ml/classification/TrainingSummary.html#totalIterations--)`

• • Constructor Detail

     * #### BinaryLogisticRegressionTrainingSummaryImpl  
     public BinaryLogisticRegressionTrainingSummaryImpl([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,  
                                                        double[] objectiveHistory)  

  • Method Detail

    * #### objectiveHistory  
    public double[] objectiveHistory()  
    objective function (scaled loss + regularization) at each iteration. It contains one more element, the initial state, than number of iterations.  
    Specified by:  
    `[objectiveHistory](../../../../../org/apache/spark/ml/classification/TrainingSummary.html#objectiveHistory--)` in interface `[TrainingSummary](../../../../../org/apache/spark/ml/classification/TrainingSummary.html "interface in org.apache.spark.ml.classification")`  
    Returns:  
    (undocumented)