[MRG+1] AffinityPropagation damping factor not explained #9335
Conversation
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
jnothman
reviewed
Jul 12, 2017
| @@ -301,7 +301,9 @@ is given. | |||
| Affinity Propagation can be interesting as it chooses the number of | |||
| clusters based on the data provided. For this purpose, the two important | |||
| parameters are the *preference*, which controls how many exemplars are | |||
| used, and the *damping factor*. | |||
| used, and the *damping factor* which damps the responsibility and | |||
| availability messages to avoid numerical oscillations when updating these | |||
There was a problem hiding this comment.
can it be included in the equations below?
jnothman
reviewed
Jul 12, 2017
| As discussed above, in order to avoid numerical oscillations when updating the | ||
| messages, the damping factor :math:`\lambda` is introduced to iteration process: | ||
|
|
||
| .. math:: r_{t+1}(i, k) = \lambda\cdot r_{t}(i, k) + (1-\lambda)\cdot r_{t+1}(i, k) |
There was a problem hiding this comment.
So to be sure, this means the previous value has to contribute at least half of the new value relative to the incoming message, but can contribute more. Yes?
There was a problem hiding this comment.
Not sure about that. Paper just mentions that damping factor should be between 0 and 1. But, according to scikit's API documentation, yes.
jnothman
reviewed
Jul 12, 2017
| @@ -197,7 +197,10 @@ class AffinityPropagation(BaseEstimator, ClusterMixin): | |||
| Parameters | |||
| ---------- | |||
| damping : float, optional, default: 0.5 | |||
| Damping factor between 0.5 and 1. | |||
| Damping factor (between 0.5 and 1) damps the | |||
There was a problem hiding this comment.
How about "Damping factor (between 0.5 and 1) is the extent to which the current value is maintained relative to incoming values (weighted 1 - damping)."?
There was a problem hiding this comment.
Yes, that explains damping better. Should I add that to both API doc and User guide?
There was a problem hiding this comment.
Definitely here; user guide says the same in math. Do what you would find helpful as a user.
|
@jnothman I have made the changes. Should I finally squash them? |
|
No, we squash upon merge. Squashing sooner only messes up reviewer tracking of changes. |
|
thx @SebastinSanty |
jnothman
pushed a commit
to jnothman/scikit-learn
that referenced
this pull request
Aug 6, 2017
…n#9335) * AffinityPropagation damping factor not explained * Added for API also * Add equation for damping * formatting text * Add suggestions
dmohns
pushed a commit
to dmohns/scikit-learn
that referenced
this pull request
Aug 7, 2017
…n#9335) * AffinityPropagation damping factor not explained * Added for API also * Add equation for damping * formatting text * Add suggestions
dmohns
pushed a commit
to dmohns/scikit-learn
that referenced
this pull request
Aug 7, 2017
…n#9335) * AffinityPropagation damping factor not explained * Added for API also * Add equation for damping * formatting text * Add suggestions
NelleV
pushed a commit
to NelleV/scikit-learn
that referenced
this pull request
Aug 11, 2017
…n#9335) * AffinityPropagation damping factor not explained * Added for API also * Add equation for damping * formatting text * Add suggestions
paulha
pushed a commit
to paulha/scikit-learn
that referenced
this pull request
Aug 19, 2017
…n#9335) * AffinityPropagation damping factor not explained * Added for API also * Add equation for damping * formatting text * Add suggestions
AishwaryaRK
pushed a commit
to AishwaryaRK/scikit-learn
that referenced
this pull request
Aug 29, 2017
…n#9335) * AffinityPropagation damping factor not explained * Added for API also * Add equation for damping * formatting text * Add suggestions
maskani-moh
pushed a commit
to maskani-moh/scikit-learn
that referenced
this pull request
Nov 15, 2017
…n#9335) * AffinityPropagation damping factor not explained * Added for API also * Add equation for damping * formatting text * Add suggestions
jwjohnson314
pushed a commit
to jwjohnson314/scikit-learn
that referenced
this pull request
Dec 18, 2017
…n#9335) * AffinityPropagation damping factor not explained * Added for API also * Add equation for damping * formatting text * Add suggestions
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Reference Issue
Fixes #9333
What does this implement/fix? Explain your changes.
Add description about damping in AffinityPropagation in the API and User Guide docs.
Any other comments?
No