[ENH] parameter estimators for stationarity - ADF and KPSS #4247
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.
This PR adds two parameter estimators for stationarity - ADF (Augmented Dickey-Fuller) and KPSS (Kwiatkowski-Phillips-Schmidt-Shin) tests, directly interfacing
statsmodels.tsa.stattools
.Besides exposing them in the unified
sktime
interface, a fitted parameterstationary
is added which tells the user whether the test considers the time series stationary.This can be used, for instance, for conditional differencing in a pipeline where the boolean can be forwarded to an
OptionalPassthrough
.This PR also contains some docstring fixes discovered elsewhere, in the context of this piece of work.
FYI @ngupta23, you might find this useful. I'll add a pipeline example to the docstring once all PR it would be conditional on are merged.
It would be apprecated if reviewers could check the logic - especially behind the boolean. E.g., as it is currently coded, one of the tests has "stationarity" as rejection, one as accepting the null - this is intentionally inconsistent.