Braindecode 1.8.1.dev170225906__tar.gz → 1.8.1.dev170240616__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (211) hide show
  1. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/NOTICE.txt +3 -0
  2. {braindecode-1.8.1.dev170225906/braindecode.egg-info → braindecode-1.8.1.dev170240616}/PKG-INFO +1 -1
  3. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/augmentation/__init__.py +2 -0
  4. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/augmentation/functional.py +48 -0
  5. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/augmentation/transforms.py +52 -1
  6. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/base.py +64 -3
  7. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/eegneuralnet.py +6 -1
  8. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/__init__.py +6 -0
  9. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/barista.py +23 -11
  10. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/base.py +18 -0
  11. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/brant.py +18 -7
  12. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/codebrain.py +90 -15
  13. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/csbrain.py +24 -12
  14. braindecode-1.8.1.dev170240616/braindecode/models/duin.py +454 -0
  15. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/eeg_clip.py +68 -9
  16. braindecode-1.8.1.dev170240616/braindecode/models/epint.py +311 -0
  17. braindecode-1.8.1.dev170240616/braindecode/models/gcnsnet.py +338 -0
  18. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/mscformer.py +21 -1
  19. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/msvtnet.py +105 -5
  20. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/neurorvq.py +32 -13
  21. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/neurorvq_tokenizer.py +29 -9
  22. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/reve.py +64 -17
  23. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/sinc_shallow.py +2 -1
  24. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/sleepfm.py +62 -12
  25. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/steegformer.py +16 -9
  26. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/summary.csv +3 -0
  27. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/tfm_tokenizer.py +44 -3
  28. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/util.py +8 -0
  29. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/attention.py +37 -9
  30. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/blocks.py +121 -5
  31. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/preprocessing/preprocess.py +17 -0
  32. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/samplers/base.py +60 -61
  33. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/training/losses.py +5 -4
  34. braindecode-1.8.1.dev170240616/braindecode/version.py +1 -0
  35. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616/braindecode.egg-info}/PKG-INFO +1 -1
  36. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode.egg-info/SOURCES.txt +3 -0
  37. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/api.rst +5 -0
  38. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/whats_new.rst +63 -0
  39. braindecode-1.8.1.dev170225906/braindecode/version.py +0 -1
  40. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/LICENSE.txt +0 -0
  41. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/MANIFEST.in +0 -0
  42. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/README.rst +0 -0
  43. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/__init__.py +0 -0
  44. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/augmentation/base.py +0 -0
  45. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/classifier.py +0 -0
  46. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/__init__.py +0 -0
  47. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/_notebook_viewer.py +0 -0
  48. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/bbci.py +0 -0
  49. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/bcicomp.py +0 -0
  50. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/bids/__init__.py +0 -0
  51. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/bids/datasets.py +0 -0
  52. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/bids/format.py +0 -0
  53. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/bids/hub.py +0 -0
  54. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/bids/hub_format.py +0 -0
  55. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/bids/hub_io.py +0 -0
  56. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/bids/hub_validation.py +0 -0
  57. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/bids/iterable.py +0 -0
  58. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/chb_mit.py +0 -0
  59. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/collate.py +0 -0
  60. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/mne.py +0 -0
  61. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/moabb.py +0 -0
  62. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/nmt.py +0 -0
  63. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/registry.py +0 -0
  64. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/siena.py +0 -0
  65. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/sleep_physio_challe_18.py +0 -0
  66. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/sleep_physionet.py +0 -0
  67. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/tuh.py +0 -0
  68. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/utils.py +0 -0
  69. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datasets/xy.py +0 -0
  70. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datautil/__init__.py +0 -0
  71. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datautil/channel_utils.py +0 -0
  72. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datautil/hub_formats.py +0 -0
  73. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datautil/serialization.py +0 -0
  74. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/datautil/util.py +0 -0
  75. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/functional/__init__.py +0 -0
  76. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/functional/_real_dft.py +0 -0
  77. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/functional/functions.py +0 -0
  78. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/functional/initialization.py +0 -0
  79. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/atcnet.py +0 -0
  80. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/attentionbasenet.py +0 -0
  81. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/attn_sleep.py +0 -0
  82. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/axon.py +0 -0
  83. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/bendr.py +0 -0
  84. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/biot.py +0 -0
  85. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/brainbert.py +0 -0
  86. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/brainmodule.py +0 -0
  87. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/brainomni.py +0 -0
  88. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/cbramod.py +0 -0
  89. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/config.py +0 -0
  90. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/contrawr.py +0 -0
  91. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/ctnet.py +0 -0
  92. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/dance.py +0 -0
  93. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/deep4.py +0 -0
  94. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/deepsleepnet.py +0 -0
  95. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/dgcnn.py +0 -0
  96. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/diver1.py +0 -0
  97. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/eegconformer.py +0 -0
  98. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/eegdino.py +0 -0
  99. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/eeginception_erp.py +0 -0
  100. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/eeginception_mi.py +0 -0
  101. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/eegitnet.py +0 -0
  102. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/eegminer.py +0 -0
  103. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/eegnet.py +0 -0
  104. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/eegnex.py +0 -0
  105. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/eegpt.py +0 -0
  106. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/eegsimpleconv.py +0 -0
  107. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/eegsym.py +0 -0
  108. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/eegtcnet.py +0 -0
  109. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/emg2qwerty.py +0 -0
  110. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/fbcnet.py +0 -0
  111. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/fblightconvnet.py +0 -0
  112. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/fbmsnet.py +0 -0
  113. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/guetschel2026.py +0 -0
  114. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/hybrid.py +0 -0
  115. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/ifnet.py +0 -0
  116. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/labram.py +0 -0
  117. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/luna.py +0 -0
  118. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/mapa.py +0 -0
  119. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/medformer.py +0 -0
  120. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/meta_neuromotor.py +0 -0
  121. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/mirepnet.py +0 -0
  122. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/mvpformer.py +0 -0
  123. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/neuropose.py +0 -0
  124. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/patchedtransformer.py +0 -0
  125. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/popt.py +0 -0
  126. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/sccnet.py +0 -0
  127. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/seizure_transformer.py +0 -0
  128. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/sensingdynamics.py +0 -0
  129. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/shallow_fbcsp.py +0 -0
  130. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/signal_jepa.py +0 -0
  131. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/sleep_stager_blanco_2020.py +0 -0
  132. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/sleep_stager_chambon_2018.py +0 -0
  133. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/sparcnet.py +0 -0
  134. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/sstdpn.py +0 -0
  135. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/syncnet.py +0 -0
  136. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/tcformer.py +0 -0
  137. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/tcn.py +0 -0
  138. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/tidnet.py +0 -0
  139. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/tmsanet.py +0 -0
  140. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/tsinception.py +0 -0
  141. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/usleep.py +0 -0
  142. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/vemg2pose.py +0 -0
  143. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/models/zuna.py +0 -0
  144. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/__init__.py +0 -0
  145. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/activation.py +0 -0
  146. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/channels.py +0 -0
  147. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/convolution.py +0 -0
  148. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/dance_modules.py +0 -0
  149. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/filter.py +0 -0
  150. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/layers.py +0 -0
  151. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/linear.py +0 -0
  152. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/linear_attention.py +0 -0
  153. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/parametrization.py +0 -0
  154. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/popt_modules.py +0 -0
  155. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/quantization.py +0 -0
  156. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/stats.py +0 -0
  157. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/util.py +0 -0
  158. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/modules/wrapper.py +0 -0
  159. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/preprocessing/__init__.py +0 -0
  160. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/preprocessing/eegprep_preprocess.py +0 -0
  161. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/preprocessing/mne_preprocess.py +0 -0
  162. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/preprocessing/util.py +0 -0
  163. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/preprocessing/windowers.py +0 -0
  164. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/regressor.py +0 -0
  165. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/samplers/__init__.py +0 -0
  166. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/samplers/ssl.py +0 -0
  167. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/training/__init__.py +0 -0
  168. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/training/callbacks.py +0 -0
  169. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/training/scoring.py +0 -0
  170. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/util.py +0 -0
  171. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/visualization/__init__.py +0 -0
  172. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/visualization/activations.py +0 -0
  173. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/visualization/attribution.py +0 -0
  174. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/visualization/confusion_matrices.py +0 -0
  175. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/visualization/frequency.py +0 -0
  176. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/visualization/metrics.py +0 -0
  177. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/visualization/sanity.py +0 -0
  178. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode/visualization/topology.py +0 -0
  179. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode.egg-info/dependency_links.txt +0 -0
  180. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode.egg-info/requires.txt +0 -0
  181. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/braindecode.egg-info/top_level.txt +0 -0
  182. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/Makefile +0 -0
  183. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/_templates/autosummary/class.rst +0 -0
  184. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/_templates/autosummary/class_in_subdir.rst +0 -0
  185. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/_templates/autosummary/function.rst +0 -0
  186. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/_templates/autosummary/function_in_subdir.rst +0 -0
  187. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/agent_docs.rst +0 -0
  188. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/cite.rst +0 -0
  189. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/conf.py +0 -0
  190. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/help.rst +0 -0
  191. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/index.rst +0 -0
  192. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/install/install.rst +0 -0
  193. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/install/install_pip.rst +0 -0
  194. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/install/install_source.rst +0 -0
  195. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/models/categorization/attention.rst +0 -0
  196. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/models/categorization/channel.rst +0 -0
  197. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/models/categorization/convolution.rst +0 -0
  198. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/models/categorization/filterbank.rst +0 -0
  199. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/models/categorization/gnn.rst +0 -0
  200. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/models/categorization/interpretable.rst +0 -0
  201. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/models/categorization/lbm.rst +0 -0
  202. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/models/categorization/recurrent.rst +0 -0
  203. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/models/categorization/spd.rst +0 -0
  204. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/models/models.rst +0 -0
  205. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/models/models_categorization.rst +0 -0
  206. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/models/models_table.rst +0 -0
  207. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/models/models_visualization.rst +0 -0
  208. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/sg_execution_times.rst +0 -0
  209. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/docs/user_guide/channel_strategies.rst +0 -0
  210. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/pyproject.toml +0 -0
  211. {braindecode-1.8.1.dev170225906 → braindecode-1.8.1.dev170240616}/setup.cfg +0 -0
