docs(time_feature): clarify get_seasonality returns calendar defaults - #3279
Open
abhu85 wants to merge 1 commit into
Open
docs(time_feature): clarify get_seasonality returns calendar defaults#3279abhu85 wants to merge 1 commit into
abhu85 wants to merge 1 commit into
Conversation
…, not data inference The `get_seasonality` function name suggested it detects or estimates seasonality from data, but it actually returns predetermined calendar-based heuristics (e.g., hourly -> 24, monthly -> 12). This adds comprehensive documentation to both `get_seasonality` and `DEFAULT_SEASONALITIES` clarifying that: - The function does NOT analyze time series data - It returns static calendar conventions - Values are used for MASE scaling, seasonal naive baselines, etc. - The returned value should not be interpreted as detected seasonality Fixes awslabs#3278 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Author
|
Friendly ping for review. This is a documentation-only change addressing the concern in #3278 that |
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
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.
Summary
This PR addresses the concern raised in #3278 that the
get_seasonalityfunction name is misleading.The function name suggests it detects or estimates seasonality from data, but it actually returns predetermined calendar-based heuristics (e.g., hourly -> 24, monthly -> 12). Users may reasonably assume some form of data-driven inference is taking place, which is not the case.
Changes
Added comprehensive documentation to both
get_seasonalityandDEFAULT_SEASONALITIESthat explicitly clarifies:Why Documentation Instead of Renaming?
After reviewing the codebase, I found
get_seasonalityis imported and used in 20+ locations across evaluation metrics, model implementations, and tests. Renaming would be a breaking change affecting many users.The documentation approach:
Test Plan
Fixes #3278