Class FMClassificationSummaryImpl
Object
org.apache.spark.ml.classification.FMClassificationSummaryImpl
 All Implemented Interfaces:
Serializable
,BinaryClassificationSummary
,ClassificationSummary
,FMClassificationSummary
,scala.Serializable
 Direct Known Subclasses:
FMClassificationTrainingSummaryImpl
FMClassifier results for a given model.
param: predictions dataframe output by the model's transform
method.
param: scoreCol field in "predictions" which gives the probability of each instance.
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: weightCol field in "predictions" which gives the weight of each instance.
 See Also:

Constructor Summary

Method Summary
Modifier and TypeMethodDescriptiondouble
Computes the area under the receiver operating characteristic (ROC) curve.Returns a dataframe with two fields (threshold, FMeasure) curve with beta = 1.0.labelCol()
Field in "predictions" which gives the true label of each instance (if available).pr()
Returns the precisionrecall curve, which is a Dataframe containing two fields recall, precision with (0.0, 1.0) prepended to it.Returns a dataframe with two fields (threshold, precision) curve.Field in "predictions" which gives the prediction of each class.Dataframe output by the model'stransform
method.Returns a dataframe with two fields (threshold, recall) curve.roc()
Returns the receiver operating characteristic (ROC) curve, which is a Dataframe having two fields (FPR, TPR) with (0.0, 0.0) prepended and (1.0, 1.0) appended to it.scoreCol()
Field in "predictions" which gives the probability or rawPrediction of each class as a vector.Field in "predictions" which gives the weight of each instance.Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.spark.ml.classification.ClassificationSummary
accuracy, falsePositiveRateByLabel, fMeasureByLabel, fMeasureByLabel, labels, precisionByLabel, recallByLabel, truePositiveRateByLabel, weightedFalsePositiveRate, weightedFMeasure, weightedFMeasure, weightedPrecision, weightedRecall, weightedTruePositiveRate

Constructor Details

FMClassificationSummaryImpl


Method Details

areaUnderROC
public double areaUnderROC()Description copied from interface:BinaryClassificationSummary
Computes the area under the receiver operating characteristic (ROC) curve. Specified by:
areaUnderROC
in interfaceBinaryClassificationSummary
 Returns:
 (undocumented)

fMeasureByThreshold
Description copied from interface:BinaryClassificationSummary
Returns a dataframe with two fields (threshold, FMeasure) curve with beta = 1.0. Specified by:
fMeasureByThreshold
in interfaceBinaryClassificationSummary
 Returns:
 (undocumented)

labelCol
Description copied from interface:ClassificationSummary
Field in "predictions" which gives the true label of each instance (if available). Specified by:
labelCol
in interfaceClassificationSummary

pr
Description copied from interface:BinaryClassificationSummary
Returns the precisionrecall curve, which is a Dataframe containing two fields recall, precision with (0.0, 1.0) prepended to it. Specified by:
pr
in interfaceBinaryClassificationSummary
 Returns:
 (undocumented)

precisionByThreshold
Description copied from interface:BinaryClassificationSummary
Returns a dataframe with two fields (threshold, precision) curve. Every possible probability obtained in transforming the dataset are used as thresholds used in calculating the precision. Specified by:
precisionByThreshold
in interfaceBinaryClassificationSummary
 Returns:
 (undocumented)

predictionCol
Description copied from interface:ClassificationSummary
Field in "predictions" which gives the prediction of each class. Specified by:
predictionCol
in interfaceClassificationSummary

predictions
Description copied from interface:ClassificationSummary
Dataframe output by the model'stransform
method. Specified by:
predictions
in interfaceClassificationSummary
 Returns:
 (undocumented)

recallByThreshold
Description copied from interface:BinaryClassificationSummary
Returns a dataframe with two fields (threshold, recall) curve. Every possible probability obtained in transforming the dataset are used as thresholds used in calculating the recall. Specified by:
recallByThreshold
in interfaceBinaryClassificationSummary
 Returns:
 (undocumented)

roc
Description copied from interface:BinaryClassificationSummary
Returns the receiver operating characteristic (ROC) curve, which is a Dataframe having two fields (FPR, TPR) with (0.0, 0.0) prepended and (1.0, 1.0) appended to it. See http://en.wikipedia.org/wiki/Receiver_operating_characteristic Specified by:
roc
in interfaceBinaryClassificationSummary
 Returns:
 (undocumented)

scoreCol
Description copied from interface:BinaryClassificationSummary
Field in "predictions" which gives the probability or rawPrediction of each class as a vector. Specified by:
scoreCol
in interfaceBinaryClassificationSummary
 Returns:
 (undocumented)

weightCol
Description copied from interface:ClassificationSummary
Field in "predictions" which gives the weight of each instance. Specified by:
weightCol
in interfaceClassificationSummary