@@ -40,6 +40,7 @@ The following components are licensed under the MIT License:
40
40
 
41
41
  - `braindecode/models/ctnet.py`
42
42
  - `braindecode/models/dance.py`
43
+ - `braindecode/models/duin.py`
43
44
  - `braindecode/models/medformer.py`
44
45
  - `braindecode/models/tcformer.py`
45
46
  - `braindecode/models/ifnet.py`
@@ -54,6 +55,8 @@ The following components are licensed under the MIT License:
54
55
  - `docs/_static/model/seizure_transformer_arch.png`
55
56
  - `braindecode/models/guetschel2026.py`
56
57
  - `braindecode/models/tmsanet.py`
58
+ - `braindecode/models/epint.py`
59
+ - `braindecode/models/gcnsnet.py`
57
60
 
58
61
  The `brainomni.py` file is a derivative of `OpenTSLab/BrainOmni` (MIT), whose
59
62
  SEANet codec derives from Meta's `facebookresearch/encodec` (MIT). The
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: braindecode
3
- Version: 1.8.1.dev170225906
3
+ Version: 1.8.1.dev170240616
4
4
  Summary: Deep learning software to decode EEG, ECG or MEG signals
5
5
  Author-email: Robin Tibor Schirrmeister <robintibor@gmail.com>, Bruno Aristimunha Pinto <b.aristimunha@gmail.com>, Alexandre Gramfort <agramfort@meta.com>
