From 2ad031be67c7a0f0c4895c084c891330a9ec935e Mon Sep 17 00:00:00 2001 From: Yanbo Liang Date: Mon, 11 Jul 2016 14:31:11 -0700 Subject: [SPARKR][DOC] SparkR ML user guides update for 2.0 ## What changes were proposed in this pull request? * Update SparkR ML section to make them consistent with SparkR API docs. * Since #13972 adds labelling support for the ```include_example``` Jekyll plugin, so that we can split the single ```ml.R``` example file into multiple line blocks with different labels, and include them in different algorithms/models in the generated HTML page. ## How was this patch tested? Only docs update, manually check the generated docs. Author: Yanbo Liang Closes #14011 from yanboliang/r-user-guide-update. --- R/pkg/R/mllib.R | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'R/pkg') diff --git a/R/pkg/R/mllib.R b/R/pkg/R/mllib.R index 4fe73671f8..e9fd0c75c1 100644 --- a/R/pkg/R/mllib.R +++ b/R/pkg/R/mllib.R @@ -55,8 +55,9 @@ setClass("KMeansModel", representation(jobj = "jobj")) #' Generalized Linear Models #' -#' Fits generalized linear model against a Spark DataFrame. Users can print, make predictions on the -#' produced model and save the model to the input path. +#' Fits generalized linear model against a Spark DataFrame. +#' Users can call \code{summary} to print a summary of the fitted model, \code{predict} to make +#' predictions on new data, and \code{write.ml}/\code{read.ml} to save/load fitted models. #' #' @param data SparkDataFrame for training. #' @param formula A symbolic description of the model to be fitted. Currently only a few formula @@ -270,7 +271,8 @@ setMethod("summary", signature(object = "NaiveBayesModel"), #' K-Means Clustering Model #' #' Fits a k-means clustering model against a Spark DataFrame, similarly to R's kmeans(). -#' Users can print, make predictions on the produced model and save the model to the input path. +#' Users can call \code{summary} to print a summary of the fitted model, \code{predict} to make +#' predictions on new data, and \code{write.ml}/\code{read.ml} to save/load fitted models. #' #' @param data SparkDataFrame for training #' @param formula A symbolic description of the model to be fitted. Currently only a few formula -- cgit v1.2.3