Packages

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
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)

    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)

    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
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clearThreshold(): LogisticRegressionModel.this.type

    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
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. def getThreshold: Option[Double]

    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" )
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. val intercept: Double
    Definition Classes
    LogisticRegressionModelGeneralizedLinearModel
    Annotations
    @Since( "1.0.0" )
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. val numClasses: Int
    Annotations
    @Since( "1.3.0" )
  18. val numFeatures: Int
    Annotations
    @Since( "1.3.0" )
  19. def predict(testData: JavaRDD[Vector]): JavaRDD[Double]

    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" )
  20. def predict(testData: Vector): Double

    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" )
  21. def predict(testData: RDD[Vector]): RDD[Double]

    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" )
  22. def predictPoint(dataMatrix: Vector, weightMatrix: Vector, intercept: Double): Double

    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
  23. def save(sc: SparkContext, path: String): Unit

    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" )
  24. def setThreshold(threshold: Double): LogisticRegressionModel.this.type

    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" )
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toPMML(): String

    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" )
  27. def toPMML(outputStream: OutputStream): Unit

    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" )
  28. def toPMML(sc: SparkContext, path: String): Unit

    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" )
  29. def toPMML(localPath: String): Unit

    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" )
  30. def toString(): String

    Print a summary of the model.

    Print a summary of the model.

    Definition Classes
    LogisticRegressionModelGeneralizedLinearModel → AnyRef → Any
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. val weights: Vector
    Definition Classes
    LogisticRegressionModelGeneralizedLinearModel
    Annotations
    @Since( "1.0.0" )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

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