Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SPARK-8517][ML][DOC] Reorganizes the spark.ml user guide #10207

Closed
wants to merge 5 commits into from

Conversation

thunterdb
Copy link
Contributor

This PR moves pieces of the spark.ml user guide to reflect suggestions in SPARK-8517. It does not introduce new content, as requested.

screen shot 2015-12-08 at 11 36 00 am

@jkbradley
Copy link
Member

I'd use the "[ML]" tag in the PR title.

@jkbradley
Copy link
Member

Remove the empty "ml-pipelines.md" file?

@SparkQA
Copy link

SparkQA commented Dec 8, 2015

Test build #47358 has finished for PR 10207 at commit 451b773.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds the following public classes (experimental):\n * [OneVsRest](http://en.wikipedia.org/wiki/Multiclass_classification#One-vs.-rest) is an example of a machine learning reduction for performing multiclass classification given a base classifier that can perform binary classification efficiently. It is also known as \"One-vs-All.\"\n * [Iris dataset](http://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/multiclass/iris.scale), parse it as a DataFrame and perform multiclass classification usingOneVsRest. The test error is calculated to measure the algorithm accuracy.\n * The Pipelines API for Decision Trees offers a bit more functionality than the original API. In particular, for classification, users can get the predicted probability of each class (a.k.a. class conditional probabilities).\n * * a bit more functionality for random forests: estimates of feature importance, as well as the predicted probability of each class (a.k.a. class conditional probabilities) for classification.\n * public class Document implements Serializable\n * public class LabeledDocument extends Document implements Serializable\n * public class Document implements Serializable\n * public class LabeledDocument extends Document implements Serializable\n

- text: Feature extraction, transformation, and selection
- text: "Overview: estimators, transformers and pipelines"
url: ml-intro.html
- text: Building and transforming features
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like using the keywords "extraction, transformation, and selection" since users may search for those. "Building" is pretty generic.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@jkbradley
Copy link
Member

Remove empty "ml-examples.md" file?

@jkbradley
Copy link
Member

Those are my high-level comments. Have you rewritten much text? If so, I can do a second more detailed pass after updates (which will require restructuring).

Thanks!

@thunterdb thunterdb changed the title [SPARK-8517][MLLIB][DOC] Reorganizes the spark.ml user guide [SPARK-8517][ML][DOC] Reorganizes the spark.ml user guide Dec 8, 2015
@thunterdb
Copy link
Contributor Author

@jkbradley no this PR just moves the text around, with little modification. More substantital changes will be done later.

@jkbradley
Copy link
Member

OK thanks just confirming

@SparkQA
Copy link

SparkQA commented Dec 8, 2015

Test build #47367 has finished for PR 10207 at commit 6c7850b.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds the following public classes (experimental):\n * [OneVsRest](http://en.wikipedia.org/wiki/Multiclass_classification#One-vs.-rest) is an example of a machine learning reduction for performing multiclass classification given a base classifier that can perform binary classification efficiently. It is also known as \"One-vs-All.\"\n * [Iris dataset](http://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/multiclass/iris.scale), parse it as a DataFrame and perform multiclass classification usingOneVsRest. The test error is calculated to measure the algorithm accuracy.\n * The Pipelines API for Decision Trees offers a bit more functionality than the original API. In particular, for classification, users can get the predicted probability of each class (a.k.a. class conditional probabilities).\n * * a bit more functionality for random forests: estimates of feature importance, as well as the predicted probability of each class (a.k.a. class conditional probabilities) for classification.\n * public class Document implements Serializable\n * public class LabeledDocument extends Document implements Serializable\n * public class Document implements Serializable\n * public class LabeledDocument extends Document implements Serializable\n

@SparkQA
Copy link

SparkQA commented Dec 8, 2015

Test build #47369 has finished for PR 10207 at commit 216acd3.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds the following public classes (experimental):\n * [OneVsRest](http://en.wikipedia.org/wiki/Multiclass_classification#One-vs.-rest) is an example of a machine learning reduction for performing multiclass classification given a base classifier that can perform binary classification efficiently. It is also known as \"One-vs-All.\"\n * [Iris dataset](http://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/multiclass/iris.scale), parse it as a DataFrame and perform multiclass classification usingOneVsRest. The test error is calculated to measure the algorithm accuracy.\n * The Pipelines API for Decision Trees offers a bit more functionality than the original API. In particular, for classification, users can get the predicted probability of each class (a.k.a. class conditional probabilities).\n * * a bit more functionality for random forests: estimates of feature importance, as well as the predicted probability of each class (a.k.a. class conditional probabilities) for classification.\n * public class Document implements Serializable\n * public class LabeledDocument extends Document implements Serializable\n * public class Document implements Serializable\n * public class LabeledDocument extends Document implements Serializable\n

