DOC: Added sentence to docstring of histogram_bin_edges to explain bin width #18344
Conversation
This file contains 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
|
I think the build failure is unrelated, builds fine locally. |
|
Yeah, we are seeing that a lot just now: I opened gh-18349, from the docs it sounds like that should fix it (https://support.circleci.com/hc/en-us/articles/360007188574-Build-has-hit-timeout-limit) |
numpy/lib/histograms.py
Outdated
| @@ -562,7 +562,9 @@ def histogram_bin_edges(a, bins=10, range=None, weights=None): | |||
| below, :math:`h` is the binwidth and :math:`n_h` is the number of | |||
| bins. All estimators that compute bin counts are recast to bin width | |||
| using the `ptp` of the data. The final bin count is obtained from | |||
| ``np.round(np.ceil(range / h))``. | |||
| ``np.round(np.ceil(range / h))``. The final bin width is often less | |||
| than what is returned by the formulas below, in order to allow the | |||
There was a problem hiding this comment.
Suggestion: "The final bin width will therefore generally be less than what is returned by the estimators." "estimator" is a better term than formula, and more consistent. The part about entire range is covered by ptp two sentences back.
There was a problem hiding this comment.
Thanks for your comment, will adjust and repush
madphysicist
approved these changes
Feb 10, 2021
|
Thanks, @jamiebarker0310 ! |
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.
This regards #18319 where it was discussed that the width of the bins returned is not equal to what would is described by the formulas described in the "bins" parameter.