6
6
  Maintainer-email: Alexandre Gramfort <agramfort@meta.com>, Bruno Aristimunha Pinto <b.aristimunha@gmail.com>, Robin Tibor Schirrmeister <robintibor@gmail.com>
@@ -10,6 +10,7 @@ from .transforms import (
10
10
  ChannelsReref,
11
11
  ChannelsShuffle,
12
12
  ChannelsSymmetry,
13
+ CutMix,
13
14
  FrequencyShift,
14
15
  FTSurrogate,
15
16
  GaussianNoise,
@@ -36,6 +37,7 @@ __all__ = [
36
37
  "SignFlip",
37
38
  "FTSurrogate",
38
39
  "ChannelsShuffle",
40
+ "CutMix",
39
41
  "ChannelsDropout",
40
42
  "GaussianNoise",
41
43
  "ChannelsSymmetry",
@@ -1075,6 +1075,54 @@ def mixup(
1075
1075
  return X_mix, (y_a, y_b, lam)
1076
1076
 
1077
1077
 
1078
+ def cutmix(
1079
+ X: torch.Tensor,
1080
+ y: torch.Tensor,
1081
+ idx_perm: torch.Tensor,
1082
+ cut_t_start: torch.Tensor,
1083
+ cut_t_len: torch.Tensor,
1084
+ ) -> tuple[torch.Tensor, torch.Tensor]:
1085
+ """Paste a time region of shuffled examples into the original examples.
1086
+
1087
+ See [1]_ for details.
1088
+
1089
+ Parameters
1090
+ ----------
1091
+ X : torch.Tensor
1092
+ EEG data in form ``batch_size, n_channels, n_times``
1093
+ y : torch.Tensor
1094
+ Target of length ``batch_size``
1095
+ idx_perm : torch.Tensor
1096
+ Permuted indices of example that are mixed into original examples.
1097
+ cut_t_start : torch.Tensor
1098
+ Start index of the pasted time region for each example.
1099
+ cut_t_len : torch.Tensor
1100
+ Length of the pasted time region for each example.
1101
+
1102
+ Returns
1103
+ -------
1104
+ tuple
1105
+ ``X``, ``y``. Where ``X`` is augmented and ``y`` is a tuple of length
1106
+ 3 containing the labels of the two mixed examples and the fraction of
1107
+ each example kept from the original, ``1 - cut_t_len / n_times``.
1108
+
1109
+ References
1110
+ ----------
1111
+ .. [1] Sangdoo Yun, Dongyoon Han, Seong Joon Oh, Sanghyuk Chun,
1112
+ Junsuk Choe, Youngjoon Yoo (2019). CutMix: Regularization Strategy
1113
+ to Train Strong Classifiers with Localizable Features. In 2019
1114
+ IEEE/CVF International Conference on Computer Vision (ICCV)
1115
+ Online: https://arxiv.org/abs/1905.04899
1116
+ """
1117
+ n_times = X.shape[-1]
1118
+ t = torch.arange(n_times, device=X.device)
1119
+ start = cut_t_start[:, None]
1120
+ in_cut = (t >= start) & (t < start + cut_t_len[:, None])
1121
+ X_mix = torch.where(in_cut[:, None], X[idx_perm], X)
1122
+ lam = (n_times - cut_t_len).to(X.dtype) / n_times
1123
+ return X_mix, (y.clone(), y[idx_perm].clone(), lam)
1124
+
1125
+
1078
1126
  def segmentation_reconstruction(
1079
1127
  X: torch.Tensor,
1080
1128
  y: torch.Tensor,
@@ -3,6 +3,7 @@
3
3
  # Gustavo Rodrigues <gustavenrique01@gmail.com>
4
4
  # Bruna Lopes <brunajaflopes@gmail.com>
5
5
  # Sarthak Tayal <sarthaktayal2@gmail.com>
6
+ # Anton Soloviev <anton@praviel.com>
6
7
  #
7
8
  # License: BSD (3-clause)
8
9
 
@@ -24,6 +25,7 @@ from .functional import (
24
25
  channels_permute,
25
26
  channels_rereference,
26
27
  channels_shuffle,
28
+ cutmix,
27
29
  frequency_shift,
28
30
  ft_surrogate,
29
31
  gaussian_noise,
@@ -1095,6 +1097,55 @@ class Mixup(Transform):
1095
1097
  }
1096
1098
 
1097
1099
 
1100
+ class CutMix(Mixup):
1101
+ """Implements CutMix for EEG data.
1102
+
1103
+ A random time region of each example is replaced by the same region of
1104
+ a shuffled example of the batch, see [1]_. As in the reference code [2]_,
1105
+ a coefficient ``lam`` is drawn from a Beta distribution, the region is
1106
+ ``(1 - lam) * n_times`` long (the 1-D analogue of the cut area ratio
1107
+ ``1 - lam``) around a uniformly drawn center, it is clipped at the trial
1108
+ boundaries, and ``lam`` is then recomputed from the pasted length.
1109
+
1110
+ Like :class:`Mixup`, it applies to whole batches and returns targets
1111
+ ``(y_a, y_b, lam)`` for :func:`braindecode.training.mixup_criterion`.
1112
+
1113
+ Parameters
1114
+ ----------
1115
+ alpha : float
1116
+ Parameter of the Beta distribution of ``lam``. ``alpha <= 0`` cuts
1117
+ nothing.
1118
+ beta_per_sample : bool (default=False)
1119
+ By default, one ``lam`` per batch is drawn. If True, one per sample.
1120
+ random_state : int | numpy.random.Generator, optional
1121
+ Seed to be used to instantiate numpy random number generator instance.
1122
+ Defaults to None.
1123
+
1124
+ References
1125
+ ----------
1126
+ .. [1] Sangdoo Yun, Dongyoon Han, Seong Joon Oh, Sanghyuk Chun,
1127
+ Junsuk Choe, Youngjoon Yoo (2019). CutMix: Regularization Strategy
1128
+ to Train Strong Classifiers with Localizable Features. In 2019
1129
+ IEEE/CVF International Conference on Computer Vision (ICCV)
1130
+ Online: https://arxiv.org/abs/1905.04899
1131
+ .. [2] https://github.com/clovaai/CutMix-PyTorch/blob/master/train.py
1132
+ """
1133
+
1134
+ operation = staticmethod(cutmix) # type: ignore[assignment]
1135
+
1136
+ def get_augmentation_params(self, *batch):
1137
+ """Return idx_perm and the cut_t_start, cut_t_len of each region."""
1138
+ params = super().get_augmentation_params(*batch)
1139
+ lam = params.pop("lam")
1140
+ n_times = batch[0].shape[-1]
1141
+ half = ((1 - lam) * n_times).long() // 2
1142
+ center = torch.as_tensor(self.rng.randint(n_times, size=len(lam)))
1143
+ center = center.to(lam.device)
1144
+ start = (center - half).clamp(min=0)
1145
+ end = (center + half).clamp(max=n_times)
1146
+ return dict(params, cut_t_start=start, cut_t_len=end - start)
1147
+
1148
+
1098
1149
  class SegmentationReconstruction(Transform):
1099
1150
  """Segmentation Reconstruction from Lotte (2015) [Lotte2015]_.
1100
1151
 
@@ -1283,7 +1334,7 @@ class MaskEncoding(Transform):
1283
1334
  )
1284
1335
 
1285
1336
  time_start = self.rng.randint(
1286
- 0, n_times - segment_length, (batch_size, self.n_segments)
1337
+ 0, n_times - segment_length + 1, (batch_size, self.n_segments)
1287
1338
  )
1288
1339
  time_start = torch.from_numpy(time_start)
1289
1340
 
@@ -1281,6 +1281,49 @@ class WindowsDataset(_ZarrMixin, RecordDataset):
1281
1281
  )
1282
1282
 
1283
1283
 
1284
+ def _lazy_source_files(ds) -> list:
1285
+ """Return the files ``ds`` still reads its signal from (none once preloaded)."""
1286
+ signal = ds.raw if hasattr(ds, "raw") else getattr(ds, "windows", None)
1287
+ if signal is None or getattr(signal, "preload", True):
1288
+ return []
1289
+ files = list(
1290
+ getattr(signal, "filenames", None) or [getattr(signal, "filename", None)]
1291
+ )
1292
+ raw = getattr(signal, "_raw", None)
1293
+ if isinstance(raw, mne.io.BaseRaw) and not raw.preload:
1294
+ files += raw.filenames # mne.Epochs of a lazily read Raw read through it
1295
+ return [f for f in files if f is not None]
1296
+
1297
+
1298
+ def _dir_key(directory):
1299
+ """Identify a directory by device and inode, whatever its spelling."""
1300
+ stat = os.stat(directory)
1301
+ return stat.st_dev, stat.st_ino
1302
+
1303
+
1304
+ def _overwrite_conflicts(datasets, path, offset):
1305
+ """Yield ``(i_ds, i_target, target_dir)`` for each dataset ``i_ds`` that
1306
+ lazily reads from inside ``target_dir = path/<i_target + offset>``, which
1307
+ ``save(overwrite=True)`` deletes before writing dataset ``i_target``.
1308
+ """
1309
+ targets = {}
1310
+ for i in range(len(datasets)):
1311
+ target_dir = os.path.join(path, str(i + offset))
1312
+ if os.path.isdir(target_dir):
1313
+ targets[_dir_key(target_dir)] = (i, target_dir)
1314
+ if not targets:
1315
+ return
1316
+ for i_ds, ds in enumerate(datasets):
1317
+ for file in _lazy_source_files(ds):
1318
+ # ancestors of the name and of the file it links to (DataLad)
1319
+ parents = {
1320
+ *Path(os.path.abspath(file)).parents,
1321
+ *Path(os.path.realpath(file)).parents,
1322
+ }
1323
+ for key in {_dir_key(p) for p in parents if p.is_dir()} & targets.keys():
1324
+ yield (i_ds, *targets[key])
1325
+
1326
+
1284
1327
  @register_dataset
1285
1328
  class BaseConcatDataset(ConcatDataset, HubDatasetMixin, Generic[T]):
1286
1329
  """A base class for concatenated datasets.
@@ -1518,7 +1561,9 @@ class BaseConcatDataset(ConcatDataset, HubDatasetMixin, Generic[T]):
1518
1561
  metadata : pd.DataFrame
1519
1562
  DataFrame containing as many rows as there are windows in the
1520
1563
  BaseConcatDataset, with the metadata and description information
1521
- for each window.
1564
+ for each window, and an ``i_dataset`` column giving the position
1565
+ in ``datasets`` of the dataset (recording) each window comes from.
1566
+ Samplers use it to keep recordings apart.
1522
1567
  """
1523
1568
  if not all(
1524
1569
  [
@@ -1544,9 +1589,15 @@ class BaseConcatDataset(ConcatDataset, HubDatasetMixin, Generic[T]):
1544
1589
  "Dataset descriptions cannot contain the reserved window "
1545
1590
  "metadata key 'i_trial_in_dataset'."
1546
1591
  )
1592
+ if "i_dataset" in df.columns or "i_dataset" in ds.description:
1593
+ raise ValueError(
1594
+ "Window metadata and dataset descriptions cannot contain the "
1595
+ "key 'i_dataset', which get_metadata() reserves for the "
1596
+ "position of the dataset each window comes from. Rename it."
1597
+ )
1547
1598
 
1548
1599
  all_dfs = list()
1549
- for ds in self.datasets:
1600
+ for i_ds, ds in enumerate(self.datasets):
1550
1601
  if hasattr(ds, "_windows") and ds._windows is not None:
1551
1602
  df = ds._windows.metadata
1552
1603
  else:
@@ -1556,6 +1607,7 @@ class BaseConcatDataset(ConcatDataset, HubDatasetMixin, Generic[T]):
1556
1607
  df = df.copy()
1557
1608
  for k, v in ds.description.items():
1558
1609
  df[k] = v
1610
+ df["i_dataset"] = i_ds
1559
1611
  all_dfs.append(df)
1560
1612
 
1561
1613
  return pd.concat(all_dfs)
@@ -1878,7 +1930,9 @@ class BaseConcatDataset(ConcatDataset, HubDatasetMixin, Generic[T]):
1878
1930
  -raw.fif | -epo.fif and .json files to.
1879
1931
  overwrite : bool
1880
1932
  Whether to delete old subdirectories that will be saved to in this
1881
- call.
1933
+ call. If a dataset still reads its data lazily from one of them, a
1934
+ ``ValueError`` is raised before anything is deleted: load the data
1935
+ into memory first (``preload=True``) or save to another directory.
1882
1936
  offset : int
1883
1937
  If provided, the integer is added to the id of the dataset in the
1884
1938
  concat. This is useful in the setting of very large datasets, where
@@ -1891,6 +1945,13 @@ class BaseConcatDataset(ConcatDataset, HubDatasetMixin, Generic[T]):
1891
1945
  hasattr(self.datasets[0], "raw") or hasattr(self.datasets[0], "windows")
1892
1946
  ):
1893
1947
  raise ValueError("dataset should have either raw or windows attribute")
1948
+ if overwrite:
1949
+ for _, _, target_dir in _overwrite_conflicts(self.datasets, path, offset):
1950
+ raise ValueError(
1951
+ f"Saving with overwrite=True would delete {target_dir} while "
1952
+ "a dataset still reads its data from it. Load the data into "
1953
+ "memory first (preload=True) or save to another directory."
1954
+ )
1894
1955
 
1895
1956
  # Create path if it doesn't exist
1896
1957
  os.makedirs(path, exist_ok=True)
@@ -201,12 +201,17 @@ class _EEGNeuralNet(NeuralNet, abc.ABC):
201
201
  if classes is None:
202
202
  classes = getattr(self, "classes", None)
203
203
  signal_kwargs = infer_signal_properties(X, y, mode=self.mode, classes=classes)
204
+ module = _get_model(self.module)
205
+ # Model-specific values computed from the data (e.g. GCNsNet's graph);
206
+ # the signal properties take precedence.
207
+ infer_model_kwargs = getattr(module, "_infer_model_kwargs", None)
208
+ if infer_model_kwargs is not None:
209
+ signal_kwargs = {**infer_model_kwargs(X, y), **signal_kwargs}
204
210
  if not signal_kwargs:
205
211
  return
206
212
 
207
213
  # kick out missing kwargs:
208
214
  module_kwargs = dict()
209
- module = _get_model(self.module)
210
215
  all_module_kwargs = inspect.signature(module.__init__).parameters.keys()
211
216
  for k, v in signal_kwargs.items():
212
217
  if v is None:
@@ -22,6 +22,7 @@ from .deep4 import Deep4Net
22
22
  from .deepsleepnet import DeepSleepNet
23
23
  from .dgcnn import DGCNN
24
24
  from .diver1 import DIVER1
25
+ from .duin import DuIN
25
26
  from .eeg_clip import EEGCLIP
26
27
  from .eegconformer import EEGConformer
27
28
  from .eegdino import EEGDINO
@@ -36,9 +37,11 @@ from .eegsimpleconv import EEGSimpleConv
36
37
  from .eegsym import EEGSym
37
38
  from .eegtcnet import EEGTCNet
38
39
  from .emg2qwerty import EMG2QwertyNet
40
+ from .epint import EpiNT
39
41
  from .fbcnet import FBCNet
40
42
  from .fblightconvnet import FBLightConvNet
41
43
  from .fbmsnet import FBMSNet
44
+ from .gcnsnet import GCNsNet
42
45
  from .guetschel2026 import Guetschel2026
43
46
  from .hybrid import HybridNet
44
47
  from .ifnet import IFNet
@@ -117,6 +120,7 @@ __all__ = [
117
120
  "Deep4Net",
118
121
  "DeepSleepNet",
119
122
  "DIVER1",
123
+ "DuIN",
120
124
  "BrainModule",
121
125
  "Brant",
122
126
  "EEGCLIP",
@@ -134,12 +138,14 @@ __all__ = [
134
138
  "EEGTCNet",
135
139
  "DGCNN",
136
140
  "EMG2QwertyNet",
141
+ "EpiNT",
137
142
  "NeuroPose",
138
143
  "SensingDynamics",
139
144
  "VEMG2Pose",
140
145
  "FBCNet",
141
146
  "FBLightConvNet",
142
147
  "FBMSNet",
148
+ "GCNsNet",
143
149
  "Guetschel2026",
144
150
  "MetaNeuromotorHand",
145
151
  "HybridNet",
@@ -14,6 +14,7 @@ from braindecode.models.base import EEGModuleMixin
14
14
  from braindecode.models.util import extract_channel_locations_from_chs_info
15
15
  from braindecode.modules import GatedLinearUnit, PatchTokenizer
16
16
  from braindecode.modules.attention import _scaled_dot_product_attention
17
+ from braindecode.modules.blocks import _check_on_non_divisible, _patch_count
17
18
 
18
19
 
19
20
  class BaRISTA(EEGModuleMixin, nn.Module, license="other"):
@@ -77,7 +78,8 @@ class BaRISTA(EEGModuleMixin, nn.Module, license="other"):
77
78
  .. rubric:: Temporal, Spatial, and Spectral Encoding
78
79
 
79
80
  - Temporal encoding uses non-overlapping patches and patch-index rotary
80
- embeddings. Samples beyond the last complete patch are dropped.
81
+ embeddings. By default a trailing partial patch is right zero-padded;
82
+ ``on_non_divisible="crop"`` drops it, as the reference does.
81
83
  - Spatial encoding uses dataset-provided coordinate or region indices.
82
84
  ``spatial_scale="none"`` disables it.
83
85
  - The CNN operates on waveforms. There is no explicit spectral transform.
@@ -94,7 +96,8 @@ class BaRISTA(EEGModuleMixin, nn.Module, license="other"):
94
96
  Treebank's coordinate convention.
95
97
 
96
98
  With ``pooling="mean"``, channel counts and window lengths can vary between
97
- batches, provided each window contains a full patch. Pass each recording's
99
+ batches (with ``on_non_divisible="crop"``, provided each window contains a
100
+ full patch). Pass each recording's
98
101
  indices to :meth:`forward`; otherwise it uses the constructor's indices
99
102
  or MNE positions. All samples in one batch
100
103
  share a montage. The encoder uses PyTorch attention on separate batch
@@ -141,9 +144,13 @@ class BaRISTA(EEGModuleMixin, nn.Module, license="other"):
141
144
  in millimetres when deriving indices from ``chs_info``.
142
145
  patch_size : int
143
146
  Number of samples per temporal patch, default 512 (250 ms at the
144
- paper's 2048 Hz). Windows are tokenized into whole patches, so a window
145
- that is not a multiple of ``patch_size`` loses its trailing samples, as
146
- in the reference.
147
+ paper's 2048 Hz).
148
+ on_non_divisible : {"pad", "crop", "error"}, default="pad"
149
+ How :class:`~braindecode.modules.PatchTokenizer` treats a time axis that
150
+ is not a multiple of ``patch_size`` (right zero-pad, crop, or raise).
151
+ The reference implementation crops (``"crop"``: the trailing samples
152
+ are lost); both give the same model and output when ``n_times`` is a
153
+ multiple of ``patch_size``.
147
154
  d_model : int
148
155
  Token embedding dimension.
149
156
  n_layers : int
@@ -180,6 +187,9 @@ class BaRISTA(EEGModuleMixin, nn.Module, license="other"):
180
187
  Systems 38. https://arxiv.org/abs/2512.12135
181
188
  """
182
189
 
190
+ # Configs and checkpoints saved before ``on_non_divisible`` existed cropped.
191
+ _legacy_on_non_divisible = "crop"
192
+
183
193
  def __init__(
184
194
  self,
185
195
  # --- signal-related (handled by EEGModuleMixin) ---
@@ -195,6 +205,7 @@ class BaRISTA(EEGModuleMixin, nn.Module, license="other"):
195
205
  spatial_indices: list[int] | list[list[int]] | None = None,
196
206
  coord_bins: int = 200,
197
207
  patch_size: int = 512,
208
+ on_non_divisible: str = "pad",
198
209
  d_model: int = 64,
199
210
  n_layers: int = 12,
200
211
  num_heads: int = 4,
@@ -243,8 +254,7 @@ class BaRISTA(EEGModuleMixin, nn.Module, license="other"):
243
254
  raise ValueError(f"{name} must be positive, got {value}.")
244
255
  if cnn_depth < 0:
245
256
  raise ValueError(f"cnn_depth must be non-negative, got {cnn_depth}.")
246
- if self.n_times < patch_size:
247
- raise ValueError("n_times must contain at least one full patch.")
257
+ _check_on_non_divisible(on_non_divisible)
248
258
  if d_model % num_heads:
249
259
  raise ValueError(
250
260
  f"d_model ({d_model}) must be divisible by num_heads ({num_heads})."
@@ -258,6 +268,7 @@ class BaRISTA(EEGModuleMixin, nn.Module, license="other"):
258
268
  self.spatial_scale = spatial_scale
259
269
  self.coord_bins = coord_bins
260
270
  self.patch_size = patch_size
271
+ self.on_non_divisible = on_non_divisible
261
272
  self.d_model = d_model
262
273
  self.n_layers = n_layers
263
274
  self.num_heads = num_heads
@@ -266,14 +277,15 @@ class BaRISTA(EEGModuleMixin, nn.Module, license="other"):
266
277
  self.drop_prob = drop_prob
267
278
  self.activation = activation
268
279
 
269
- # The trailing samples are dropped when n_times is not a multiple of
270
- # patch_size, as in the reference.
271
- self.n_patches = self.n_times // patch_size
280
+ # ceil(n_times / patch_size) with "pad"; floor with "crop" (the
281
+ # reference: trailing samples dropped, raises below one patch); exact
282
+ # with "error" (raises otherwise). The learned pooling is sized to it.
283
+ self.n_patches = _patch_count(self.n_times, patch_size, on_non_divisible)
272
284
 
273
285
  self.patch_tokenizer = PatchTokenizer(
274
286
  patch_size=patch_size,
275
287
  n_times=self.n_times,
276
- on_non_divisible="crop",
288
+ on_non_divisible=on_non_divisible,
277
289
  output_order="patch_channel",
278
290
  )
279
291
  # Every (patch, channel) pair is encoded independently, so the grid is
@@ -608,9 +608,24 @@ class EEGModuleMixin(_BaseHubMixin, metaclass=_BraindecodeDocstringMeta):
608
608
  """
609
609
  config = dict(config) # shallow copy
610
610
  config.pop("braindecode_version", None)
611
+ cls._fill_legacy_defaults(config)
611
612
  resolve_type_kwargs(cls, config)
612
613
  return cls(**config)
613
614
 
615
+ @classmethod
616
+ def _fill_legacy_defaults(cls, kwargs: dict) -> None:
617
+ """Rebuild configs saved before ``on_non_divisible`` existed as they were.
618
+
619
+ Models that used to crop a time axis not divisible by their patch size
620
+ set ``_legacy_on_non_divisible = "crop"``. A saved config or checkpoint
621
+ without the ``on_non_divisible`` key then loads with ``"crop"``, so its
622
+ head and position tables keep their shapes; a new model defaults to
623
+ ``"pad"``.
624
+ """
625
+ legacy = getattr(cls, "_legacy_on_non_divisible", None)
626
+ if legacy is not None and "on_non_divisible" not in kwargs:
627
+ kwargs["on_non_divisible"] = legacy
628
+
614
629
  def _set_n_outputs(self, n_outputs: int) -> None:
615
630
  """Record a new ``n_outputs`` on the model and its saved configs.
616
631
 
@@ -911,6 +926,9 @@ class EEGModuleMixin(_BaseHubMixin, metaclass=_BraindecodeDocstringMeta):
911
926
  ):
912
927
  model_kwargs.pop("braindecode_version", None)
913
928
  filename = model_kwargs.pop("filename", None)
929
+ # The Hub mixin passes only the keys of config.json (plus the
930
+ # caller's), so a missing key means a pre-on_non_divisible save.
931
+ cls._fill_legacy_defaults(model_kwargs)
914
932
  resolve_type_kwargs(cls, model_kwargs)
915
933
 
916
934
  # Read saved n_outputs from config.json to detect when the
@@ -13,6 +13,7 @@ from einops.layers.torch import Rearrange, Reduce
13
13
  from braindecode.functional import spectral_input
14
14
  from braindecode.models.base import EEGModuleMixin
15
15
  from braindecode.modules import PatchTokenizer
16
+ from braindecode.modules.blocks import _check_on_non_divisible, _patch_count
16
17
 
17
18
  # Standard rhythmic-activity bands (Hz) used by Brant's frequency encoding,
18
19
  # from the paper (§ Frequency encoding): theta, alpha, beta, gamma1-5.
@@ -96,6 +97,8 @@ class Brant(EEGModuleMixin, nn.Module, license="apache-2.0"):
96
97
  ``return_features=True`` returns ``cls_token=None``. The learned temporal
97
98
  positions require the runtime signal length to equal the configured
98
99
  ``n_times``, and the input must have the configured ``n_chans`` channels.
100
+ A window that is not a multiple of ``patch_size`` is right zero-padded to
101
+ ``ceil(n_times / patch_size)`` patches by default (``on_non_divisible``).
99
102
 
100
103
  The upstream model operates on signals down-sampled to **250 Hz**, but its
101
104
  band-power features are computed at a fixed 256 Hz (upstream
@@ -127,6 +130,11 @@ class Brant(EEGModuleMixin, nn.Module, license="apache-2.0"):
127
130
  patch_size : int, optional
128
131
  Number of time samples per patch fed to the encoders. Default 250
129
132
  (1 s at 250 Hz). The paper's large architecture uses 1500 (see above).
133
+ on_non_divisible : {"pad", "crop", "error"}, default="pad"
134
+ How :class:`~braindecode.modules.PatchTokenizer` treats a time axis that
135
+ is not a multiple of ``patch_size`` (right zero-pad, crop, or raise).
136
+ The reference implementation crops (``"crop"``); both give the same
137
+ model and output when ``n_times`` is a multiple of ``patch_size``.
130
138
  embed_dim : int, optional
131
139
  Model width ``D`` (patch embedding size). Default 256.
132
140
  ffn_dim : int, optional
@@ -156,6 +164,9 @@ class Brant(EEGModuleMixin, nn.Module, license="apache-2.0"):
156
164
  NeurIPS. Code: https://github.com/yzz673/Brant (Apache-2.0).
157
165
  """
158
166
 
167
+ # Configs and checkpoints saved before ``on_non_divisible`` existed cropped.
168
+ _legacy_on_non_divisible = "crop"
169
+
159
170
  def __init__(
160
171
  self,
161
172
  # braindecode parameters
@@ -168,6 +179,7 @@ class Brant(EEGModuleMixin, nn.Module, license="apache-2.0"):
168
179
  *,
169
180
  # model-specific parameters
170
181
  patch_size: int = 250,
182
+ on_non_divisible: str = "pad",
171
183
  embed_dim: int = 256,
172
184
  ffn_dim: int = 384,
173
185
  temporal_n_layers: int = 4,
@@ -192,6 +204,7 @@ class Brant(EEGModuleMixin, nn.Module, license="apache-2.0"):
192
204
  del n_outputs, n_chans, chs_info, n_times, input_window_seconds, sfreq
193
205
 
194
206
  self.patch_size = patch_size
207
+ self.on_non_divisible = on_non_divisible
195
208
  self.embed_dim = embed_dim
196
209
  self.ffn_dim = ffn_dim
197
210
  self.temporal_n_layers = temporal_n_layers
@@ -207,12 +220,10 @@ class Brant(EEGModuleMixin, nn.Module, license="apache-2.0"):
207
220
  )
208
221
  # Number of patches per channel, fixed by the input length. The learnable
209
222
  # temporal positional encoding is sized to it, hence n_times is required.
210
- self.seq_len = self.n_times // self.patch_size
211
- if self.seq_len < 1:
212
- raise ValueError(
213
- f"n_times ({self.n_times}) must be >= patch_size "
214
- f"({self.patch_size}) to form at least one patch."
215
- )
223
+ # ceil for "pad", floor for "crop" (raises below one patch), exact for
224
+ # "error" (raises otherwise): the count the tokenizer produces.
225
+ _check_on_non_divisible(on_non_divisible)
226
+ self.seq_len = _patch_count(self.n_times, self.patch_size, on_non_divisible)
216
227
 
217
228
  # Shared non-overlapping patching (same tokenizer as the other
218
229
  # transformer foundation models); non-learnable, so it is a pure reshape
@@ -222,7 +233,7 @@ class Brant(EEGModuleMixin, nn.Module, license="apache-2.0"):
222
233
  patch_size=self.patch_size,
223
234
  n_times=self.n_times,
224
235
  learnable=False,
225
- on_non_divisible="crop",
236
+ on_non_divisible=on_non_divisible,
226
237
  )
227
238
  # braindecode-native: band-power computed inside forward (see module).
228
239
  self.band_power = _BandPowerFeatures(