Update performance note of hist() to mention stairs(). #25955
Merged
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
story645
reviewed
May 23, 2023
| @@ -6700,12 +6700,14 @@ def hist(self, x, bins=None, range=None, density=False, weights=None, | |||
| -------- | |||
| hist2d : 2D histogram with rectangular bins | |||
| hexbin : 2D histogram with hexagonal bins | |||
| stairs : Plot a pre-computed histogram | |||
There was a problem hiding this comment.
Can you also add bar since we also recommend bar Y the top for plotting precomputed histograms?
lib/matplotlib/axes/_axes.py
Outdated
Comment on lines
6707
to
6712
| For large numbers of bins (>1000), plotting can be significantly | ||
| accelerated by setting *histtype* to 'step' or 'stepfilled' rather | ||
| than 'bar' or 'barstacked', or by using `~.Axes.stairs` to plot a | ||
| pre-computed histogram (``plt.stairs(*np.histogram(data))``). | ||
| """ |
There was a problem hiding this comment.
Suggested change
| For large numbers of bins (>1000), plotting can be significantly | |
| accelerated by setting *histtype* to 'step' or 'stepfilled' rather | |
| than 'bar' or 'barstacked', or by using `~.Axes.stairs` to plot a | |
| pre-computed histogram (``plt.stairs(*np.histogram(data))``). | |
| """ | |
| For large numbers of bins (>1000), plotting can be significantly | |
| accelerated by using `~.Axes.stairs` to plot a | |
| pre-computed histogram (``plt.stairs(*np.histogram(data))``) or by setting *histtype* to 'step' or 'stepfilled' rather | |
| than 'bar' or 'barstacked'. | |
| """ |
'rather than' makes the histtype part of the sentence more complex so I think it's easier to parse if it's at the end.
timhoffm
approved these changes
May 23, 2023
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
May 23, 2023
…ntion stairs().
timhoffm
added a commit
that referenced
this pull request
May 23, 2023
…955-on-v3.7.x Backport PR #25955 on branch v3.7.x (Update performance note of hist() to mention stairs().)
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.
PR summary
PR checklist