[jira] [Issue Comment Deleted] (SPARK-7924) Consolidate example code in MLlib

["Joseph K. Bradley (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/SPARK-7924?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Joseph K. Bradley updated SPARK-7924:
-------------------------------------
    Comment: was deleted

(was: 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-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org