-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Add defaults during concat 508 #3545
Conversation
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.
Thanks @scottcha! I've left a few small comments.
Let's add a test for concatenating integer variables with a specific fill-value is provided (e.g. 0 or -1). Concatenating should not change the integer dtype in the result.
Co-Authored-By: Deepak Cherian <dcherian@users.noreply.github.com>
…cottcha/xarray into add-defaults-during-concat-508 Merge doc change
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.
xarray/core/concat.py
Outdated
if fill_value is dtypes.NA: | ||
dtype, fill_value = dtypes.maybe_promote( | ||
ds.variables[k].dtype | ||
) | ||
else: | ||
dtype = ds.variables[k].dtype |
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 pattern is starting to look a little familiar now, I think there are at least a handful of existing uses in variable.py already. Maybe factor it out into a helper function in xarray.core.dtypes
?
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.
Ok this is in the new updated PR.
xarray/core/concat.py
Outdated
# if one of the variables doesn't exist find one which does | ||
# and use it to create a fill value | ||
if k not in ds.variables: | ||
for ds in datasets: |
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 nested loop through datasets
concerns me here. It means that concat will run in quadratic time with respect to the number of datasets being concatenated. This probably make xarray.concat
very slow on 1,000 datasets and outrageously slow on 10,000 datasets, both of which happen with some regularity.
it would be best to write this using a separate pass to create dummy versions of each Variable, which could be reused when appropriate.
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.
it would be best to write this using a separate pass to create dummy versions of each Variable, which could be reused when appropriate.
This could happen in calc_concat_over
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 new PR contains improved logic but still required me to go through the list of data_sets a few times. I think the new worst case runtime is O(DN^2) where D is num of datasets and N is number of variables in final list. If no fill value are required then it will be O(DN).
I did some perf testing with the new logic versus the old and I don't really see a significant difference but would love addition feedback if there is a better way.
Perf result for concat 720 files via open_mfdataset Parallel=False for PR:
58.7 s ± 143 ms per loop (mean ± std. dev. of 7 runs, 1 loop each)
Original result
58.1 s ± 251 ms per loop (mean ± std. dev. of 7 runs, 1 loop each)
For 4359 files via open_mfdataset Parallel=False for PR:
5min 54s ± 840 ms per loop (mean ± std. dev. of 7 runs, 1 loop each)
sorry I don't really have a good real-world dataset this large w/out missing values to test the original implementation. But this dataset ~6x larger took ~6x more time even with the penalty to cache and fill the missing values.
I don't currently have good data without missing variables larger than this (hence the PR :) )
I was also not sure I should overload the logic in calc_concat_over to do more but I could re-review this if the logic in the new PR looks like it should be refactored that way.
xarray/core/concat.py
Outdated
filled = full_like( | ||
ds.variables[k], fill_value=fill_value, dtype=dtype | ||
) |
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 am concerned that this dummy variable may not always be the right size.
For example, supposing we are concatenating two Dataset along the existing dimension 'x'
. The first dataset has size x=1
and the second has size x=2
. If a variable is missing from one but not the other, the "dummy" variable would always have the wrong size, resulting in a total length of 2 or 4 but not 3.
To properly handle this, I think you will need to index out the concatenated dimension from the dummy variable (where-ever it is found), and then use expand_dims
to add it back in the appropriate size for the current dataset.
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.
Ok, i'm not really sure I understand this case. Any chance you can provide a test which I can use which would help?
Thanks for working on this important issue! There are a lot of edge cases that can come up in
|
Co-Authored-By: keewis <keewis@users.noreply.github.com>
Ok, I'll work on extending the updates with the feedback and additional tests. Thanks! |
…ring and variable types when variables are missing
Hi, I've provided a new update to this PR (sorry it took me awhile both to get more familiar with the code and find the time to update the PR). I improved the logic to be a bit more performant and handle more edge cases as well as updated the test suite. I have a few questions:
|
I'll take a look at this more carefully soon. But I do think it is a hard
requirement that concat runs in linear time (with respect to the total
number of variables across all datasets).
…On Mon, Dec 30, 2019 at 5:18 PM Scott Chamberlin ***@***.***> wrote:
Hi, I've provided a new update to this PR (sorry it took me awhile both to
get more familiar with the code and find the time to update the PR). I
improved the logic to be a bit more performant and handle more edge cases
as well as updated the test suite. I have a few questions:
1. The tests I wrote are a bit more verbose than the tests previously.
I can tighten them down but I found it was easier for me to read the logic
in this form. Please let me know what you prefer.
2. I'm still not quite sure I've captured all the scenarios as I'm a
pretty basic xarray user so please let me know if there is still something
I'm missing.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#3545?email_source=notifications&email_token=AAJJFVVSKN5ZWD4FQHPIJG3Q3KMWXA5CNFSM4JOLVICKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEH3RY5Q#issuecomment-569842806>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAJJFVUPKZ7Q3UFVSH7D2STQ3KMWXANCNFSM4JOLVICA>
.
|
@scottcha If found this while searching. Have the same requirements, means missing DataArrays in some Datasets of a timeseries to be concatenated. I've already some hacks and workarounds in place for my specific use cases, but it would be really great if this could be handled by xarray. I'll try to test your current implementation against my source data and will report my findings here. Update: I've rebased locally on latest master and this works smoothly with my data (which uses packed data). I'll now look into performance. |
@scottcha @shoyer For one of my use cases (240 datasets, 1 with missing variables) I do not see any performance penalties using this implementation compared to the current. But this might be due to the fact, that the most time consuming part is the If I can be of any help to push this over the line, please ping me. |
Hmmm... maybe we need a short-circuit version of |
@dcherian Just to clarify, the concatenation is done along a new dimension (which has to be created by expand_dims). What do you mean by short-clrcuit in this context? |
@kmuehlbauer @dcherian @shoyer If it would be easier it could abandon this PR and resubmit a new one as the code has drastically changed since the original comments were provided? Essentially I'm waiting for feedback or approval of this PR. |
Can you explain why you think you need the nested iteration over dataset variables? What ordering are you trying to achieve? |
xarray/core/concat.py
Outdated
# Find union of all data variables (preserving order) | ||
# assumes all datasets are relatively in the same order | ||
# and missing variables are inserted in the correct position | ||
# if datasets have variables in drastically different orders | ||
# the resulting order will be dependent on the order they are in the list | ||
# passed to concat | ||
union_of_variables = OrderedDict() | ||
union_of_coordinates = OrderedDict() | ||
for ds in datasets: | ||
var_list = list(ds.variables.keys()) | ||
# this logic maintains the order of the variable list and runs in | ||
# O(n^2) where n is number of variables in the uncommon worst case | ||
# where there are no missing variables this will be O(n) | ||
for i in range(0, len(var_list)): | ||
if var_list[i] not in union_of_variables: | ||
# need to determine the correct place | ||
# first add the new item which will be at the end | ||
union_of_variables[var_list[i]] = None | ||
union_of_variables.move_to_end(var_list[i]) | ||
# move any items after this in the variables list to the end | ||
# this will only happen for missing variables | ||
for j in range(i + 1, len(var_list)): | ||
if var_list[j] in union_of_variables: | ||
union_of_variables.move_to_end(var_list[j]) |
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.
@shoyer if this is the code you are referring to this have two purposes:
- Find a complete set of variables even if the first datatset in the concat list has a missing variable (the previous implementation assums the first datatset has all variables)
- Maintains the order of those variables (which is essentially the sorting operations happening when a missing variable is encountered) which was documented as a requirement for groupby in the previous implementation.
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'm not sure if preserving ordering is really essential, though I guess it would be nice to have.
The fundamental problem here is efficiently determining a consistent merge order between lists. This is pretty similar to some code I once wrote in TensorFlow. It only handles merging two lists efficiently, but hopefully is a good model. The fundamental idea is to simultaneously consume elements across all the lists at once.
I think there is no reason why it could not be extended to N-lists (though it would also need to be changed to fall-back to order of appearance rather than raising an error):
https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/labeled_tensor/python/ops/core.py#L919
Either way, the logic should definitely live in a separate helper function, which makes it easier to test.
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.
Regarding ordering I was going off the previous comment which said
# stack up each variable to fill-out the dataset (in order) # n.b. this loop preserves variable order, needed for groupby.
I believe one of the groupby test was also checking for that but I can't really recall at this point (regardless all existing groupby tests are currently passing in the pr).
I liked the code you linked and took a little detour to to try to incorporate a version of it in to my PR. I pulled it back out once I realized two things:
- The conversion of the input list to a set I thought was a bit risky since the order isn't necessarily guaranteed (esp < python 3.7 where dicts weren't ordered by default) and it's why my implementation was relying on ordered dicts. I'm sure the code you linked is likely ok I just was unsure about taking a dependency on what seemed an undocumented assumption.
- The case where no consistent ordering was possible returned None while I didn't necessarily think that was appropriate for this code since there isn't really a strict necessity for variable ordering and I'm not sure you want to go deeper down that path. Removing this assumption was forcing me in to more complex code.
I did spend a bit of time trying to write the generalized n dimension version of the consistent_ordering code but it was getting quite complex and was potentially hiding some complexity under some syntactic sugar. I ended up refactoring the piece of code in question to an internal method (as its still fairly tied to the implementation of the public method) and put a note that its a potential candidate for a refactor.
The PR is updated with these changes.
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.
@scottcha @shoyer I've tested again the different approaches. If there are only occasional misses I workes quite well. But in corner cases (two neighboring variables miss in consecutive datasets) it can have unwanted results. I'll add some code after the weekend.
From what I read this problem is closely related to the shortest common supersequence problem. I've checked on the implementations and it works very well in terms of result, but is (currently) quite slow.
There should be some checks to possibly find one Dataset which contains all variables and can be used for output sorting. If none such is available then...
If there is a correct solution possible, the code should find it. Just my 2c.
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.
You are right that this is a special case of shortest common supersequence though since there shouldn't be repeated values in any sequence it might be easier to solve.
@kmuehlbauer can you provide a case where you think the ordering determined by the current algorighm isn't providing the expected results? I just updated the PR with a test case for the multiple neighboring missing variables (as well as explicit asserts on the data_var ordering) and I'm still getting expected results. It would be great to see what you observed.
It may be time to actually ask what you want the behavior to really be in this case before introducing additional complexity. I just read through some of the pandas issues and looked like they dealt with this as well pandas-dev/pandas#4588. Is that the behavior you would like in xarray? I like the alignment at least for the default behavior with the pandas behavior but I think its really up to the xarray owners? Pandas allows a sort option which is also something to consider for an explicit alphabetical ordering.
(edited as I think the statement in the linked article about sql behvior was incorrect, also more clear about the pandas behavior)
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.
@scottcha This is from the top of my head, so bear with me, if this isn't creating the unwanted effects.
ds1 = ['d1', 'd3' , 'd4' , 'd5' , 'd6' ]
ds2 = ['d1', 'd2' , 'd4' , 'd5' , 'd6' ]
ds3 = ['d1', 'd2' , 'd3' , 'd5' , 'd6' ]
ds4 = ['d1', 'd2' , 'd3' , 'd4' , 'd6' ]
This is an example where one variable is missing in each Dataset, but the correct ordering is obvious. I hope I got it right. If not, I have to look it up on Monday earliest.
I'll test your additions/changes next week, currently travelling.
@scottcha @shoyer below is a minimal example where one variable is missing in each file. import random
random.seed(123)
random.randint(0, 10)
# create var names list with one missing value
orig = [f'd{i:02}' for i in range(10)]
datasets = []
for i in range(1, 9):
l1 = orig.copy()
l1.remove(f'd{i:02}')
datasets.append(l1)
# create files
for i, dsl in enumerate(datasets):
foo_data = np.arange(24).reshape(2, 3, 4)
with nc.Dataset(f'test{i:02}.nc', 'w') as ds:
ds.createDimension('x', size=2)
ds.createDimension('y', size=3)
ds.createDimension('z', size=4)
for k in dsl:
ds.createVariable(k, int, ('x', 'y', 'z'))
ds.variables[k][:] = foo_data
flist = glob.glob('test*.nc')
dslist = []
for f in flist:
dslist.append(xr.open_dataset(f))
ds2 = xr.concat(dslist, dim='time')
ds2 Output:
Three cases here:
elif opt == "all":
concat_over.update(
set(getattr(datasets[0], subset)) - set(datasets[0].dims)
) and from putting |
xarray/core/concat.py
Outdated
) | ||
|
||
union_of_variables[variable_key] = full_like( | ||
ds[variable_key], fill_value=v_fill_value, dtype=dtype |
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 need to be ds.variables[variable_key], fill_value=v_fill_value, dtype=dtype
, otherwise it will fail later (DataArray has no set_dim
)
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.
Thanks for the feedback and the above test. I'll try to incorporate your suggested test as well as the rest of the pending comments in the next 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.
I added the comment about preserving order because of this test:
xarray/xarray/tests/test_dataset.py
Lines 3631 to 3643 in d63888c
def test_groupby_order(self): | |
# groupby should preserve variables order | |
ds = Dataset() | |
for vn in ["a", "b", "c"]: | |
ds[vn] = DataArray(np.arange(10), dims=["t"]) | |
data_vars_ref = list(ds.data_vars.keys()) | |
ds = ds.groupby("t").mean(...) | |
data_vars = list(ds.data_vars.keys()) | |
assert data_vars == data_vars_ref | |
# coords are now at the end of the list, so the test below fails | |
# all_vars = list(ds.variables.keys()) | |
# all_vars_ref = list(ds.variables.keys()) | |
# self.assertEqual(all_vars, all_vars_ref) |
I wonder if we can drastically simplify this PR with
data_var_order = list(datasets[0].data_vars)
data_var_order += list(data_names - set(data_var_order))
i.e. take the order from the first dataset. Ordering for any variables not in the first dataset is not guaranteed. This should make that groupby test pass.
Unless I'm missing something, I don't think xarray cares about variable order anywhere else.
@@ -1,7 +1,9 @@ | |||
import pandas as pd | |||
from collections import OrderedDict |
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.
just plain dict
should be fine now since we are python 3.6+
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.
Ok, I didn't realize that it was 3.6+ only. Will change to dict.
datasets = create_concat_datasets(2, 123) | ||
vars_to_drop = ["humidity", "precipitation", "cloud cover"] | ||
datasets[0] = datasets[0].drop_vars(vars_to_drop) | ||
datasets[1] = datasets[1].drop_vars(vars_to_drop + ["pressure"]) |
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.
datasets[1] = datasets[1].drop_vars(vars_to_drop + ["pressure"]) | |
datasets[1] = datasets[1].drop_vars(vars_to_drop + ["pressure"]).isel(day=0) |
Tests start failing with this change.
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'll submit an update with the suggested changes. I agree that I'm not sure where order should matter as long as the result is deterministic.
I am now wondering if we can use Example: goal is concat along 'x' with result dataset having
Step 1 would be where we deal with all the edge cases mentioned in @shoyer's comment viz
|
I just pushed an incomplete set of changes as @kmuehlbauer tests have demonstrated there was some incomplete cases the PR still isn't handling.
I'm not sure I have my head wrapped around xarray enough to address @dcherian's latest comments though which is why i'm sharing the code at this point. All tests are passing except the new cases which were pointed out. I'll try to continue to get time to update this but wanted to at least provide this status update at this point as its been awhile. |
Has this been implemented? Or is it still failing the tests? |
Cool PR - looks like it's stale? Maybe someone should copy the work to a new one? Have been coming across this issue a lot in my work recently. |
@scottcha Are you still around and interested to bring this along? If not I could try to dive again into this. |
I'm still along and yes I do still need this functionality (I still sync back to this PR when I have data missing vars). The issue was that the technical requirements got beyond what I was able to account for with the time I had available. If you or someone else was interested in picking it up I'd be happy to evaluate against my use cases. |
Great @scottcha, I was coming back here too every once in an while to just refresh my mind with the ideas pursued here. I can try to rebase the PR onto latest main, if I can free some cycles in the following days for starters. |
I did try that a few months ago, but a lot has changed since the PR was opened so it might actually be easier to reimplement the PR? |
Thanks @keewis for the heads up. I'll have a look and if things get too complicated a reimplementation might be our best option. |
* Fill missing data variables during concat by reindexing * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * FIX: use `Any` for type of `fill_value` as this seems consistent with other places * ENH: add tests * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * typing Co-authored-by: Illviljan <14371165+Illviljan@users.noreply.github.com> * typing Co-authored-by: Illviljan <14371165+Illviljan@users.noreply.github.com> * typing Co-authored-by: Illviljan <14371165+Illviljan@users.noreply.github.com> * use None instead of False Co-authored-by: Illviljan <14371165+Illviljan@users.noreply.github.com> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * concatenate variable in any case if variable has concat_dim * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * add tests from @scottcha #3545 * typing * fix typing * fix tests with, finalize typing * add whats-new.rst entry * Update xarray/tests/test_concat.py Co-authored-by: Illviljan <14371165+Illviljan@users.noreply.github.com> * Update xarray/tests/test_concat.py Co-authored-by: Illviljan <14371165+Illviljan@users.noreply.github.com> * add TODO, fix numpy.random.default_rng * change np.random to use Generator * move code for variable order into dedicated function, merge with _parse_datasets, provide fast lane for variable order estimation * fix comment * Use order from first dataset, append missing variables to the end * ensure fill_value is dict * ensure fill_value in align * simplify combined_var, fix test * revert fill_value for alignment.py * derive variable order in order of appearance as suggested per review * remove unneeded enumerate * Use alignment.reindex_variables instead. This also removes the need to handle fill_value * small cleanup * Update doc/whats-new.rst Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com> * adapt tests as per review request, fix ensure_common_dims * adapt tests as per review request * fix whats-new.rst * add whats-new.rst entry * Add additional test with scalar data_var * remove erroneous content from whats-new.rst Co-authored-by: Scott Chamberlin <scottcha@live.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Illviljan <14371165+Illviljan@users.noreply.github.com> Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
black . && mypy . && flake8
whats-new.rst
for all changes andapi.rst
for new APIContined on issue #508 by removing exception when concat two datasets with disjoint variables and instead add the missing variable with np.nan.