ENH: keepdims=True for xarray reductions #3033
Merged
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
Addresses pydata#2170 Add new option `keepdims` to xarray reduce operations, following the behaviour of Numpy. `keepdims` may be passed to reductions on either Datasets or DataArrays, and will result in the reduced dimensions being still present in the output with size 1. Coordinates that depend on the reduced dimensions will be removed from the Dataset/DataArray
max-sixty
reviewed
Jun 19, 2019
There was a problem hiding this comment.
This looks great! Thanks @ScottWales
One question re the defaults
|
Hello @ScottWales! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found: There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻 Comment last updated at 2019-06-20 04:55:25 UTC |
max-sixty
approved these changes
Jun 19, 2019
There was a problem hiding this comment.
I added a couple of tweaks re the default - let me know your thoughts
Then I'll merge later unless anyone else has comments
Thanks a lot @ScottWales ! Happy to have you as a contributor
Co-Authored-By: Maximilian Roos <5635139+max-sixty@users.noreply.github.com>
|
Thanks for the review @max-sixty, happy to help out |
shoyer
reviewed
Jun 20, 2019
shoyer
approved these changes
Jun 21, 2019
| # Insert np.newaxis for removed dims | ||
| slices = tuple(np.newaxis if i in removed_axes else | ||
| slice(None, None) for i in range(self.ndim)) | ||
| if getattr(data, 'shape', None) is None: |
There was a problem hiding this comment.
I think this would be equivalent to just hasattr(data, 'shape')?
| if keepdims: | ||
| # Insert np.newaxis for removed dims | ||
| slices = tuple(np.newaxis if i in removed_axes else | ||
| slice(None, None) for i in range(self.ndim)) |
There was a problem hiding this comment.
Just FYI, slice(None) is equivalent to slice(None, None)
|
Thanks @ScottWales! |
dcherian
added a commit
to dcherian/xarray
that referenced
this pull request
Jun 24, 2019
* master: (31 commits) Add quantile method to GroupBy (pydata#2828) rolling_exp (nee ewm) (pydata#2650) Ensure explicitly indexed arrays are preserved (pydata#3027) add back dask-dev tests (pydata#3025) ENH: keepdims=True for xarray reductions (pydata#3033) Revert cmap fix (pydata#3038) Add "errors" keyword argument to drop() and drop_dims() (pydata#2994) (pydata#3028) More consistency checks (pydata#2859) Check types in travis (pydata#3024) Update issue templates (pydata#3019) Add pytest markers to avoid warnings (pydata#3023) Feature/merge errormsg (pydata#2971) More support for missing_value. (pydata#2973) Use flake8 rather than pycodestyle (pydata#3010) Pandas labels deprecation (pydata#3016) Pytest capture uses match, not message (pydata#3011) dask-dev tests to allowed failures in travis (pydata#3014) Fix 'to_masked_array' computing dask arrays twice (pydata#3006) str accessor (pydata#2991) fix safe_cast_to_index (pydata#3001) ...
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.
Add new option
keepdimsto xarray reduce operations, following the behaviour of Numpy.keepdimsmay be passed to reductions on either Datasets or DataArrays, and will result in the reduced dimensions being still present in the output with size 1.Coordinates that depend on the reduced dimensions will be removed from the Dataset/DataArray
The name
keepdimsis used here to be consistent with Numpy,keep_dimswas an alternative name proposed in #2170.The functionality has only been added to
Variable.reduce(),Dataarray.reduce()andDataSet.reduce()to start off with, it is not implemented forGroupBy,RollingorResample.whats-new.rstfor all changes andapi.rstfor new API