-
Notifications
You must be signed in to change notification settings - Fork 21
Add tick_delay to mitigate boundary races in cascaded resampling
#1394
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
Open
malteschaaf
wants to merge
3
commits into
frequenz-floss:v1.x.x
Choose a base branch
from
malteschaaf:cascaded_resampler
base: v1.x.x
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+396
−2
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -201,6 +201,25 @@ class ResamplerConfig: | |
| time the resampler is created. | ||
| """ | ||
|
|
||
| tick_delay: timedelta = field(default=timedelta(0), kw_only=True) | ||
| """Delay before processing each resampling tick. | ||
|
|
||
| This delays when resampling computation happens, while keeping the | ||
| resampling windows aligned to the original timer tick boundaries. This | ||
| delay is only a time-based buffer, not a strict synchronization mechanism. | ||
|
|
||
| Warning: | ||
| This is an experimental option and may be changed or deprecated in | ||
| the future. | ||
|
|
||
| Typical use case: | ||
| This can be used in cascaded resampling setups to reduce timing races | ||
| where downstream windows are processed before upstream resampled values | ||
| are emitted. | ||
|
Comment on lines
+215
to
+218
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nitpick: I would use a standard admonition, in this case probably |
||
|
|
||
| It must be non-negative and smaller than `resampling_period`. | ||
| """ | ||
|
|
||
| def __post_init__(self) -> None: | ||
| """Check that config values are valid. | ||
|
|
||
|
|
@@ -245,6 +264,13 @@ def __post_init__(self) -> None: | |
| raise ValueError( | ||
| f"align_to ({self.align_to}) should be a timezone aware datetime" | ||
| ) | ||
| if self.tick_delay < timedelta(0): | ||
| raise ValueError(f"tick_delay ({self.tick_delay}) should be non-negative") | ||
| if self.tick_delay >= self.resampling_period: | ||
| raise ValueError( | ||
| f"tick_delay ({self.tick_delay}) should be smaller than " | ||
| f"resampling_period ({self.resampling_period})" | ||
| ) | ||
|
|
||
|
|
||
| class ResamplingFunction2(Protocol): | ||
|
|
@@ -415,3 +441,10 @@ def __post_init__(self) -> None: | |
| raise ValueError( | ||
| f"align_to ({self.align_to}) must be specified via timer_config" | ||
| ) | ||
| if self.tick_delay < timedelta(0): | ||
| raise ValueError(f"tick_delay ({self.tick_delay}) should be non-negative") | ||
| if self.tick_delay >= self.resampling_period: | ||
| raise ValueError( | ||
| f"tick_delay ({self.tick_delay}) should be smaller than " | ||
| f"resampling_period ({self.resampling_period})" | ||
| ) | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
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.
And these should be removed, as they are duplicated.