-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
DOC: Fixed x, y, docstring in errorbar #8139
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
||
xerr/yerr : scalar or array-like, shape(n,1) or shape(2,n), optional | ||
If a scalar number, len(N) array-like object, or an Nx1 | ||
xerr/yerr : scalar or array-like, shape(N,) or shape(2,N), optional |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change gives me pause as there is a bunch of subtle logic in error bar that depends on this shape. Can the exact behavior of (N, )
and (N, 1)
arrays be checked before this is merged?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. I did some checks and the docs are 99% correct. I am submitting an issue right now about an inconsistency that I found.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here is the issue: #8140
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The shape is currently checked with len
, which means that N,
is a more accurate representation than Nx1
. I also think that it is less confusing than swapping the dimension that corresponds to N
around in the different cases. As a verification, the following works as expected:
>>> import matplotlib.pyplot as plt
>>> plt.ion()
>>> f, a = plt.subplots()
>>> a.errorbar(*[[1, 2, 3, 4, 5, 6]]*2, yerr=list(range(6)), fmt='o')
while the following does not:
>>> a.errorbar(*[[1, 2, 3, 4, 5, 6]]*2, yerr=[[i] for i in range(6)], fmt='o')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/home/jfoxrabi/miniconda3/lib/python3.5/site-packages/matplotlib/__init__.py", line 1892, in inner
return func(ax, *args, **kwargs)
File "/home/jfoxrabi/miniconda3/lib/python3.5/site-packages/matplotlib/axes/_axes.py", line 3020, in errorbar
lower, upper = extract_err(yerr, y)
File "/home/jfoxrabi/miniconda3/lib/python3.5/site-packages/matplotlib/axes/_axes.py", line 2965, in extract_err
in cbook.safezip(data, err)]
File "/home/jfoxrabi/miniconda3/lib/python3.5/site-packages/matplotlib/axes/_axes.py", line 2964, in <listcomp>
low = [thisx - thiserr for (thisx, thiserr)
TypeError: unsupported operand type(s) for -: 'int' and 'list'
However, this does work:
a.errorbar(*[[1, 2, 3, 4, 5, 6]]*2, yerr=np.array([[i] for i in range(6)]), fmt='o')
So technically, N, 1
was outright wrong for non-array array-likes.
Sorry about that syntax for x
, y
. I was so fascinated with the fact that it actually worked that I left it in :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I went ahead and added this pair of examples to issue #8140
Interesting. Looks like |
@@ -2705,11 +2705,11 @@ def errorbar(self, x, y, yerr=None, xerr=None, | |||
|
|||
Parameters | |||
---------- | |||
x : scalar | |||
y : scalar | |||
x : scalar or array-like |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would just say "array-like", scalars is just a special case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd keep it this way. Array-like refers to iterable, which a scalar isn't.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
scatter
, bar
, step
all use array_like
in their docs even though they also accept scalars. Either way we should be consistent.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that it should be removed for x
and y
but retained for errx
and erry
. x
and y
are arrays to plot. As @anntzer says, scalars are just a special case that represents a dataset of size 1. For errx
and erry
, scalars have a somewhat special meaning, which should be emphasized in the docs. Will update.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another argument in @anntzer's favor is that the scalar case is explicitly dealt with in the sentence above the parameters section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
e.g. np.sum
:
Parameters
----------
a : array_like
Elements to sum.
In [1]: np.sum(1)
Out[1]: 1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As I said, I really don't care as I consider Matplotlib's loose input format harmful and not useful for the project, but this convention is not only unclear, but not followed by major scientific projects (scipy, sklearn, skimage, sympy pandas and even Matplotlib).
It boils down whether you want or not to document the fact that errorbar takes scalars as input. I am, once again, totally fine with not documenting it, but let's not pretend that the current docstring documents this in any meaningful and clear way.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The previous sentence reads:
x, y, xerr, and yerr can all be scalars, which plots a single error bar at x, y.
I think that should be enough for most users.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that's good enough.
FWIW git-grepping the codebase of scipy and skimage yields no result for ... or array-like
or array-like or ...
(where ... refers to "scalar", "float", or some similar term); meanwhile at least some functions that are documented to take an "array-like" as argument can also take a scalar.
scikit-learn is different because it documents the shape of the required input nearly every time it documents an input as array-like, so scalars are explicitly excluded by that shape info.
sympy uses the word array-like exactly twice in its docs (in the sense of not including scalars).
pandas seems to use the word array-like in the sense of not including scalars as well.
So overall I wouldn't say there's any global agreement.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this thread is based on an outdated diff, I went ahead and changed back to scalar or array-like
. I think that is a reasonable compromise that does not sacrifice clarity, which is really the main objective here (more so than consistency in my opinion).
The CI should not be skipped anyways, so it is a good thing that it didn't work. |
cc426da
to
5998e68
Compare
I really don't care if the fact that these functions take scalars in addition of array-like so the patch is fine with me, but just to be clear, there is no way that anyone will understand scalars can be provided to these functions. In addition, the consistency argument brought up by @anntzer doesn't hold considering git grep array-like returns:
The reason I don't care whether this feature is documented properly is that I believe Matplotlib is too flexible in its input type, and the scalar input can as easily be a 1D numpy vector. But if the goal is to document properly this feature or be consistent, the patch does not achieve this goal. I have no clue whether the current policy of Matplotlib is too accurately document all arguments and input format. |
I don't mind changing the other functions to mention scalars too. Slight overkill on the docs may be better than underkill, especially for new users. Basically, I will do whatever once there is some sort of consensus. |
Well we clearly have a mix of both, you can also git grep for But I agree with @NelleV that overall matplotlib is too flexible with its inputs. I'd say if a user looks at the docs and thinks he has to write Anyways, I thought the point of this PR was more regarding the Nx1 array-like part of the docstring. |
Actually it was more because the docs only said |
Seems to be an obvious omission
5998e68
to
652224c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Independent of a wider standardization of type specifications, this is clearly an improvement!
DOC: Fixed x, y, docstring in errorbar
Backported to |
This should not have got back to 2.0.0-doc, it changes a source (.py) file, not just rst. |
I am thinking about what, if anything we should do about this though. |
Seems to be an obvious omission.
Sorry about the duplicate PR.
[ci skip]