fix doc for extrapolate_trend and allow period as well
#9510
Conversation
This file contains hidden or 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
…odels.tsa.seasonal.seasonal_decompose
bashtage
requested changes
Feb 18, 2025
| @@ -802,7 +802,7 @@ def test_interpolate_trend(self): | |||
| trend = seasonal_decompose(x, period=freq, extrapolate_trend=5).trend | |||
There was a problem hiding this comment.
Could you rename Freq to period in these tests? Sounds like Freq is not used at all, aside from the keyword.
There was a problem hiding this comment.
Good point. Done
Also changed it here: https://github.com/turbotimon/statsmodels/blob/031428a03473fb36b4b5bad5155afc246a28673b/statsmodels/tsa/tests/test_seasonal.py#L941
| @@ -181,7 +181,8 @@ def seasonal_decompose( | |||
| nsides = int(two_sided) + 1 | |||
| trend = convolution_filter(x, filt, nsides) | |||
|
|
|||
| if extrapolate_trend == "freq": | |||
| # 'freq' is still accepted for legacy purposes | |||
| if extrapolate_trend in ("freq", "period"): | |||
There was a problem hiding this comment.
Ideally we would deprecate 'freq' here and warn that 'freq' will error after the 0.16 release.
There was a problem hiding this comment.
Agree. Can you please check and tell me if I need to do something more with respect to deprecating it?
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.
extrapolate_trendinseasonal_decomposewrong description offreqinstead ofperiod#9509NumPy's guide.
Proposed changes with explanation, see #9509
It's my "very first issue" for statmodels, please tell me if something needs to be improved