[SPARK-16144][SPARKR] update R API doc for mllib #13993
Conversation
|
Test build #61533 has finished for PR 13993 at commit
|
| #' @name predict | ||
| #' @export | ||
| #' @seealso \link{spark.glm}, \link{spark.kmeans}, \link{spark.naiveBayes}, \link{spark.survreg} | ||
| #' @seealso \link{read.ml} |
There was a problem hiding this comment.
It's not necessary to link read.ml to predict, I think here is typo.
|
Test build #61557 has finished for PR 13993 at commit
|
|
The change looks good for me. For the |
|
CCing @junyangq too |
|
Any thought on this? Would be good to fix this before the next RC for 2.0.0? |
| @@ -53,26 +53,27 @@ setClass("AFTSurvivalRegressionModel", representation(jobj = "jobj")) | |||
| #' @note KMeansModel since 2.0.0 | |||
| setClass("KMeansModel", representation(jobj = "jobj")) | |||
|
|
|||
| #' Saves the machine learning model to the input path | |||
| #' Saves the MLlib model to the input path | |||
There was a problem hiding this comment.
I would suggest shorter title like "Save Machine Learning Model"
There was a problem hiding this comment.
I think the convention that has been suggested is that we have the page title being the same first sentence of the description?
There was a problem hiding this comment.
I sort of have some impression, but would this be too restrictive? @shivaram
There was a problem hiding this comment.
The write.ml can only be used for saving MLlib models, it can not save other machine learning model produced by native R functions. So I think the current description is accurate enough.
|
The other changes look good to me. |
|
Any thought? @shivaram what do you think? |
|
Change LGTM. Thanks @junyangq and @yanboliang for reviewing. Merging this to master and branch-2.0 |
## What changes were proposed in this pull request? From SPARK-16140/PR #13921 - the issue is we left write.ml doc empty:  Here's what I meant as the fix:   I didn't realize there was already a JIRA on this. mengxr yanboliang ## How was this patch tested? check doc generated. Author: Felix Cheung <felixcheung_m@hotmail.com> Closes #13993 from felixcheung/rmllibdoc. (cherry picked from commit 7f38b9d) Signed-off-by: Shivaram Venkataraman <shivaram@cs.berkeley.edu>
What changes were proposed in this pull request?
From SPARK-16140/PR #13921 - the issue is we left write.ml doc empty:
Here's what I meant as the fix:
I didn't realize there was already a JIRA on this. @mengxr @yanboliang
How was this patch tested?
check doc generated.