[MRG+1] Refactor birch-documentation - #8298
Merged
Merged
Conversation
| For a new point entering the root, it is merged with the subcluster closest | ||
| to it and the linear sum, squared sum and the number of samples of that | ||
| subcluster are updated. This is done recursively till the properties of | ||
| the leaf node are updated. |
Member
There was a problem hiding this comment.
The guidelines for docstrings is that the text before the parameters should be short. The reason is that users might not realize that parameters are described after.
I think that the right thing would be to move part of the text that you added in the "notes" section.
Member
Author
|
Done, thanks! |
jnothman
reviewed
Feb 6, 2017
| centroid closest to the new sample. This is done recursively till it | ||
| ends up at the subcluster of the leaf of the tree has the closest centroid. | ||
| It is a memory-efficient, online-learning algorithm provided as an alternative | ||
| to MiniBatchKMeans. It constructs a tree data-structure with the cluster |
| to MiniBatchKMeans. It constructs a tree data-structure with the cluster | ||
| centroids being read off the leaf. These can be either the final cluster | ||
| centroids or can be provided as input to another clustering algorithm | ||
| such as `AgglomerativeClustering`. |
| The radius of the subcluster obtained by merging a new sample and the | ||
| closest subcluster should be lesser than the threshold. Otherwise a new | ||
| subcluster is started. | ||
| subcluster is started. Setting this value to be very low, promotes |
| fit is AgglomerativeClustering with n_clusters set to the int. | ||
| subclusters from the leaves as new samples. | ||
|
|
||
| "None" : the final clustering step is not performed and the subclusters are |
Member
There was a problem hiding this comment.
I don't think we should be using quotes for non-string values. Use double-backticks if you wish.
Member
There was a problem hiding this comment.
Also, I'd rather this be formatted using RST's list syntax (either bullet or definition) rather than individual paragraphs.
|
|
||
| Notes | ||
| ----- | ||
| The tree data-structure consists of nodes with each node consisting of |
Member
|
+1 on my side: this is a net improvement of what we have. |
Member
|
If you have a moment to fix my comments, please do so and merge. |
MechCoder
force-pushed
the
refactor_birch
branch
from
February 7, 2017 03:31
d57609a to
ae68282
Compare
Member
Author
|
Thanks! I am embarrassed to admit that after looking at the documentation after a long time and I wasn't sure what was going on till I went through the code again. |
MechCoder
force-pushed
the
refactor_birch
branch
from
February 7, 2017 03:40
ae68282 to
d016857
Compare
sergeyf
pushed a commit
to sergeyf/scikit-learn
that referenced
this pull request
Feb 28, 2017
* Refactor birch-documentation * move * class tags * pep8
Closed
Sundrique
pushed a commit
to Sundrique/scikit-learn
that referenced
this pull request
Jun 14, 2017
* Refactor birch-documentation * move * class tags * pep8
NelleV
pushed a commit
to NelleV/scikit-learn
that referenced
this pull request
Aug 11, 2017
* Refactor birch-documentation * move * class tags * pep8
paulha
pushed a commit
to paulha/scikit-learn
that referenced
this pull request
Aug 19, 2017
* Refactor birch-documentation * move * class tags * pep8
maskani-moh
pushed a commit
to maskani-moh/scikit-learn
that referenced
this pull request
Nov 15, 2017
* Refactor birch-documentation * move * class tags * pep8
lemonlaug
pushed a commit
to lemonlaug/scikit-learn
that referenced
this pull request
Jan 6, 2021
* Refactor birch-documentation * move * class tags * pep8
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this implement/fix? Explain your changes.
This refactors a bit of Birch Documentation.