Class/Object

org.apache.spark.ml.regression

GeneralizedLinearRegression

Related Docs: object GeneralizedLinearRegression | package regression

Permalink

class GeneralizedLinearRegression extends Regressor[Vector, GeneralizedLinearRegression, GeneralizedLinearRegressionModel] with GeneralizedLinearRegressionBase with DefaultParamsWritable with Logging

:: Experimental ::

Fit a Generalized Linear Model (see Generalized linear model (Wikipedia)) specified by giving a symbolic description of the linear predictor (link function) and a description of the error distribution (family). It supports "gaussian", "binomial", "poisson" and "gamma" as family. Valid link functions for each family is listed below. The first link function of each family is the default one.

Annotations
@Experimental() @Since( "2.0.0" )
Source
GeneralizedLinearRegression.scala
Linear Supertypes
DefaultParamsWritable, MLWritable, GeneralizedLinearRegressionBase, HasSolver, HasWeightCol, HasRegParam, HasTol, HasMaxIter, HasFitIntercept, Regressor[Vector, GeneralizedLinearRegression, GeneralizedLinearRegressionModel], Predictor[Vector, GeneralizedLinearRegression, GeneralizedLinearRegressionModel], PredictorParams, HasPredictionCol, HasFeaturesCol, HasLabelCol, Estimator[GeneralizedLinearRegressionModel], PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. GeneralizedLinearRegression
  2. DefaultParamsWritable
  3. MLWritable
  4. GeneralizedLinearRegressionBase
  5. HasSolver
  6. HasWeightCol
  7. HasRegParam
  8. HasTol
  9. HasMaxIter
  10. HasFitIntercept
  11. Regressor
  12. Predictor
  13. PredictorParams
  14. HasPredictionCol
  15. HasFeaturesCol
  16. HasLabelCol
  17. Estimator
  18. PipelineStage
  19. Logging
  20. Params
  21. Serializable
  22. Serializable
  23. Identifiable
  24. AnyRef
  25. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GeneralizedLinearRegression()

    Permalink
    Annotations
    @Since( "2.0.0" )
  2. new GeneralizedLinearRegression(uid: String)

    Permalink
    Annotations
    @Since( "2.0.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 $[T](param: Param[T]): T

    Permalink

    An alias for getOrDefault().

    An alias for getOrDefault().

    Attributes
    protected
    Definition Classes
    Params
  4. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  6. final def clear(param: Param[_]): GeneralizedLinearRegression.this.type

    Permalink

    Clears the user-supplied value for the input param.

    Clears the user-supplied value for the input param.

    Definition Classes
    Params
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def copy(extra: ParamMap): GeneralizedLinearRegression

    Permalink

    Creates a copy of this instance with the same UID and some extra params.

    Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly. See defaultCopy().

    Definition Classes
    GeneralizedLinearRegressionPredictorEstimatorPipelineStageParams
    Annotations
    @Since( "2.0.0" )
  9. def copyValues[T <: Params](to: T, extra: ParamMap = ParamMap.empty): T

    Permalink

    Copies param values from this instance to another instance for params shared by them.

    Copies param values from this instance to another instance for params shared by them.

    This handles default Params and explicitly set Params separately. Default Params are copied from and to defaultParamMap, and explicitly set Params are copied from and to paramMap. Warning: This implicitly assumes that this Params instance and the target instance share the same set of default Params.

    to

    the target instance, which should work with the same set of default Params as this source instance

    extra

    extra params to be copied to the target's paramMap

    returns

    the target instance with param values copied

    Attributes
    protected
    Definition Classes
    Params
  10. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink

    Default implementation of copy with extra params.

    Default implementation of copy with extra params. It tries to create a new instance with the same UID. Then it copies the embedded and extra parameters over and returns the new instance.

    Attributes
    protected
    Definition Classes
    Params
  11. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. def explainParam(param: Param[_]): String

    Permalink

    Explains a param.

    Explains a param.

    param

    input param, must belong to this instance.

    returns

    a string that contains the input param name, doc, and optionally its default value and the user-supplied value

    Definition Classes
    Params
  14. def explainParams(): String

    Permalink

    Explains all params of this instance.

    Explains all params of this instance. See explainParam().

    Definition Classes
    Params
  15. def extractLabeledPoints(dataset: Dataset[_]): RDD[LabeledPoint]

    Permalink

    Extract labelCol and featuresCol from the given dataset, and put it in an RDD with strong types.

    Extract labelCol and featuresCol from the given dataset, and put it in an RDD with strong types.

    Attributes
    protected
    Definition Classes
    Predictor
  16. final def extractParamMap(): ParamMap

    Permalink

    extractParamMap with no extra values.

    extractParamMap with no extra values.

    Definition Classes
    Params
  17. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink

    Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

    Extracts the embedded default param values and user-supplied values, and then merges them with extra values from input into a flat param map, where the latter value is used if there exist conflicts, i.e., with ordering: default param values less than user-supplied values less than extra.

    Definition Classes
    Params
  18. final val family: Param[String]

    Permalink

    Param for the name of family which is a description of the error distribution to be used in the model.

    Param for the name of family which is a description of the error distribution to be used in the model. Supported options: "gaussian", "binomial", "poisson" and "gamma". Default is "gaussian".

    Definition Classes
    GeneralizedLinearRegressionBase
    Annotations
    @Since( "2.0.0" )
  19. final val featuresCol: Param[String]

    Permalink

    Param for features column name.

    Param for features column name.

    Definition Classes
    HasFeaturesCol
  20. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def fit(dataset: Dataset[_]): GeneralizedLinearRegressionModel

    Permalink

    Fits a model to the input data.

    Fits a model to the input data.

    Definition Classes
    PredictorEstimator
  22. def fit(dataset: Dataset[_], paramMaps: Array[ParamMap]): Seq[GeneralizedLinearRegressionModel]

    Permalink

    Fits multiple models to the input data with multiple sets of parameters.

    Fits multiple models to the input data with multiple sets of parameters. The default implementation uses a for loop on each parameter map. Subclasses could override this to optimize multi-model training.

    dataset

    input dataset

    paramMaps

    An array of parameter maps. These values override any specified in this Estimator's embedded ParamMap.

    returns

    fitted models, matching the input parameter maps

    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  23. def fit(dataset: Dataset[_], paramMap: ParamMap): GeneralizedLinearRegressionModel

    Permalink

    Fits a single model to the input data with provided parameter map.

    Fits a single model to the input data with provided parameter map.

    dataset

    input dataset

    paramMap

    Parameter map. These values override any specified in this Estimator's embedded ParamMap.

    returns

    fitted model

    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" )
  24. def fit(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): GeneralizedLinearRegressionModel

    Permalink

    Fits a single model to the input data with optional parameters.

    Fits a single model to the input data with optional parameters.

    dataset

    input dataset

    firstParamPair

    the first param pair, overrides embedded params

    otherParamPairs

    other param pairs. These values override any specified in this Estimator's embedded ParamMap.

    returns

    fitted model

    Definition Classes
    Estimator
    Annotations
    @Since( "2.0.0" ) @varargs()
  25. final val fitIntercept: BooleanParam

    Permalink

    Param for whether to fit an intercept term.

    Param for whether to fit an intercept term.

    Definition Classes
    HasFitIntercept
  26. final def get[T](param: Param[T]): Option[T]

    Permalink

    Optionally returns the user-supplied value of a param.

    Optionally returns the user-supplied value of a param.

    Definition Classes
    Params
  27. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  28. final def getDefault[T](param: Param[T]): Option[T]

    Permalink

    Gets the default value of a parameter.

    Gets the default value of a parameter.

    Definition Classes
    Params
  29. def getFamily: String

    Permalink

    Definition Classes
    GeneralizedLinearRegressionBase
    Annotations
    @Since( "2.0.0" )
  30. final def getFeaturesCol: String

    Permalink

    Definition Classes
    HasFeaturesCol
  31. final def getFitIntercept: Boolean

    Permalink

    Definition Classes
    HasFitIntercept
  32. final def getLabelCol: String

    Permalink

    Definition Classes
    HasLabelCol
  33. def getLink: String

    Permalink

    Definition Classes
    GeneralizedLinearRegressionBase
    Annotations
    @Since( "2.0.0" )
  34. def getLinkPredictionCol: String

    Permalink

    Definition Classes
    GeneralizedLinearRegressionBase
    Annotations
    @Since( "2.0.0" )
  35. final def getMaxIter: Int

    Permalink

    Definition Classes
    HasMaxIter
  36. final def getOrDefault[T](param: Param[T]): T

    Permalink

    Gets the value of a param in the embedded param map or its default value.

    Gets the value of a param in the embedded param map or its default value. Throws an exception if neither is set.

    Definition Classes
    Params
  37. def getParam(paramName: String): Param[Any]

    Permalink

    Gets a param by its name.

    Gets a param by its name.

    Definition Classes
    Params
  38. final def getPredictionCol: String

    Permalink

    Definition Classes
    HasPredictionCol
  39. final def getRegParam: Double

    Permalink

    Definition Classes
    HasRegParam
  40. final def getSolver: String

    Permalink

    Definition Classes
    HasSolver
  41. final def getTol: Double

    Permalink

    Definition Classes
    HasTol
  42. final def getWeightCol: String

    Permalink

    Definition Classes
    HasWeightCol
  43. final def hasDefault[T](param: Param[T]): Boolean

    Permalink

    Tests whether the input param has a default value set.

    Tests whether the input param has a default value set.

    Definition Classes
    Params
  44. def hasParam(paramName: String): Boolean

    Permalink

    Tests whether this instance contains a param with a given name.

    Tests whether this instance contains a param with a given name.

    Definition Classes
    Params
  45. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  46. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  47. final def isDefined(param: Param[_]): Boolean

    Permalink

    Checks whether a param is explicitly set or has a default value.

    Checks whether a param is explicitly set or has a default value.

    Definition Classes
    Params
  48. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  49. final def isSet(param: Param[_]): Boolean

    Permalink

    Checks whether a param is explicitly set.

    Checks whether a param is explicitly set.

    Definition Classes
    Params
  50. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  51. final val labelCol: Param[String]

    Permalink

    Param for label column name.

    Param for label column name.

    Definition Classes
    HasLabelCol
  52. final val link: Param[String]

    Permalink

    Param for the name of link function which provides the relationship between the linear predictor and the mean of the distribution function.

    Param for the name of link function which provides the relationship between the linear predictor and the mean of the distribution function. Supported options: "identity", "log", "inverse", "logit", "probit", "cloglog" and "sqrt".

    Definition Classes
    GeneralizedLinearRegressionBase
    Annotations
    @Since( "2.0.0" )
  53. final val linkPredictionCol: Param[String]

    Permalink

    Param for link prediction (linear predictor) column name.

    Param for link prediction (linear predictor) column name. Default is not set, which means we do not output link prediction.

    Definition Classes
    GeneralizedLinearRegressionBase
    Annotations
    @Since( "2.0.0" )
  54. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  55. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  56. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  57. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  58. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  59. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  60. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  61. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  62. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  63. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  64. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  65. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  66. final val maxIter: IntParam

    Permalink

    Param for maximum number of iterations (>= 0).

    Param for maximum number of iterations (>= 0).

    Definition Classes
    HasMaxIter
  67. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  70. lazy val params: Array[Param[_]]

    Permalink

    Returns all params sorted by their names.

    Returns all params sorted by their names. The default implementation uses Java reflection to list all public methods that have no arguments and return Param.

    Definition Classes
    Params
    Note

    Developer should not use this method in constructor because we cannot guarantee that this variable gets initialized before other params.

  71. final val predictionCol: Param[String]

    Permalink

    Param for prediction column name.

    Param for prediction column name.

    Definition Classes
    HasPredictionCol
  72. final val regParam: DoubleParam

    Permalink

    Param for regularization parameter (>= 0).

    Param for regularization parameter (>= 0).

    Definition Classes
    HasRegParam
  73. def save(path: String): Unit

    Permalink

    Saves this ML instance to the input path, a shortcut of write.save(path).

    Saves this ML instance to the input path, a shortcut of write.save(path).

    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  74. final def set(paramPair: ParamPair[_]): GeneralizedLinearRegression.this.type

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  75. final def set(param: String, value: Any): GeneralizedLinearRegression.this.type

    Permalink

    Sets a parameter (by name) in the embedded param map.

    Sets a parameter (by name) in the embedded param map.

    Attributes
    protected
    Definition Classes
    Params
  76. final def set[T](param: Param[T], value: T): GeneralizedLinearRegression.this.type

    Permalink

    Sets a parameter in the embedded param map.

    Sets a parameter in the embedded param map.

    Definition Classes
    Params
  77. final def setDefault(paramPairs: ParamPair[_]*): GeneralizedLinearRegression.this.type

    Permalink

    Sets default values for a list of params.

    Sets default values for a list of params.

    Note: Java developers should use the single-parameter setDefault. Annotating this with varargs can cause compilation failures due to a Scala compiler bug. See SPARK-9268.

    paramPairs

    a list of param pairs that specify params and their default values to set respectively. Make sure that the params are initialized before this method gets called.

    Attributes
    protected
    Definition Classes
    Params
  78. final def setDefault[T](param: Param[T], value: T): GeneralizedLinearRegression.this.type

    Permalink

    Sets a default value for a param.

    Sets a default value for a param.

    param

    param to set the default value. Make sure that this param is initialized before this method gets called.

    value

    the default value

    Attributes
    protected
    Definition Classes
    Params
  79. def setFamily(value: String): GeneralizedLinearRegression.this.type

    Permalink

    Sets the value of param family.

    Sets the value of param family. Default is "gaussian".

    Annotations
    @Since( "2.0.0" )
  80. def setFeaturesCol(value: String): GeneralizedLinearRegression

    Permalink

    Definition Classes
    Predictor
  81. def setFitIntercept(value: Boolean): GeneralizedLinearRegression.this.type

    Permalink

    Sets if we should fit the intercept.

    Sets if we should fit the intercept. Default is true.

    Annotations
    @Since( "2.0.0" )
  82. def setLabelCol(value: String): GeneralizedLinearRegression

    Permalink

    Definition Classes
    Predictor
  83. def setLink(value: String): GeneralizedLinearRegression.this.type

    Permalink

    Sets the value of param link.

    Sets the value of param link.

    Annotations
    @Since( "2.0.0" )
  84. def setLinkPredictionCol(value: String): GeneralizedLinearRegression.this.type

    Permalink

    Sets the link prediction (linear predictor) column name.

    Sets the link prediction (linear predictor) column name.

    Annotations
    @Since( "2.0.0" )
  85. def setMaxIter(value: Int): GeneralizedLinearRegression.this.type

    Permalink

    Sets the maximum number of iterations (applicable for solver "irls").

    Sets the maximum number of iterations (applicable for solver "irls"). Default is 25.

    Annotations
    @Since( "2.0.0" )
  86. def setPredictionCol(value: String): GeneralizedLinearRegression

    Permalink

    Definition Classes
    Predictor
  87. def setRegParam(value: Double): GeneralizedLinearRegression.this.type

    Permalink

    Sets the regularization parameter for L2 regularization.

    Sets the regularization parameter for L2 regularization. The regularization term is

    $$ 0.5 * regParam * L2norm(coefficients)^2 $$
    Default is 0.0.

    Annotations
    @Since( "2.0.0" )
  88. def setSolver(value: String): GeneralizedLinearRegression.this.type

    Permalink

    Sets the solver algorithm used for optimization.

    Sets the solver algorithm used for optimization. Currently only supports "irls" which is also the default solver.

    Annotations
    @Since( "2.0.0" )
  89. def setTol(value: Double): GeneralizedLinearRegression.this.type

    Permalink

    Sets the convergence tolerance of iterations.

    Sets the convergence tolerance of iterations. Smaller value will lead to higher accuracy with the cost of more iterations. Default is 1E-6.

    Annotations
    @Since( "2.0.0" )
  90. def setWeightCol(value: String): GeneralizedLinearRegression.this.type

    Permalink

    Sets the value of param weightCol.

    Sets the value of param weightCol. If this is not set or empty, we treat all instance weights as 1.0. Default is not set, so all instances have weight one.

    Annotations
    @Since( "2.0.0" )
  91. final val solver: Param[String]

    Permalink

    Param for the solver algorithm for optimization.

    Param for the solver algorithm for optimization. If this is not set or empty, default value is 'auto'.

    Definition Classes
    HasSolver
  92. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  93. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  94. final val tol: DoubleParam

    Permalink

    Param for the convergence tolerance for iterative algorithms (>= 0).

    Param for the convergence tolerance for iterative algorithms (>= 0).

    Definition Classes
    HasTol
  95. def train(dataset: Dataset[_]): GeneralizedLinearRegressionModel

    Permalink

    Train a model using the given dataset and parameters.

    Train a model using the given dataset and parameters. Developers can implement this instead of fit() to avoid dealing with schema validation and copying parameters into the model.

    dataset

    Training dataset

    returns

    Fitted model

    Attributes
    protected
    Definition Classes
    GeneralizedLinearRegressionPredictor
  96. def transformSchema(schema: StructType): StructType

    Permalink

    :: DeveloperApi ::

    :: DeveloperApi ::

    Check transform validity and derive the output schema from the input schema.

    We check validity for interactions between parameters during transformSchema and raise an exception if any parameter value is invalid. Parameter value checks which do not depend on other parameters are handled by Param.validate().

    Typical implementation should first conduct verification on schema change and parameter validity, including complex parameter interaction checks.

    Definition Classes
    PredictorPipelineStage
  97. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink

    :: DeveloperApi ::

    :: DeveloperApi ::

    Derives the output schema from the input schema and parameters, optionally with logging.

    This should be optimistic. If it is unclear whether the schema will be valid, then it should be assumed valid until proven otherwise.

    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  98. val uid: String

    Permalink

    An immutable unique ID for the object and its derivatives.

    An immutable unique ID for the object and its derivatives.

    Definition Classes
    GeneralizedLinearRegressionIdentifiable
    Annotations
    @Since( "2.0.0" )
  99. def validateAndTransformSchema(schema: StructType, fitting: Boolean, featuresDataType: DataType): StructType

    Permalink

    Validates and transforms the input schema with the provided param map.

    Validates and transforms the input schema with the provided param map.

    schema

    input schema

    fitting

    whether this is in fitting

    featuresDataType

    SQL DataType for FeaturesType. E.g., org.apache.spark.mllib.linalg.VectorUDT for vector features.

    returns

    output schema

    Definition Classes
    GeneralizedLinearRegressionBase → PredictorParams
    Annotations
    @Since( "2.0.0" )
  100. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  103. final val weightCol: Param[String]

    Permalink

    Param for weight column name.

    Param for weight column name. If this is not set or empty, we treat all instance weights as 1.0.

    Definition Classes
    HasWeightCol
  104. def write: MLWriter

    Permalink

    Returns an MLWriter instance for this ML instance.

    Returns an MLWriter instance for this ML instance.

    Definition Classes
    DefaultParamsWritableMLWritable

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from GeneralizedLinearRegressionBase

Inherited from HasSolver

Inherited from HasWeightCol

Inherited from HasRegParam

Inherited from HasTol

Inherited from HasMaxIter

Inherited from HasFitIntercept

Inherited from PredictorParams

Inherited from HasPredictionCol

Inherited from HasFeaturesCol

Inherited from HasLabelCol

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Parameters

A list of (hyper-)parameter keys this algorithm can take. Users can set and get the parameter values through setters and getters, respectively.

Members

Parameter setters

Parameter getters