Scope binning docstrings; drop binned_aggregate factory#159
Merged
Conversation
The BinSchedule and BinnedAggregate docstrings described a specific consumer
pipeline ("the SBP path", "the spike-rate branch", "real recordings", "merge
trivially with no post-hoc reconciler") that public users of these packages
won't recognize. Reword in terms of the packages themselves: EventRate, Window,
BinSchedule, and Merge, and the generic case where bin_duration*fs is not an
integer. Also drop the "wall-clock" framing in favor of "each bin spans exactly
bin_duration in the input's time base". Comment-only.
The small functional-constructor helpers are a deprecated pattern that new modules shouldn't add; binned_aggregate.py is new in 2.26.0. Use BinnedAggregateTransformer(BinnedAggregateSettings(...)) instead. Nothing depends on the factory yet, so it is removed outright (a patch release will follow).
cboulay
changed the title
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
1 participant
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.
Two changes to the binning modules added in 2.26.0:
1. Scope the docstrings (doc-only)
The
BinSchedule/BinnedAggregatedocstrings described a specific downstream consumer pipeline that public users won't recognize — named "SBP path" / "spike-rate branch", "real recordings", "merge trivially with no post-hoc reconciler". Reworded in terms of the packages themselves (EventRate,Window,BinSchedule,Merge) and the generic condition that triggers the divergence (bin_duration * fsnot an integer). Also dropped the "wall-clock" framing for "each bin spans exactlybin_durationin the input's time base".2. Remove the
binned_aggregate()factory function (API change)The small functional-constructor helpers are a deprecated pattern that new modules shouldn't add;
binned_aggregate.pyis new in 2.26.0. Construct viaBinnedAggregateTransformer(BinnedAggregateSettings(...))instead. Nothing depends on the factory yet, so it's removed outright — a patch release will follow.Binning tests still pass (39). Companion to the doc-scoping + factory-removal commits in ezmsg-event PR #33.