[SPARK-10265][Documentation, ML] Fixed @Since annotation to ml.regression

[ehsanmok]

Here is my first commit.

[yu-iskw]

@ehsanmok according to the warning message, we have any conflicts with the master. You need to update your PR. So I'd like to explain how to resolve that. And I'd like to review this PR after the first test pass.

When I have conflicts with the master after sending a PR, I always do the following operations.

# now, you are on your branch. In this case, it's `SinceAnn`.
# where, `upstream` is the `apache/spark` repository.
# if you set the different name on your local computer, replace `upstream` with the name..
git fetch upstream
git rebase upstream/master

# resolve the conflicts

# make sure to check coding style warnings before pushing it to github.
./dev/lint-scala

# push it to github
# where, `origin` is your github repository. In this case, It's `ehsanmok/spark`.
git push -f origin SinceAnn

If you have any questions, please don't hesitate to ask.

[ehsanmok]

@yu-iskw Thank you very much for the detailed explanations! I just want to make sure that when I resolve the conflicts (also "Scalastyle checks passed") and do git rebase --continue, it shows unmerged files, so should I git add <files> and then git merge SinceAnn --no-ff or with --no-commit, before forced push?

[yu-iskw]

@ehsanmok it depends on the situation. Since I don't know what kind of files appeared as unmerged files, it's hard to decide if you need to add them or not.

[ehsanmok]

@yu-iskw should be fine now. Please test it.

[yu-iskw]

ok to test

[yu-iskw]

@mengxr can you run the test when you have time.
BTW, does everyone have the privilege to run tests in this case?

[mengxr]

ok to test

[mengxr]

add to whitelist

[SparkQA]

Test build #44842 has finished for PR 8728 at commit 4f7c36f.

