added scaladoc about default value for GeneralizedLinearRegression.linkPower

jkbradley · jkbradley · commit 80981fd62e56 · 2017-02-25T17:26:59.000-08:00
diff --git a/mllib/src/main/scala/org/apache/spark/ml/regression/GeneralizedLinearRegression.scala b/mllib/src/main/scala/org/apache/spark/ml/regression/GeneralizedLinearRegression.scala
@@ -109,6 +109,8 @@ private[regression] trait GeneralizedLinearRegressionBase extends PredictorParam
    * Param for the index in the power link function. Only applicable for the Tweedie family.
    * Note that link power 0, 1, -1 or 0.5 corresponds to the Log, Identity, Inverse or Sqrt
    * link, respectively.
+   * When not set, this value defaults to 1 - [[variancePower]], which matches the R "statmod"
+   * package.
    *
    * @group param
    */

Original file line number	Diff line number	Diff line change
`@@ -109,6 +109,8 @@ private[regression] trait GeneralizedLinearRegressionBase extends PredictorParam`
`109`	`109`	`* Param for the index in the power link function. Only applicable for the Tweedie family.`
`110`	`110`	`* Note that link power 0, 1, -1 or 0.5 corresponds to the Log, Identity, Inverse or Sqrt`
`111`	`111`	`* link, respectively.`
	`112`	`+ * When not set, this value defaults to 1 - [[variancePower]], which matches the R "statmod"`
	`113`	`+ * package.`
`112`	`114`	`*`
`113`	`115`	`* @group param`
`114`	`116`	`*/`