Add "recording" to keys in RecordingSampler; docs fix
#614
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
- Recordings are incorrectly treated as contiguous by `SequenceSampler` due to lack of `groupby` upon `"recording"`. - `plot_sleep_staging_chambon2018` calls `n_windows = n_windows_stride` "maximal overlap", but that doesn't make sense to me, isn't it minimal overlap? Updated docs accordingly. - typo fix
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #614 +/- ##
=======================================
Coverage 87.25% 87.25%
=======================================
Files 67 67
Lines 5980 5980
=======================================
Hits 5218 5218
Misses 762 762 |
bruAristimunha
approved these changes
May 17, 2024
agramfort
reviewed
May 18, 2024
| @@ -18,8 +18,8 @@ class RecordingSampler(Sampler): | ||
| Parameters | ||
| ---------- | ||
| metadata : pd.DataFrame | ||
| DataFrame with at least one of {subject, session, run} columns for each | ||
| window in the BaseConcatDataset to sample examples from. Normally | ||
| DataFrame with at least one of {subject, session, run, recording} columns |
There was a problem hiding this comment.
what is a recording? how does a session differ from a recording?
There was a problem hiding this comment.
I don't know, sounds like a question for other maintainers.
There was a problem hiding this comment.
It's not consistent across all datasets; some use recording as a file unit, others use session, and some sessions have many recordings (I don't know why).
robintibor
reviewed
May 27, 2024
| Number of windows between two consecutive sequences. | ||
| Number of windows between two consecutive starts of sequences. | ||
| n_windows_stride=1 is maximal overlap. | ||
| n_windows_stride=n_windows is minimal overlap. |
There was a problem hiding this comment.
minimal overlap meaning no overlap or a single overlapping window? assume it is no overlap right? then maybe better to write like that?
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.
SequenceSamplerdue to lack ofgroupbyupon"recording". I'm unsure this is the intended fix, but it does work.plot_sleep_staging_chambon2018callsn_windows = n_windows_stride"maximal overlap", but that doesn't make sense to me, isn't it minimal overlap? Updated docs accordingly.