For more background and more details about the implementation, refer to the documentation of the [logistic regression in `spark.mllib`](mllib-linear-methods.html#logistic-regression).

> The current implementation of logistic regression in `spark.ml` only supports binary classes. Support for multiclass regression will be added in the future.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use "Example" heading

@jkbradley
Copy link
Member

Thanks! just a few comments

@jkbradley
Copy link
Member

Thanks for updating it! LGTM pending tests.

@SparkQA
Copy link

SparkQA commented Dec 9, 2015

Test build #2187 has finished for PR 10207 at commit dc584b2.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds the following public classes (experimental):\n * [OneVsRest](http://en.wikipedia.org/wiki/Multiclass_classification#One-vs.-rest) is an example of a machine learning reduction for performing multiclass classification given a base classifier that can perform binary classification efficiently. It is also known as \"One-vs-All.\"\n * [Iris dataset](http://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/multiclass/iris.scale), parse it as a DataFrame and perform multiclass classification usingOneVsRest. The test error is calculated to measure the algorithm accuracy.\n * The Pipelines API for Decision Trees offers a bit more functionality than the original API. In particular, for classification, users can get the predicted probability of each class (a.k.a. class conditional probabilities).\n * * a bit more functionality for random forests: estimates of feature importance, as well as the predicted probability of each class (a.k.a. class conditional probabilities) for classification.\n * public class Document implements Serializable\n * public class LabeledDocument extends Document implements Serializable\n * public class Document implements Serializable\n * public class LabeledDocument extends Document implements Serializable\n

@SparkQA
Copy link

SparkQA commented Dec 9, 2015

Test build #47384 has finished for PR 10207 at commit dc584b2.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds the following public classes (experimental):\n * [OneVsRest](http://en.wikipedia.org/wiki/Multiclass_classification#One-vs.-rest) is an example of a machine learning reduction for performing multiclass classification given a base classifier that can perform binary classification efficiently. It is also known as \"One-vs-All.\"\n * [Iris dataset](http://www.csie.ntu.edu.tw/~cjlin/libsvmtools/datasets/multiclass/iris.scale), parse it as a DataFrame and perform multiclass classification usingOneVsRest. The test error is calculated to measure the algorithm accuracy.\n * The Pipelines API for Decision Trees offers a bit more functionality than the original API. In particular, for classification, users can get the predicted probability of each class (a.k.a. class conditional probabilities).\n * * a bit more functionality for random forests: estimates of feature importance, as well as the predicted probability of each class (a.k.a. class conditional probabilities) for classification.\n * public class Document implements Serializable\n * public class LabeledDocument extends Document implements Serializable\n * public class Document implements Serializable\n * public class LabeledDocument extends Document implements Serializable\n

@jkbradley
Copy link
Member

Merging with master and branch-1.6

asfgit pushed a commit that referenced this pull request Dec 9, 2015
This PR moves pieces of the spark.ml user guide to reflect suggestions in SPARK-8517. It does not introduce new content, as requested.

<img width="192" alt="screen shot 2015-12-08 at 11 36 00 am" src="https://cloud.githubusercontent.com/assets/7594753/11666166/e82b84f2-9d9f-11e5-8904-e215424d8444.png">

Author: Timothy Hunter <[email protected]>

Closes #10207 from thunterdb/spark-8517.

(cherry picked from commit 765c67f)
Signed-off-by: Joseph K. Bradley <[email protected]>
@asfgit asfgit closed this in 765c67f Dec 9, 2015
asfgit pushed a commit that referenced this pull request Dec 10, 2015
…rk.mllib and mllib in the documentation.

Replaces a number of occurences of `MLlib` in the documentation that were meant to refer to the `spark.mllib` package instead. It should clarify for new users the difference between `spark.mllib` (the package) and MLlib (the umbrella project for ML in spark).

It also removes some files that I forgot to delete with #10207

Author: Timothy Hunter <[email protected]>

Closes #10234 from thunterdb/12212.

(cherry picked from commit 2ecbe02)
Signed-off-by: Joseph K. Bradley <[email protected]>
asfgit pushed a commit that referenced this pull request Dec 10, 2015
…rk.mllib and mllib in the documentation.

Replaces a number of occurences of `MLlib` in the documentation that were meant to refer to the `spark.mllib` package instead. It should clarify for new users the difference between `spark.mllib` (the package) and MLlib (the umbrella project for ML in spark).

It also removes some files that I forgot to delete with #10207

Author: Timothy Hunter <[email protected]>

Closes #10234 from thunterdb/12212.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants