Add errors option to curvefit #7891
Conversation
Co-authored-by: Dominik Stańczak <stanczakdominik@gmail.com>
xarray/core/dataarray.py
Outdated
| allow_failures: bool, default: False | ||
| If True and the underlying `scipy.optimize_curve_fit` optimization fails for | ||
| any of the fits, return NaN in coefficients and covariances for those | ||
| coordinates. Helpful when fitting multiple curves and some of the data just |
There was a problem hiding this comment.
Remove the Helpful... Part. It just adds clutter for little benefit.
If you want to add such tips do it above the argument list.
There was a problem hiding this comment.
Done in d3decbb. I was also wondering if the name could be something different, like allow_errors for example. Are there any other examples of similar args in xarray, so we could be consistent with those?
There was a problem hiding this comment.
Good point.
In other places we use errors = "raise" | "ignore" | "warn" (the warn part is optional)
There was a problem hiding this comment.
Okay, I'll change it to that.
There was a problem hiding this comment.
Fixed in efce0b3. I was considering adding the option to also warn, but looks like scipy has its own internal mechanism for producing warnings, see here: https://github.com/scipy/scipy/blob/v1.10.1/scipy/optimize/_minpack_py.py#L491. I'm not sure how to control it and didn't want to get into that now. Maybe a warning is now always issued? Although I didn't see any warnings in pytest on my setup at least.
mgunyho
changed the title
|
Oh no, the doctest failure is because the test is flaky, this was introduced by me in #7821, see here: #7821 (comment) and here: a0e6659. I'll submit another patch to fix it soon, although I'm not sure how. If you have any tips to avoid this problem, let me know. |
|
You could use |
Better to use a tolerance in the assterion testing. |
* Add allow_failures flag to Dataset.curve_fit * Reword docstring * Add allow_failures flag also to DataArray * Add unit test for curvefit with allow_failures * Update whats-new Co-authored-by: Dominik Stańczak <stanczakdominik@gmail.com> * Add PR to whats-new * Update docstring * Rename allow_failures to errors to be consistent with other methods * Compute array so test passes also with dask * Check error message * Update whats-new --------- Co-authored-by: Dominik Stańczak <stanczakdominik@gmail.com> Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
xarray.curve_fit#6317 and closes Add allow_failures flag to Dataset.curve_fit #6515whats-new.rstThis is a rebased version of #6515, with the arg
errors = "raise" | "ignore"added toDatasetandDataArray, and with tests. Let me know if the tests should be expanded further.