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-12634][Python][MLlib][DOC] Update param descriptions for tree.py #10601

Closed
wants to merge 4 commits into from

Conversation

vijaykiran
Copy link
Contributor

Updates the param descriptions, in mllib/tree.py, to be consistent. See [SPARK-11219] for
more details.

@vijaykiran vijaykiran changed the title [SPARK-12634][DOC] Update param descriptions [SPARK-12634][Python][MLlib][DOC] Update param descriptions Jan 7, 2016
@thunterdb
Copy link
Contributor

@vijaykiran thanks for the style fixes.

cc @jkbradley

@jkbradley
Copy link
Member

I just added a note to the parent JIRA about a formatting issue affecting all 5 PRs: [https://issues.apache.org/jira/browse/SPARK-11219?focusedCommentId=15090225&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-15090225]
Could you please check it out & ping when I should review again? Thank you!

@vijaykiran
Copy link
Contributor Author

Ping @jkbradley / @BryanCutler

(default: 32)
:param seed: Random seed for bootstrapping and choosing feature
subsets.
:param data: Training dataset:
Copy link
Member

Choose a reason for hiding this comment

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

"Training dataset:" should be on the next line

@BryanCutler
Copy link
Member

Thanks @vijaykiran , this is looking much better! I made a few comments for correction, and could you also update the PR title and description to indicate that this is for tree.py?

@vijaykiran vijaykiran changed the title [SPARK-12634][Python][MLlib][DOC] Update param descriptions [SPARK-12634][Python][MLlib][DOC] Update param descriptions for tree.py Jan 23, 2016
Updates the `param` descriptions to be consistent. See [SPARK-11219] for
more details.
- Update fill-column to 100 on parameter descriptions.
@vijaykiran
Copy link
Contributor Author

@BryanCutler ping! Can you check one more time ? returns are styled now.

@BryanCutler
Copy link
Member

LGTM, ping @jkbradley

@mengxr
Copy link
Contributor

mengxr commented Jan 27, 2016

ok to test

@SparkQA
Copy link

SparkQA commented Jan 27, 2016

Test build #50150 has finished for PR 10601 at commit 36be47c.

  • This patch passes all tests.
  • This patch merges cleanly.
  • This patch adds no public classes.

@mengxr
Copy link
Contributor

mengxr commented Feb 2, 2016

@vijaykiran Could you fix the doc build warnings in tree.py? I saw the following by running make clean html under python/docs:

/Users/meng/src/spark/python/pyspark/mllib/tree.py:docstring of pyspark.mllib.tree.RandomForest.trainClassifier:18: ERROR: Unexpected indentation.
/Users/meng/src/spark/python/pyspark/mllib/tree.py:docstring of pyspark.mllib.tree.RandomForest.trainClassifier:20: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/meng/src/spark/python/pyspark/mllib/tree.py:docstring of pyspark.mllib.tree.RandomForest.trainRegressor:15: ERROR: Unexpected indentation.
/Users/meng/src/spark/python/pyspark/mllib/tree.py:docstring of pyspark.mllib.tree.RandomForest.trainRegressor:17: WARNING: Block quote ends without a blank line; unexpected unindent.

:return: RandomForestModel that can be used for prediction
:param data:
Training dataset: RDD of LabeledPoint. Labels should take values
{0, 1, ..., numClasses-1}.:param numClasses: Number of classes
Copy link
Member

Choose a reason for hiding this comment

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

the numClasses param got put in with the previous description

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
7 participants