[jira] [Created] (SPARK-18349) Update R API documentation on ml model summary

["Felix Cheung (JIRA)" <ji...@apache.org>]

Felix Cheung created SPARK-18349:
------------------------------------

             Summary: Update R API documentation on ml model summary
                 Key: SPARK-18349
                 URL: https://issues.apache.org/jira/browse/SPARK-18349
             Project: Spark
          Issue Type: Bug
          Components: ML, SparkR
    Affects Versions: 2.1.0
            Reporter: Felix Cheung


It has been discovered that there is a fair bit of consistency in the documentation of summary functions, eg.

{code}
#' @return \code{summary} returns a summary object of the fitted model, a list of components
#'         including formula, number of features, list of features, feature importances, number of
#'         trees, and tree weights
setMethod("summary", signature(object = "GBTRegressionModel")
{code}

For instance, what should be listed for the return value? Should it be a name or a phrase, or should it be a list of items; and should there be a longer description on what they mean, or reference link to Scala doc.

We will need to review this for all model summary implementations in mllib.R



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org