Skip to content

Commit

Permalink
revert some unintentional comment change
Browse files Browse the repository at this point in the history
  • Loading branch information
hhbyyh committed Mar 16, 2016
1 parent 91f72a9 commit f348044
Showing 1 changed file with 13 additions and 27 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ private[regression] trait GeneralizedLinearRegressionBase extends PredictorParam
* to be used in the model.
* Supported options: "gaussian", "binomial", "poisson" and "gamma".
* Default is "gaussian".
*
* @group param
*/
@Since("2.0.0")
Expand All @@ -63,8 +62,7 @@ private[regression] trait GeneralizedLinearRegressionBase extends PredictorParam
* 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".
*
* @group param
* @group param
*/
@Since("2.0.0")
final val link: Param[String] = new Param(this, "link", "The name of link function " +
Expand Down Expand Up @@ -124,35 +122,31 @@ class GeneralizedLinearRegression @Since("2.0.0") (@Since("2.0.0") override val
/**
* Sets the value of param [[family]].
* Default is "gaussian".
*
* @group setParam
* @group setParam
*/
@Since("2.0.0")
def setFamily(value: String): this.type = set(family, value)
setDefault(family -> Gaussian.name)

/**
* Sets the value of param [[link]].
*
* @group setParam
* @group setParam
*/
@Since("2.0.0")
def setLink(value: String): this.type = set(link, value)

/**
* Sets if we should fit the intercept.
* Default is true.
*
* @group setParam
* @group setParam
*/
@Since("2.0.0")
def setFitIntercept(value: Boolean): this.type = set(fitIntercept, value)

/**
* Sets the maximum number of iterations.
* Default is 25 if the solver algorithm is "irls".
*
* @group setParam
* @group setParam
*/
@Since("2.0.0")
def setMaxIter(value: Int): this.type = set(maxIter, value)
Expand All @@ -161,8 +155,7 @@ class GeneralizedLinearRegression @Since("2.0.0") (@Since("2.0.0") override val
* Sets the convergence tolerance of iterations.
* Smaller value will lead to higher accuracy with the cost of more iterations.
* Default is 1E-6.
*
* @group setParam
* @group setParam
*/
@Since("2.0.0")
def setTol(value: Double): this.type = set(tol, value)
Expand All @@ -171,8 +164,7 @@ class GeneralizedLinearRegression @Since("2.0.0") (@Since("2.0.0") override val
/**
* Sets the regularization parameter.
* Default is 0.0.
*
* @group setParam
* @group setParam
*/
@Since("2.0.0")
def setRegParam(value: Double): this.type = set(regParam, value)
Expand All @@ -182,8 +174,7 @@ class GeneralizedLinearRegression @Since("2.0.0") (@Since("2.0.0") override val
* Sets the value of param [[weightCol]].
* If this is not set or empty, we treat all instance weights as 1.0.
* Default is empty, so all instances have weight one.
*
* @group setParam
* @group setParam
*/
@Since("2.0.0")
def setWeightCol(value: String): this.type = set(weightCol, value)
Expand All @@ -192,8 +183,7 @@ class GeneralizedLinearRegression @Since("2.0.0") (@Since("2.0.0") override val
/**
* Sets the solver algorithm used for optimization.
* Currently only support "irls" which is also the default solver.
*
* @group setParam
* @group setParam
*/
@Since("2.0.0")
def setSolver(value: String): this.type = set(solver, value)
Expand Down Expand Up @@ -337,8 +327,7 @@ object GeneralizedLinearRegression extends DefaultParamsReadable[GeneralizedLine

/**
* A description of the error distribution to be used in the model.
*
* @param name the name of the family.
* @param name the name of the family.
*/
private[ml] abstract class Family(val name: String) extends Serializable {

Expand Down Expand Up @@ -375,8 +364,7 @@ object GeneralizedLinearRegression extends DefaultParamsReadable[GeneralizedLine

/**
* Gets the [[Family]] object from its name.
*
* @param name family name: "gaussian", "binomial", "poisson" or "gamma".
* @param name family name: "gaussian", "binomial", "poisson" or "gamma".
*/
def fromName(name: String): Family = {
name match {
Expand Down Expand Up @@ -555,8 +543,7 @@ object GeneralizedLinearRegression extends DefaultParamsReadable[GeneralizedLine
* A description of the link function to be used in the model.
* The link function provides the relationship between the linear predictor
* and the mean of the distribution function.
*
* @param name the name of link function.
* @param name the name of link function.
*/
private[ml] abstract class Link(val name: String) extends Serializable {

Expand All @@ -574,8 +561,7 @@ object GeneralizedLinearRegression extends DefaultParamsReadable[GeneralizedLine

/**
* Gets the [[Link]] object from its name.
*
* @param name link name: "identity", "logit", "log",
* @param name link name: "identity", "logit", "log",
* "inverse", "probit", "cloglog" or "sqrt".
*/
def fromName(name: String): Link = {
Expand Down

0 comments on commit f348044

Please sign in to comment.