Skip to content

DOC Update docstring of RFs regarding max_samples#16738

Merged
NicolasHug merged 3 commits intoscikit-learn:masterfrom
johannfaouzi:random-forest-docstring
Mar 21, 2020
Merged

DOC Update docstring of RFs regarding max_samples#16738
NicolasHug merged 3 commits intoscikit-learn:masterfrom
johannfaouzi:random-forest-docstring

Conversation

@johannfaouzi
Copy link
Copy Markdown
Contributor

Reference Issues/PRs

Fixes #16733

What does this implement/fix? Explain your changes.

This small PR updates the description of the sub-sample size to take into account the addition of the max_samples parameter in version 0.22.

Copy link
Copy Markdown
Member

@NicolasHug NicolasHug left a comment

Choose a reason for hiding this comment

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

thanks @johannfaouzi !

Comment on lines +887 to +889
The sub-sample size is controlled with the max_samples parameter if
bootstrap=True (default), otherwise the whole dataset is used to build each
tree.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
The sub-sample size is controlled with the max_samples parameter if
bootstrap=True (default), otherwise the whole dataset is used to build each
tree.
The sub-sample size is controlled with the `max_samples` parameter if
`bootstrap=True` (default), otherwise the whole dataset is used to build each
tree.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks! I copy-pasted the rendered text instead of the markdown source...

Comment on lines +1205 to +1207
The sub-sample size is controlled with the max_samples parameter if
bootstrap=True (default), otherwise the whole dataset is used to build each
tree.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
The sub-sample size is controlled with the max_samples parameter if
bootstrap=True (default), otherwise the whole dataset is used to build each
tree.
The sub-sample size is controlled with the `max_samples` parameter if
`bootstrap=True` (default), otherwise the whole dataset is used to build each
tree.

@NicolasHug NicolasHug changed the title [MRG] DOC: Update description of random forest estimators regarding sub-sample size DOC Update docstring of RFs regarding max_samples Mar 21, 2020
@NicolasHug NicolasHug merged commit 78b7a50 into scikit-learn:master Mar 21, 2020
@johannfaouzi johannfaouzi deleted the random-forest-docstring branch March 23, 2020 12:15
gio8tisu pushed a commit to gio8tisu/scikit-learn that referenced this pull request May 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Description of bootstrapping for RandomForest estimators

2 participants