spark-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Apache Spark (JIRA)" <>
Subject [jira] [Assigned] (SPARK-20484) Add documentation to ALS code
Date Fri, 28 Apr 2017 02:06:04 GMT


Apache Spark reassigned SPARK-20484:

    Assignee:     (was: Apache Spark)

> Add documentation to ALS code
> -----------------------------
>                 Key: SPARK-20484
>                 URL:
>             Project: Spark
>          Issue Type: Improvement
>          Components: ML, MLlib
>    Affects Versions: 2.1.0
>            Reporter: Daniel Li
>            Priority: Trivial
> The documentation (both Scaladocs and inline comments) for the ALS code (in package {{}})
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

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

View raw message