Revise scatter_masked.py #24409
Revise scatter_masked.py #24409
Conversation
- Expand introduction, including link to NumPy documentation - Simplify plot styling to avoid distraction and overlap - Add an example using a decision boundary style - Add references admonition at the end
There was a problem hiding this comment.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join us on gitter for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
| subplot_kw = { | ||
| 'aspect': 'equal', | ||
| 'xlim': (0, max(x)), | ||
| 'ylim': (0, max(y)) | ||
| } |
There was a problem hiding this comment.
I didn't know we could do this 😄 and I would maybe not put the comment here 'cause I think it makes it seem like this line has something to do w/ the masking specifically
There was a problem hiding this comment.
It's a nice clean approach if you want to create two different plots with the same axes properties, rather than calling methods to set them 🙂
Fair point, what if I moved the comment like this:
subplot_kw = {
'aspect': 'equal',
'xlim': (0, max(x)),
'ylim': (0, max(y))
}
fig, ax = plt.subplots(subplot_kw=subplot_kw)
# Plot data points using masked array
ax.scatter(x, y, s=masked_size, marker='^', c="mediumseagreen")|
Built doc page for |
|
|
||
| ############################################################################### | ||
| # This technique can also be used to plot a decision boundary, rather than | ||
| # masking certain data points so that they don't appear at all. This example | ||
| # uses the same data points and boundary as the example above, this time in the | ||
| # style of a decision boundary. | ||
|
|
There was a problem hiding this comment.
I would tend to just be specific about what you are doing, but use general language. If you want the technical term yo think people will search on, by all means include it. Maybe something like:
| ############################################################################### | |
| # This technique can also be used to plot a decision boundary, rather than | |
| # masking certain data points so that they don't appear at all. This example | |
| # uses the same data points and boundary as the example above, this time in the | |
| # style of a decision boundary. | |
| ############################################################################### | |
| # This technique can be used to plot two groups of data separated by a boundary (sometimes | |
| # termed a "decision boundary"). This example uses two sets of masks to color the data on either | |
| # side of the boundary differently, and adds a shape to define the boundary. |
There was a problem hiding this comment.
Ok gotcha, you're saying to use more general language to describe what the plotting code is doing. Not to explain the ML concept in more general language. That makes sense!
|
Hi @hoffm386 - let us know if we can help you with this PR, thanks! |
|
@hoffm386 just checking in if you have the bandwidth to finish this up (it looks pretty close to done for me) or if you're cool with it being taken over and finished out? |
PR Summary
Resolves #24357
PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst