Add `"recording"` to `keys` in `RecordingSampler`; docs fix

braindecode / braindecode

Deep learning software to decode EEG, ECG or MEG signals

https://braindecode.org/

BSD 3-Clause "New" or "Revised" License

752 stars 173 forks source link

Add `"recording"` to `keys` in `RecordingSampler`; docs fix #614

Open OverLordGoldDragon opened 1 month ago

OverLordGoldDragon commented 1 month ago

Recordings are incorrectly treated as contiguous by SequenceSampler due to lack of groupby upon "recording". I'm unsure this is the intended fix, but it does work.
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[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 87.25%. Comparing base (c409800) to head (0df5fc5).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #614 +/- ## ======================================= Coverage 87.25% 87.25% ======================================= Files 67 67 Lines 5980 5980 ======================================= Hits 5218 5218 Misses 762 762 ```