[jira] [Assigned] (SPARK-20484) Add documentation to ALS code

["Sean Owen (JIRA)" <ji...@apache.org>]

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

Sean Owen reassigned SPARK-20484:
---------------------------------

    Assignee: Daniel Li
    Priority: Minor  (was: Trivial)

> Add documentation to ALS code
> -----------------------------
>
>                 Key: SPARK-20484
>                 URL: https://issues.apache.org/jira/browse/SPARK-20484
>             Project: Spark
>          Issue Type: Improvement
>          Components: ML, MLlib
>    Affects Versions: 2.1.0
>            Reporter: Daniel Li
>            Assignee: Daniel Li
>            Priority: Minor
>             Fix For: 2.3.0
>
>
> The documentation (both Scaladocs and inline comments) for the ALS code (in package {{org.apache.spark.ml.recommendation}}) can be clarified where needed and expanded where incomplete. This is especially important for parts of the code that are written imperatively for performance, as these parts don't benefit from the intuitive self-documentation of Scala's higher-level language abstractions. Specifically, I'd like to add documentation fully explaining the key functionality of the in-block and out-block objects, their purpose, how they relate to the overall ALS algorithm, and how they are calculated in such a way that new maintainers can ramp up much more quickly.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

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