spark-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Felix Cheung (JIRA)" <>
Subject [jira] [Commented] (SPARK-18349) Update R API documentation on ml model summary
Date Sat, 03 Dec 2016 08:41:58 GMT


Felix Cheung commented on SPARK-18349:

[~wangmiao1981]Please do, thanks! Since we have some questions it would be great if you could
propose the approach and we could discuss a bit here.

> Update R API documentation on ml model summary
> ----------------------------------------------
>                 Key: SPARK-18349
>                 URL:
>             Project: Spark
>          Issue Type: Improvement
>          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

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message