[SPARK-18322] ML, Graph 2.1 QA: Update user guide for new features & APIs - ASF JIRA

XML

Word

Printable

JSON

Check the user guide vs. a list of new APIs (classes, methods, data members) to see what items require updates to the user guide.

For each feature missing user guide doc:

Create a JIRA for that feature, and assign it to the author of the feature
Link it to (a) the original JIRA which introduced that feature ("related to") and (b) to this JIRA ("requires").

For MLlib:

This task does not include major reorganizations for the programming guide.
We should now begin copying algorithm details from the spark.mllib guide to spark.ml as needed, rather than just linking back to the corresponding algorithms in the spark.mllib user guide.

If you would like to work on this task, please comment, and we can create & link JIRAs for parts of this work.

relates to

SPARK-18480 Link validation for ML guides

SPARK-18428 Update docs for GraphX

SPARK-18446 make sure all ML algos have links to API docs

SPARK-18081 Locality Sensitive Hashing (LSH) User Guide

SPARK-18633 Add multiclass logistic regression summary python example and document

SPARK-18705 Docs for one-pass solver for linear regression with L1 and elastic-net penalties

requires

SPARK-18427 Update docs of mllib.KMeans

(1 relates to, 1 requires)