• This patch fails Scala style tests.
• This patch merges cleanly.
• This patch adds the following public classes (experimental):\n * final class DecisionTreeRegressor @Since(\"1.4.0\") (@Since(\"1.4.0\") override val uid: String)\n * final class GBTRegressor @Since(\"1.4.0\") (@Since(\"1.4.0\") override val uid: String)\n * class IsotonicRegression @Since(\"1.5.0\") (@Since(\"1.5.0\") override val uid: String)\n * class LinearRegression @Since(\"1.3.0\") (@Since(\"1.3.0\") override val uid: String)\n * final class RandomForestRegressor @Since(\"1.4.0\") (@Since(\"1.4.0\") override val uid: String)\n

[SparkQA]

Test build #44989 has finished for PR 8728 at commit 175d75e.

• This patch passes all tests.
• This patch merges cleanly.
• This patch adds the following public classes (experimental):\n * final class DecisionTreeRegressor @Since(\"1.4.0\") (@Since(\"1.4.0\") override val uid: String)\n * final class GBTRegressor @Since(\"1.4.0\") (@Since(\"1.4.0\") override val uid: String)\n * class IsotonicRegression @Since(\"1.5.0\") (@Since(\"1.5.0\") override val uid: String)\n * class LinearRegression @Since(\"1.3.0\") (@Since(\"1.3.0\") override val uid: String)\n * final class RandomForestRegressor @Since(\"1.4.0\") (@Since(\"1.4.0\") override val uid: String)\n

[yu-iskw]

insert a blank line above the @SInCE tag. Please do likewise at other tags.

[yu-iskw]

It should be since 1.4.0.

[yu-iskw]

@ehsanmok thanks for the update. We should add @Since to public classes and public methods

• DecisionTreeRegressionModel
• GBTRegressionModel
• IsotonicRegressionModel
• LinearRegression.setWeightCol and LinearRegression.setSolver
• LinearRegressionModel
• LinearRegressionTrainingSummary
• RandomForestRegressionModel

[SparkQA]

Test build #45042 has finished for PR 8728 at commit beaa3aa.

• This patch passes all tests.
• This patch merges cleanly.
• This patch adds the following public classes (experimental):\n * final class DecisionTreeRegressor @Since(\"1.4.0\") (@Since(\"1.4.0\") override val uid: String)\n * final class GBTRegressor @Since(\"1.4.0\") (@Since(\"1.4.0\") override val uid: String)\n * class IsotonicRegression @Since(\"1.5.0\") (@Since(\"1.5.0\") override val uid: String)\n * class LinearRegression @Since(\"1.3.0\") (@Since(\"1.3.0\") override val uid: String)\n * final class RandomForestRegressor @Since(\"1.4.0\") (@Since(\"1.4.0\") override val uid: String)\n

[ehsanmok]

@yu-iskw Thanks for the correction. I think, DecisionTreeRegressionModel is a private[ml] class, right? so is GBTRegressionModel, IsotonicRegressionModel, LinearRegressionModel and RandomForestRegressionModel. And LinearRegressionTrainingSummary is a public method in a private class, so needs a tag?

I assume LinearRegression.setWeightCol and LinearRegression.setSolver should be tagged as 1.6.0, right?

[yu-iskw]

@ehsanmok

• DecisionTreeRegressionModel is a public class. The constructor paramter is private[ml].
• GBTRegressionModel and so on are also public classes.
• setWeightCol and setSolver should be since 1.6.0.

[yu-iskw]

@ehsanmok thanks for the update!

• Add @Since to totalIterations. It seems to be a public variable.
  https://github.com/ehsanmok/spark/blob/fa6150269fa52b8ac019373158f5438c933f0e7e/mllib/src/main/scala/org/apache/spark/ml/regression/LinearRegression.scala#L433
• And @Since to LinearRegressionSummary's public variables, such as explainedVariance
• Add @Since to RandomForestRegressor's pubic variables, such as supportedImpurities

[ehsanmok]

@yu-iskw Thank you very much for your patients and mentoring me. I wouldn't have imagined how much I would learn by doing this starter task.

[SparkQA]

Test build #45047 has finished for PR 8728 at commit fa61502.

• This patch passes all tests.
• This patch merges cleanly.
• This patch adds the following public classes (experimental):\n * final class DecisionTreeRegressor @Since(\"1.4.0\") (@Since(\"1.4.0\") override val uid: String)\n * final class GBTRegressor @Since(\"1.4.0\") (@Since(\"1.4.0\") override val uid: String)\n * class IsotonicRegression @Since(\"1.5.0\") (@Since(\"1.5.0\") override val uid: String)\n * class LinearRegression @Since(\"1.3.0\") (@Since(\"1.3.0\") override val uid: String)\n * final class RandomForestRegressor @Since(\"1.4.0\") (@Since(\"1.4.0\") override val uid: String)\n

[yu-iskw]

@ehsanmok no problem. I appreciate your first contribution!

@mengxr LGTM

[yu-iskw]

Jenkins, retest this please

[yu-iskw]

Jenkins, test this please.

[yu-iskw]

@mengxr there is something wrong with Jenkins. It failed to fetch source code from github 3 times in a row. Could you help us?

cc @JoshRosen

[mengxr]

test this please

[SparkQA]

Test build #45128 has finished for PR 8728 at commit 55e1317.

• This patch passes all tests.
• This patch merges cleanly.
• This patch adds the following public classes (experimental):\n * final class DecisionTreeRegressor @Since(\"1.4.0\") (@Since(\"1.4.0\") override val uid: String)\n * final class GBTRegressor @Since(\"1.4.0\") (@Since(\"1.4.0\") override val uid: String)\n * class IsotonicRegression @Since(\"1.5.0\") (@Since(\"1.5.0\") override val uid: String)\n * class LinearRegression @Since(\"1.3.0\") (@Since(\"1.3.0\") override val uid: String)\n * final class RandomForestRegressor @Since(\"1.4.0\") (@Since(\"1.4.0\") override val uid: String)\n

[mengxr]

Merged into master. Thanks!