spark-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Yanbo Liang (JIRA)" <j...@apache.org>
Subject [jira] [Comment Edited] (SPARK-16144) Add a separate Rd for ML generic methods: read.ml, write.ml, summary, predict
Date Fri, 01 Jul 2016 08:15:11 GMT

    [ https://issues.apache.org/jira/browse/SPARK-16144?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15358625#comment-15358625
] 

Yanbo Liang edited comment on SPARK-16144 at 7/1/16 8:14 AM:
-------------------------------------------------------------

Yes, there is no conflict with {{summary(SparkDataFrame)}}. But if users want to look the
documents of {{summary(model)}}, they very likely to find out the page of {{summary(SparkDataFrame)}}
if they just refer docs by function name. And for in-line help, users very likely to type
{{?summary}} to search docs of {{summary(model)}} rather than type {{summary.ml}} since they
want to know how to use {{summary}}. These are what I'm concerned.


was (Author: yanboliang):
Yes, there is no conflict with {{summary(SparkDataFrame)}}. But if users want to look the
documents of {{summary(model)}}, they very likely to find out the page of {{summary(SparkDataFrame)}}
if they just refer docs by function name. And for in-line help, users very likely to type
{{?summary}} to search docs of {{summary(model)}} rather than type {{summary.ml}}. These are
what I'm concerned.

> Add a separate Rd for ML generic methods: read.ml, write.ml, summary, predict
> -----------------------------------------------------------------------------
>
>                 Key: SPARK-16144
>                 URL: https://issues.apache.org/jira/browse/SPARK-16144
>             Project: Spark
>          Issue Type: Sub-task
>          Components: Documentation, MLlib, SparkR
>    Affects Versions: 2.0.0
>            Reporter: Xiangrui Meng
>            Assignee: Yanbo Liang
>
> After we grouped generic methods by the algorithm, it would be nice to add a separate
Rd for each ML generic methods, in particular, write.ml, read.ml, summary, and predict and
link the implementations with seealso.



--
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


Mime
View raw message