Packages

c

org.apache.spark.mllib.classification

LogisticRegressionWithLBFGS

class LogisticRegressionWithLBFGS extends GeneralizedLinearAlgorithm[LogisticRegressionModel] with Serializable

Train a classification model for Multinomial/Binary Logistic Regression using Limited-memory BFGS. Standard feature scaling and L2 regularization are used by default.

Earlier implementations of LogisticRegressionWithLBFGS applies a regularization penalty to all elements including the intercept. If this is called with one of standard updaters (L1Updater, or SquaredL2Updater) this is translated into a call to ml.LogisticRegression, otherwise this will use the existing mllib GeneralizedLinearAlgorithm trainer, resulting in a regularization penalty to the intercept.

Annotations
@Since( "1.1.0" )
Source
LogisticRegression.scala
Note

Labels used in Logistic Regression should be {0, 1, ..., k - 1} for k classes multi-label classification problem.

Linear Supertypes
GeneralizedLinearAlgorithm[LogisticRegressionModel], Serializable, Serializable, Logging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LogisticRegressionWithLBFGS
  2. GeneralizedLinearAlgorithm
  3. Serializable
  4. Serializable
  5. Logging
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LogisticRegressionWithLBFGS()

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. var addIntercept: Boolean

    Whether to add intercept (default: false).

    Whether to add intercept (default: false).

    Attributes
    protected
    Definition Classes
    GeneralizedLinearAlgorithm
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. def createModel(weights: Vector, intercept: Double): LogisticRegressionModel

    Create a model given the weights and intercept

    Create a model given the weights and intercept

    Attributes
    protected
    Definition Classes
    LogisticRegressionWithLBFGS → GeneralizedLinearAlgorithm
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def generateInitialWeights(input: RDD[LabeledPoint]): Vector

    Generate the initial weights when the user does not supply them

    Generate the initial weights when the user does not supply them

    Attributes
    protected
    Definition Classes
    GeneralizedLinearAlgorithm
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def getNumFeatures: Int

    The dimension of training features.

    The dimension of training features.

    Definition Classes
    GeneralizedLinearAlgorithm
    Annotations
    @Since( "1.4.0" )
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  16. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  17. def isAddIntercept: Boolean

    Get if the algorithm uses addIntercept

    Get if the algorithm uses addIntercept

    Definition Classes
    GeneralizedLinearAlgorithm
    Annotations
    @Since( "1.4.0" )
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  20. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  21. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  22. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  23. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  24. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  25. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  26. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  27. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  28. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  29. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  30. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  31. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. var numFeatures: Int

    The dimension of training features.

    The dimension of training features.

    Attributes
    protected
    Definition Classes
    GeneralizedLinearAlgorithm
  36. var numOfLinearPredictor: Int

    In GeneralizedLinearModel, only single linear predictor is allowed for both weights and intercept.

    In GeneralizedLinearModel, only single linear predictor is allowed for both weights and intercept. However, for multinomial logistic regression, with K possible outcomes, we are training K-1 independent binary logistic regression models which requires K-1 sets of linear predictor.

    As a result, the workaround here is if more than two sets of linear predictors are needed, we construct bigger weights vector which can hold both weights and intercepts. If the intercepts are added, the dimension of weights will be (numOfLinearPredictor) * (numFeatures + 1) . If the intercepts are not added, the dimension of weights will be (numOfLinearPredictor) * numFeatures.

    Thus, the intercepts will be encapsulated into weights, and we leave the value of intercept in GeneralizedLinearModel as zero.

    Attributes
    protected
    Definition Classes
    GeneralizedLinearAlgorithm
  37. val optimizer: LBFGS

    The optimizer to solve the problem.

    The optimizer to solve the problem.

    Definition Classes
    LogisticRegressionWithLBFGS → GeneralizedLinearAlgorithm
    Annotations
    @Since( "1.1.0" )
  38. def run(input: RDD[LabeledPoint], initialWeights: Vector): LogisticRegressionModel

    Run Logistic Regression with the configured parameters on an input RDD of LabeledPoint entries starting from the initial weights provided.

    Run Logistic Regression with the configured parameters on an input RDD of LabeledPoint entries starting from the initial weights provided.

    If a known updater is used calls the ml implementation, to avoid applying a regularization penalty to the intercept, otherwise defaults to the mllib implementation. If more than two classes or feature scaling is disabled, always uses mllib implementation. Uses user provided weights.

    In the ml LogisticRegression implementation, the number of corrections used in the LBFGS update can not be configured. So optimizer.setNumCorrections() will have no effect if we fall into that route.

    Definition Classes
    LogisticRegressionWithLBFGS → GeneralizedLinearAlgorithm
  39. def run(input: RDD[LabeledPoint]): LogisticRegressionModel

    Run Logistic Regression with the configured parameters on an input RDD of LabeledPoint entries.

    Run Logistic Regression with the configured parameters on an input RDD of LabeledPoint entries.

    If a known updater is used calls the ml implementation, to avoid applying a regularization penalty to the intercept, otherwise defaults to the mllib implementation. If more than two classes or feature scaling is disabled, always uses mllib implementation. If using ml implementation, uses ml code to generate initial weights.

    Definition Classes
    LogisticRegressionWithLBFGS → GeneralizedLinearAlgorithm
  40. def setIntercept(addIntercept: Boolean): LogisticRegressionWithLBFGS.this.type

    Set if the algorithm should add an intercept.

    Set if the algorithm should add an intercept. Default false. We set the default to false because adding the intercept will cause memory allocation.

    Definition Classes
    GeneralizedLinearAlgorithm
    Annotations
    @Since( "0.8.0" )
  41. def setNumClasses(numClasses: Int): LogisticRegressionWithLBFGS.this.type

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

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

    Annotations
    @Since( "1.3.0" )
  42. def setValidateData(validateData: Boolean): LogisticRegressionWithLBFGS.this.type

    Set if the algorithm should validate data before training.

    Set if the algorithm should validate data before training. Default true.

    Definition Classes
    GeneralizedLinearAlgorithm
    Annotations
    @Since( "0.8.0" )
  43. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  44. def toString(): String
    Definition Classes
    AnyRef → Any
  45. var validateData: Boolean
    Attributes
    protected
    Definition Classes
    GeneralizedLinearAlgorithm
  46. val validators: List[(RDD[LabeledPoint]) ⇒ Boolean]
    Attributes
    protected
    Definition Classes
    LogisticRegressionWithLBFGS → GeneralizedLinearAlgorithm
  47. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from GeneralizedLinearAlgorithm[LogisticRegressionModel]

Inherited from Serializable

Inherited from Serializable

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped