Fix documentation of entropy function #3018
Merged
+2
−2
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
|
|
||
| .. math:: | ||
|
|
||
| \sum p_i \log_2(p_i) | ||
| \sum p_i \log(p_i) |
There was a problem hiding this comment.
I think this needs a minus sign; and it would be clearer if you used "\ln" rather than "\log".
|
The Travis failure is unrelated. |
Fix the documentation of the entropy function to correct the formula so it reflects the calculation used in the code. Also mention the unit of the value returned,
|
OK, I have figured out how to do that and it's done |
efiring
added a commit
that referenced
this pull request
May 4, 2014
Fix documentation of entropy function
|
Thank you. |
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.
Fix the documentation of the entropy function to correct the formula so
it reflects the calculation used in the code. Also mention the unit of
the value returned,
See also this stackoverflow question: Matplotlib mlab entropy calculation incorrect?