[jira] [Commented] (SPARK-7924) Consolidate example code in MLlib
[
https://issues.apache.org/jira/browse/SPARK-7924?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15085175#comment-15085175
]
Xusen Yin commented on SPARK-7924:
--
[~mengxr] One reminder, don't we merge the
https://issues.apache.org/jira/browse/SPARK-11399 first? Since examples I left
behind are convolved with docs. I don't think current "include_example"
supports those examples well.
> Consolidate example code in MLlib
> -
>
> Key: SPARK-7924
> URL: https://issues.apache.org/jira/browse/SPARK-7924
> Project: Spark
> Issue Type: Umbrella
> Components: Documentation, ML, MLlib
>Reporter: Xiangrui Meng
>Assignee: Xiangrui Meng
>
> This JIRA is an umbrella for consolidating example code in MLlib, now that we
> are able to insert code snippets from examples into the user guide. This
> will contain tasks not already handled by [SPARK-11337].
> Goal: Have all example code in the {{examples/}} folder, and insert code
> snippets for examples into the user guide. This will make the example code
> easily testable and reduce duplication.
> We will have 1 subtask per example. If you would like to help, please either
> create a subtask or comment below asking us to create a subtask for you.
> For an example to follow, look at:
> *
> [https://github.com/apache/spark/blob/0171b71e9511cef512e96a759e407207037f3c49/examples/src/main/scala/org/apache/spark/examples/ml/TfIdfExample.scala]
> * TF-IDF example in
> [https://raw.githubusercontent.com/apache/spark/0171b71e9511cef512e96a759e407207037f3c49/docs/ml-features.md]
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
-
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org
[jira] [Commented] (SPARK-7924) Consolidate example code in MLlib
[ https://issues.apache.org/jira/browse/SPARK-7924?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=15081714#comment-15081714 ] Joseph K. Bradley commented on SPARK-7924: -- Let's make this into an umbrella for example code. I'll update the JIRA soon. > Consolidate example code in MLlib > - > > Key: SPARK-7924 > URL: https://issues.apache.org/jira/browse/SPARK-7924 > Project: Spark > Issue Type: Task > Components: Documentation, MLlib >Affects Versions: 1.4.0 >Reporter: Xiangrui Meng >Assignee: Xiangrui Meng > > There are several places for example code in MLlib: > 1. Scala/Java/Python API doc > 2. User guide > 3. examples/ > Their content overlaps, and it becomes harder and harder to keep them in sync > as the project grow. So it would be nice if we can consolidate them. The plan > is to move all code snippets to the API doc, put links in the user guide, and > then only keep application templates under examples/. -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org For additional commands, e-mail: issues-h...@spark.apache.org
[jira] [Commented] (SPARK-7924) Consolidate example code in MLlib
[ https://issues.apache.org/jira/browse/SPARK-7924?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14568065#comment-14568065 ] Joseph K. Bradley commented on SPARK-7924: -- The main downside I see to this proposal is that the API docs won't include images, which are nice for integrated, holistic docs like scikit-learn has (e.g., [http://scikit-learn.org/stable/modules/linear_model.html]). Or is there a way to embed images in the API docs? Something which would be even cooler would be: * Annotate code examples with comments which a script can recognize. * Use a script to copy code snippets from examples into the user guide. This would allow us to maintain one less copy of the code, plus test the code snippets in the user guide. I would guess it would be much harder to test the code in the API docs in some automatic way. Now who wants to implement this? Consolidate example code in MLlib - Key: SPARK-7924 URL: https://issues.apache.org/jira/browse/SPARK-7924 Project: Spark Issue Type: Task Components: Documentation, MLlib Affects Versions: 1.4.0 Reporter: Xiangrui Meng Assignee: Xiangrui Meng There are several places for example code in MLlib: 1. Scala/Java/Python API doc 2. User guide 3. examples/ Their content overlaps, and it becomes harder and harder to keep them in sync as the project grow. So it would be nice if we can consolidate them. The plan is to move all code snippets to the API doc, put links in the user guide, and then only keep application templates under examples/. -- This message was sent by Atlassian JIRA (v6.3.4#6332) - To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org For additional commands, e-mail: issues-h...@spark.apache.org
