Class/Object

org.apache.spark.mllib.classification

LogisticRegressionModel

Related Docs: object LogisticRegressionModel | package classification

Permalink

class LogisticRegressionModel extends GeneralizedLinearModel with ClassificationModel with Serializable with Saveable with PMMLExportable

Classification model trained using Multinomial/Binary Logistic Regression.

Annotations
@Since( "0.8.0" )
Source
LogisticRegression.scala
Linear Supertypes
PMMLExportable, Saveable, ClassificationModel, GeneralizedLinearModel, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LogisticRegressionModel
  2. PMMLExportable
  3. Saveable
  4. ClassificationModel
  5. GeneralizedLinearModel
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LogisticRegressionModel(weights: Vector, intercept: Double)

    Permalink

    Constructs a LogisticRegressionModel with weights and intercept for binary classification.

    Constructs a LogisticRegressionModel with weights and intercept for binary classification.

    Annotations
    @Since( "1.0.0" )
  2. new LogisticRegressionModel(weights: Vector, intercept: Double, numFeatures: Int, numClasses: Int)

    Permalink

    weights

    Weights computed for every feature.

    intercept

    Intercept computed for this model. (Only used in Binary Logistic Regression. In Multinomial Logistic Regression, the intercepts will not be a single value, so the intercepts will be part of the weights.)

    numFeatures

    the dimension of the features.

    numClasses

    the number of possible outcomes for k classes classification problem in Multinomial Logistic Regression. By default, it is binary logistic regression so numClasses will be set to 2.

    Annotations
    @Since( "1.3.0" )

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clearThreshold(): LogisticRegressionModel.this.type

    Permalink

    Clears the threshold so that predict will output raw prediction scores.

    Clears the threshold so that predict will output raw prediction scores. It is only used for binary classification.

    Annotations
    @Since( "1.0.0" )
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def formatVersion: String

    Permalink

    Current version of model save/load format.

    Current version of model save/load format.

    Attributes
    protected
    Definition Classes
    LogisticRegressionModelSaveable
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def getThreshold: Option[Double]

    Permalink

    Returns the threshold (if any) used for converting raw prediction scores into 0/1 predictions.

    Returns the threshold (if any) used for converting raw prediction scores into 0/1 predictions. It is only used for binary classification.

    Annotations
    @Since( "1.3.0" )
  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  14. val intercept: Double

    Permalink

    Intercept computed for this model.

    Intercept computed for this model. (Only used in Binary Logistic Regression. In Multinomial Logistic Regression, the intercepts will not be a single value, so the intercepts will be part of the weights.)

    Definition Classes
    LogisticRegressionModelGeneralizedLinearModel
    Annotations
    @Since( "1.0.0" )
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. val numClasses: Int

    Permalink

    the number of possible outcomes for k classes classification problem in Multinomial Logistic Regression.

    the number of possible outcomes for k classes classification problem in Multinomial Logistic Regression. By default, it is binary logistic regression so numClasses will be set to 2.

    Annotations
    @Since( "1.3.0" )
  20. val numFeatures: Int

    Permalink

    the dimension of the features.

    the dimension of the features.

    Annotations
    @Since( "1.3.0" )
  21. def predict(testData: JavaRDD[Vector]): JavaRDD[Double]

    Permalink

    Predict values for examples stored in a JavaRDD.

    Predict values for examples stored in a JavaRDD.

    testData

    JavaRDD representing data points to be predicted

    returns

    a JavaRDD[java.lang.Double] where each entry contains the corresponding prediction

    Definition Classes
    ClassificationModel
    Annotations
    @Since( "1.0.0" )
  22. def predict(testData: Vector): Double

    Permalink

    Predict values for a single data point using the model trained.

    Predict values for a single data point using the model trained.

    testData

    array representing a single data point

    returns

    Double prediction from the trained model

    Definition Classes
    GeneralizedLinearModel
    Annotations
    @Since( "1.0.0" )
  23. def predict(testData: RDD[Vector]): RDD[Double]

    Permalink

    Predict values for the given data set using the model trained.

    Predict values for the given data set using the model trained.

    testData

    RDD representing data points to be predicted

    returns

    RDD[Double] where each entry contains the corresponding prediction

    Definition Classes
    GeneralizedLinearModel
    Annotations
    @Since( "1.0.0" )
  24. def predictPoint(dataMatrix: Vector, weightMatrix: Vector, intercept: Double): Double

    Permalink

    Predict the result given a data point and the weights learned.

    Predict the result given a data point and the weights learned.

    dataMatrix

    Row vector containing the features for this data point

    weightMatrix

    Column vector containing the weights of the model

    intercept

    Intercept of the model.

    Attributes
    protected
    Definition Classes
    LogisticRegressionModelGeneralizedLinearModel
  25. def save(sc: SparkContext, path: String): Unit

    Permalink

    Save this model to the given path.

    Save this model to the given path.

    This saves:

    • human-readable (JSON) model metadata to path/metadata/
    • Parquet formatted data to path/data/

    The model may be loaded using Loader.load.

    sc

    Spark context used to save model data.

    path

    Path specifying the directory in which to save this model. If the directory already exists, this method throws an exception.

    Definition Classes
    LogisticRegressionModelSaveable
    Annotations
    @Since( "1.3.0" )
  26. def setThreshold(threshold: Double): LogisticRegressionModel.this.type

    Permalink

    Sets the threshold that separates positive predictions from negative predictions in Binary Logistic Regression.

    Sets the threshold that separates positive predictions from negative predictions in Binary Logistic Regression. An example with prediction score greater than or equal to this threshold is identified as a positive, and negative otherwise. The default value is 0.5. It is only used for binary classification.

    Annotations
    @Since( "1.0.0" )
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def toPMML(): String

    Permalink

    Export the model to a String in PMML format

    Export the model to a String in PMML format

    Definition Classes
    PMMLExportable
    Annotations
    @Since( "1.4.0" )
  29. def toPMML(outputStream: OutputStream): Unit

    Permalink

    Export the model to the OutputStream in PMML format

    Export the model to the OutputStream in PMML format

    Definition Classes
    PMMLExportable
    Annotations
    @Since( "1.4.0" )
  30. def toPMML(sc: SparkContext, path: String): Unit

    Permalink

    Export the model to a directory on a distributed file system in PMML format

    Export the model to a directory on a distributed file system in PMML format

    Definition Classes
    PMMLExportable
    Annotations
    @Since( "1.4.0" )
  31. def toPMML(localPath: String): Unit

    Permalink

    Export the model to a local file in PMML format

    Export the model to a local file in PMML format

    Definition Classes
    PMMLExportable
    Annotations
    @Since( "1.4.0" )
  32. def toString(): String

    Permalink

    Print a summary of the model.

    Print a summary of the model.

    Definition Classes
    LogisticRegressionModelGeneralizedLinearModel → AnyRef → Any
  33. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. val weights: Vector

    Permalink

    Weights computed for every feature.

    Weights computed for every feature.

    Definition Classes
    LogisticRegressionModelGeneralizedLinearModel
    Annotations
    @Since( "1.0.0" )

Inherited from PMMLExportable

Inherited from Saveable

Inherited from ClassificationModel

Inherited from GeneralizedLinearModel

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped