Braindecode 1.2.0.dev176281713__tar.gz → 1.2.0.dev180217551__tar.gz

{braindecode-1.2.0.dev176281713/braindecode.egg-info → braindecode-1.2.0.dev180217551}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.2.0.dev176281713
+Version: 1.2.0.dev180217551
 Summary: Deep learning software to decode EEG, ECG or MEG signals
 Author-email: Robin Tibor Schirrmeister <robintibor@gmail.com>
 Maintainer-email: Alexandre Gramfort <agramfort@meta.com>, Bruno Aristimunha Pinto <b.aristimunha@gmail.com>, Robin Tibor Schirrmeister <robintibor@gmail.com>
@@ -49,9 +49,6 @@ Requires-Dist: mypy; extra == "tests"
 Provides-Extra: docs
 Requires-Dist: sphinx_gallery; extra == "docs"
 Requires-Dist: sphinx_rtd_theme; extra == "docs"
-Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
-Requires-Dist: sphinx-autobuild; extra == "docs"
-Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
 Requires-Dist: pydata_sphinx_theme; extra == "docs"
 Requires-Dist: numpydoc; extra == "docs"
 Requires-Dist: memory_profiler; extra == "docs"
@@ -62,7 +59,6 @@ Requires-Dist: lightning; extra == "docs"
 Requires-Dist: seaborn; extra == "docs"
 Requires-Dist: pre-commit; extra == "docs"
 Requires-Dist: openneuro-py; extra == "docs"
-Requires-Dist: plotly; extra == "docs"
 Provides-Extra: all
 Requires-Dist: braindecode[docs,moabb,tests]; extra == "all"
 Dynamic: license-file

{braindecode-1.2.0.dev176281713 → braindecode-1.2.0.dev180217551}/braindecode/models/__init__.py

@@ -15,7 +15,7 @@ from .eeginception_erp import EEGInceptionERP
 from .eeginception_mi import EEGInceptionMI
 from .eegitnet import EEGITNet
 from .eegminer import EEGMiner
-from .eegnet import EEGNetv4
+from .eegnet import EEGNetv1, EEGNetv4
 from .eegnex import EEGNeX
 from .eegresnet import EEGResNet
 from .eegsimpleconv import EEGSimpleConv
@@ -65,6 +65,7 @@ __all__ = [
     "EEGInceptionMI",
     "EEGITNet",
     "EEGMiner",
+    "EEGNetv1",
     "EEGNetv4",
     "EEGNeX",
     "EEGResNet",

{braindecode-1.2.0.dev176281713 → braindecode-1.2.0.dev180217551}/braindecode/models/attentionbasenet.py

@@ -24,7 +24,7 @@ from braindecode.modules.attention import (
 
 
 class AttentionBaseNet(EEGModuleMixin, nn.Module):
-    """AttentionBaseNet from Wimpff M et al. (2023) [Martin2023]_.
+    """
 
     :bdg-success:`Convolution` :bdg-info:`Small Attention`
 
@@ -165,11 +165,10 @@ class AttentionBaseNet(EEGModuleMixin, nn.Module):
     Notes
     -----
     - Sequence length after each stage is computed internally; the final classifier expects
-      a flattened ``ch_dim x T₂`` vector.
+    a flattened ``ch_dim x T₂`` vector.
     - Attention operates on *channel* dimension by design; temporal gating exists only in
-      specific variants (CBAM/CAT).
-    - The paper and original code with more details about the methodological
-      choices are available at the [Martin2023]_ and [MartinCode]_.
+    specific variants (CBAM/CAT).
+
     .. versionadded:: 0.9
 
     Parameters

{braindecode-1.2.0.dev176281713 → braindecode-1.2.0.dev180217551}/braindecode/models/eegnex.py

@@ -129,8 +129,7 @@ class EEGNeX(EEGModuleMixin, nn.Module):
     -----
     - The braindecode implementation follows the paper's conv-only design with five blocks
       and reproduces the depthwise spatial step and dilated temporal stack. See the class
-      reference for exact kernel sizes, dilations, and pooling defaults. You can check the
-      original implementation at [EEGNexCode]_.
+      reference for exact kernel sizes, dilations, and pooling defaults.
 
     .. versionadded:: 1.1
 
@@ -160,6 +159,12 @@ class EEGNeX(EEGModuleMixin, nn.Module):
     avg_pool_block5 : tuple[int, int], optional
         Pooling size for block 5. Default is (1, 8).
 
+    Notes
+    -----
+    This implementation is not guaranteed to be correct, has not been checked
+    by original authors, only reimplemented from the paper description and
+    source code in tensorflow [EEGNexCode]_.
+
     References
     ----------
     .. [eegnex] Chen, X., Teng, X., Chen, H., Pan, Y., & Geyer, P. (2024).

{braindecode-1.2.0.dev176281713 → braindecode-1.2.0.dev180217551}/braindecode/models/summary.csv

@@ -1,40 +1,41 @@
-Model,Paradigm,Type,Freq(Hz),Hyperparameters,#Parameters,get_#Parameters,Categorization
-ATCNet,General,Classification,250,"n_chans, n_outputs, n_times",113732,"ATCNet(n_chans=22, n_outputs=4, n_times=1000)","Convolution,Recurrent,Small Attention"
-AttentionBaseNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times",3692,"AttentionBaseNet(n_chans=22, n_outputs=4, n_times=1000)","Convolution,Small Attention"
-BDTCN,Normal Abnormal,Classification,100,"n_chans, n_outputs, n_times",456502,"BDTCN(n_chans=21, n_outputs=2, n_times=6000, n_blocks=5, n_filters=55, kernel_size=16)","Convolution,Recurrent"
-BIOT,"Sleep Staging, Epilepsy",Classification,200,"n_chans, n_outputs",3183879,"BIOT(n_chans=2,  n_outputs=5,  n_times=6000)","Large Language Model"
-ContraWR,Sleep Staging,"Classification, Embedding",125,"n_chans, n_outputs, sfreq",1160165,"ContraWR(n_chans=2, n_outputs=5, n_times=3750, emb_size=256, sfreq=125)",Convolution
-CTNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times",26900,"CTNet(n_chans=22, n_outputs=4, n_times=1000, n_filters_time=8, kernel_size=16, heads=2, emb_size=16)","Convolution,Small Attention"
-Deep4Net,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times",282879,"Deep4Net(n_chans=22, n_outputs=4, n_times=1000)","Convolution"
-DeepSleepNet,Sleep Staging,Classification,256,"n_chans, n_outputs",24744837,"DeepSleepNet(n_chans=1, n_outputs=5, n_times=7680, sfreq=256)","Convolution"
-EEGConformer,General,Classification,250,"n_chans, n_outputs, n_times",789572,"EEGConformer(n_chans=22, n_outputs=4, n_times=1000)","Convolution,Small Attention"
-EEGInceptionERP,"ERP, SSVEP",Classification,128,"n_chans, n_outputs",14926,"EEGInceptionERP(n_chans=8, n_outputs=2, n_times=128, sfreq=128)","Convolution"
-EEGInceptionMI,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times",558028,"EEGInceptionMI(n_chans=22, n_outputs=4, n_times=1000, n_convs=5, n_filters=12)","Convolution"
-EEGITNet,Motor Imagery,Classification,125,"n_chans, n_outputs, n_times",5212,"EEGITNet(n_chans=22,  n_outputs=4,  n_times=500)","Convolution,Recurrent"
-EEGNetv4,General,Classification,128,"n_chans, n_outputs, n_times",2484,"EEGNetv4(n_chans=22,  n_outputs=4,  n_times=512)","Convolution"
-EEGNeX,Motor Imagery,Classification,125,"n_chans, n_outputs, n_times",55940,"EEGNeX(n_chans=22,  n_outputs=4,  n_times=500)","Convolution"
-EEGMiner,Emotion Recognition,Classification,128,"n_chans, n_outputs, n_times, sfreq",7572,"EEGMiner(n_chans=62, n_outputs=2, n_times=2560, sfreq=128)","Convolution"
-EEGResNet,General,Classification,250,"n_chans, n_outputs, n_times",247484,"EEGResNet(n_chans=22,  n_outputs=4,  n_times=1000)","Interpretability"
-EEGSimpleConv,Motor Imagery,Classification,80,"n_chans, n_outputs, sfreq",730404,"EEGSimpleConv(n_chans=22,  n_outputs=4,  n_times=320, sfreq=80)","Convolution"
-EEGTCNet,Motor Imagery,Classification,250,"n_chans, n_outputs",4516,"EEGTCNet(n_chans=22,  n_outputs=4,  n_times=1000, kern_length=32)","Convolution,Recurrent"
-Labram,General,"Classification, Embedding",200,"n_chans, n_outputs, n_times",5866180,"Labram(n_chans=22, n_outputs=4, n_times=1000, sfreq=250)","Convolution,Large Language Model"
-MSVTNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times",75494," MSVTNet(n_chans=22,  n_outputs=4,  n_times=1000)","Convolution,Recurrent,Small Attention"
-SCCNet,Motor Imagery,Classification,125,"n_chans, n_outputs, n_times, sfreq",12070,"SCCNet(n_chans=22,  n_outputs=4,  n_times=1000, sfreq=125)","Convolution"
-SignalJEPA,"Motor Imagery, ERP, SSVEP",Embedding,128,"n_times, chs_info",3456882,"SignalJEPA(n_times=512, chs_info=Lee2019_MI().get_data(subjects=[1])[1]['0']['1train'].info[""chs""][:62])","Convolution,Channel,Large Language Model"
-SignalJEPA_Contextual,"Motor Imagery, ERP, SSVEP",Classification,128,"n_outputs, n_times, chs_info",3459184,"SignalJEPA_Contextual(n_outputs=2, input_window_seconds=4.19, sfreq=128, chs_info=Lee2019_MI().get_data(subjects=[1])[1]['0']['1train'].info[""chs""][:62])","Convolution,Channel,Large Language Model"
-SignalJEPA_PostLocal,"Motor Imagery, ERP, SSVEP",Classification,128,"n_chans, n_outputs, n_times",16142,"SignalJEPA_PostLocal(n_chans=62, n_outputs=2, input_window_seconds=4.19, sfreq=128)","Convolution,Channel,Large Language Model"
-SignalJEPA_PreLocal,"Motor Imagery, ERP, SSVEP",Classification,128,"n_outputs, n_times, chs_info",16142,"SignalJEPA_PreLocal(n_chans=62, n_outputs=2, input_window_seconds=4.19, sfreq=128)","Convolution,Channel,Large Language Model"
-SincShallowNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times, sfreq",21892,"SincShallowNet(n_chans=22,  n_outputs=4,  n_times=1000, sfreq=250)","Convolution,Interpretability"
-ShallowFBCSPNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times",46084,"ShallowFBCSPNet(n_chans=22,  n_outputs=4,  n_times=1000, sfreq=250)","Convolution"
-SleepStagerBlanco2020,Sleep Staging,Classification,100,"n_chans, n_outputs, n_times",2845,"SleepStagerBlanco2020(n_chans=2, n_outputs=5, n_times=3000, sfreq=100)","Convolution"
-SleepStagerChambon2018,Sleep Staging,Classification,128,"n_chans, n_outputs, n_times, sfreq",5835,"SleepStagerChambon2018(n_chans=2, n_outputs=5, n_times=3840, sfreq=128)","Convolution"
-SleepStagerEldele2021,Sleep Staging,Classification,100,"n_chans, n_outputs, n_times, sfreq",719925,"SleepStagerEldele2021(n_chans=2, n_outputs=5, n_times=3000, sfreq=100)","Convolution, Small Attention"
-SPARCNet,Epilepsy,Classification,200,"n_chans, n_outputs, n_times",1141921,"SPARCNet(n_chans=16, n_outputs=6, n_times=2000, sfreq=200)","Convolution"
-SyncNet,"Emotion Recognition, Alcoholism",Classification,256,"n_chans, n_outputs, n_times",554,"SyncNet(n_chans=62, n_outputs=3, n_times=5120, sfreq=256)","Interpretability"
-TSceptionV1,Emotion Recognition,Classification,256,"n_chans, n_outputs, n_times, sfreq",2187206,"TSceptionV1(n_chans=62, n_outputs=3, n_times=5120, sfreq=256)","Convolution"
-TIDNet,General,Classification,250,"n_chans, n_outputs, n_times",240404,"TIDNet(n_chans=22,  n_outputs=4,  n_times=1000)","Convolution"
-USleep,Sleep Staging,Classification,128,"n_chans, n_outputs, n_times, sfreq",2482011,"USleep(n_chans=2, n_outputs=5, n_times=3000, sfreq=100)","Convolution"
-FBCNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times, sfreq",11812,"FCNet(n_chans=22, n_outputs=4, n_times=1000, sfreq=250)","Convolution,FilterBank"
-FBMSNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times, sfreq",16231,"FBMSNet(n_chans=22, n_outputs=4, n_times=1000, sfreq=250)","Convolution,FilterBank"
-FBLightConvNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times, sfreq",6596,"FBLightConvNet(n_chans=22, n_outputs=4, n_times=1000, sfreq=250)","Convolution,FilterBank"
-IFNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times, sfreq",9860,"IFNet(n_chans=22, n_outputs=4, n_times=1000, sfreq=250)","Convolution,FilterBank"
+Model,Paradigm,Type,Freq(Hz),Hyperparameters,#Parameters,get_#Parameters
+ATCNet,General,Classification,250,"n_chans, n_outputs, n_times",113732,"ATCNet(n_chans=22, n_outputs=4, n_times=1000)"
+AttentionBaseNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times",3692,"AttentionBaseNet(n_chans=22, n_outputs=4, n_times=1000)"
+BDTCN,Normal/Abnormal,Classification,100,"n_chans, n_outputs, n_times",456502,"BDTCN(n_chans=21, n_outputs=2, n_times=6000, n_blocks=5, n_filters=55, kernel_size=16)"
+BIOT,"Sleep Staging, Epilepsy",Classification,200,"n_chans, n_outputs",3183879,"BIOT(n_chans=2,  n_outputs=5,  n_times=6000)"
+ContraWR,Sleep Staging,"Classification, Embedding",125,"n_chans, n_outputs, sfreq",1160165,"ContraWR(n_chans=2, n_outputs=5, n_times=3750, emb_size=256, sfreq=125)"
+CTNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times",26900,"CTNet(n_chans=22, n_outputs=4, n_times=1000, n_filters_time=8, kernel_size=16, heads=2, emb_size=16)"
+Deep4Net,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times",282879,"Deep4Net(n_chans=22, n_outputs=4, n_times=1000)"
+DeepSleepNet,Sleep Staging,Classification,256,"n_chans, n_outputs",24744837,"DeepSleepNet(n_chans=1, n_outputs=5, n_times=7680, sfreq=256)"
+EEGConformer,General,Classification,250,"n_chans, n_outputs, n_times",789572,"EEGConformer(n_chans=22, n_outputs=4, n_times=1000)."
+EEGInceptionERP,"ERP, SSVEP",Classification,128,"n_chans, n_outputs",14926,"EEGInceptionERP(n_chans=8, n_outputs=2, n_times=128, sfreq=128)"
+EEGInceptionMI,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times",558028,"EEGInceptionMI(n_chans=22, n_outputs=4, n_times=1000, n_convs=5, n_filters=12)"
+EEGITNet,Motor Imagery,Classification,125,"n_chans, n_outputs, n_times",5212,"EEGITNet(n_chans=22,  n_outputs=4,  n_times=500)"
+EEGNetv1,General,Classification,128,"n_chans, n_outputs, n_times",3052,"EEGNetv1(n_chans=22,  n_outputs=4,  n_times=512)"
+EEGNetv4,General,Classification,128,"n_chans, n_outputs, n_times",2484,"EEGNetv4(n_chans=22,  n_outputs=4,  n_times=512)"
+EEGNeX,Motor Imagery,Classification,125,"n_chans, n_outputs, n_times",55940,"EEGNeX(n_chans=22,  n_outputs=4,  n_times=500)"
+EEGMiner,Emotion Recognition,Classification,128,"n_chans, n_outputs, n_times, sfreq",7572,"EEGMiner(n_chans=62, n_outputs=2, n_times=2560, sfreq=128)"
+EEGResNet,General,Classification,250,"n_chans, n_outputs, n_times",247484,"EEGResNet(n_chans=22,  n_outputs=4,  n_times=1000)"
+EEGSimpleConv,Motor Imagery,Classification,80,"n_chans, n_outputs, sfreq",730404,"EEGSimpleConv(n_chans=22,  n_outputs=4,  n_times=320, sfreq=80)"
+EEGTCNet,Motor Imagery,Classification,250,"n_chans, n_outputs",4516,"EEGTCNet(n_chans=22,  n_outputs=4,  n_times=1000, kern_length=32)"
+Labram,General,"Classification, Embedding",200,"n_chans, n_outputs, n_times",5866180,"Labram(n_chans=22, n_outputs=4, n_times=1000, sfreq=250)"
+MSVTNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times",75494," MSVTNet(n_chans=22,  n_outputs=4,  n_times=1000)"
+SCCNet,Motor Imagery,Classification,125,"n_chans, n_outputs, n_times, sfreq",12070,"SCCNet(n_chans=22,  n_outputs=4,  n_times=1000, sfreq=125)"
+SignalJEPA,"Motor Imagery, ERP, SSVEP",Embedding,128,"n_times, chs_info",3456882,"SignalJEPA(n_times=512, chs_info=Lee2019_MI().get_data(subjects=[1])[1]['0']['1train'].info[""chs""][:62])"
+SignalJEPA_Contextual,"Motor Imagery, ERP, SSVEP",Classification,128,"n_outputs, n_times, chs_info",3459184,"SignalJEPA_Contextual(n_outputs=2, input_window_seconds=4.19, sfreq=128, chs_info=Lee2019_MI().get_data(subjects=[1])[1]['0']['1train'].info[""chs""][:62])"
+SignalJEPA_PostLocal,"Motor Imagery, ERP, SSVEP",Classification,128,"n_chans, n_outputs, n_times",16142,"SignalJEPA_PostLocal(n_chans=62, n_outputs=2, input_window_seconds=4.19, sfreq=128)"
+SignalJEPA_PreLocal,"Motor Imagery, ERP, SSVEP",Classification,128,"n_outputs, n_times, chs_info",16142,"SignalJEPA_PreLocal(n_chans=62, n_outputs=2, input_window_seconds=4.19, sfreq=128)"
+SincShallowNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times, sfreq",21892,"SincShallowNet(n_chans=22,  n_outputs=4,  n_times=1000, sfreq=250)"
+ShallowFBCSPNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times",46084,"ShallowFBCSPNet(n_chans=22,  n_outputs=4,  n_times=1000, sfreq=250)"
+SleepStagerBlanco2020,Sleep Staging,Classification,100,"n_chans, n_outputs, n_times",2845,"SleepStagerBlanco2020(n_chans=2, n_outputs=5, n_times=3000, sfreq=100)"
+SleepStagerChambon2018,Sleep Staging,Classification,128,"n_chans, n_outputs, n_times, sfreq",5835,"SleepStagerChambon2018(n_chans=2, n_outputs=5, n_times=3840, sfreq=128)"
+SleepStagerEldele2021,Sleep Staging,Classification,100,"n_chans, n_outputs, n_times, sfreq",719925,"SleepStagerEldele2021(n_chans=2, n_outputs=5, n_times=3000, sfreq=100)"
+SPARCNet,Epilepsy,Classification,200,"n_chans, n_outputs, n_times",1141921,"SPARCNet(n_chans=16, n_outputs=6, n_times=2000, sfreq=200)"
+SyncNet,"Emotion Recognition, Alcoholism",Classification,256,"n_chans, n_outputs, n_times",554,"SyncNet(n_chans=62, n_outputs=3, n_times=5120, sfreq=256)"
+TSceptionV1,Emotion Recognition,Classification,256,"n_chans, n_outputs, n_times, sfreq",2187206,"TSceptionV1(n_chans=62, n_outputs=3, n_times=5120, sfreq=256)"
+TIDNet,General,Classification,250,"n_chans, n_outputs, n_times",240404,"TIDNet(n_chans=22,  n_outputs=4,  n_times=1000)"
+USleep,Sleep Staging,Classification,128,"n_chans, n_outputs, n_times, sfreq",2482011,"USleep(n_chans=2, n_outputs=5, n_times=3000, sfreq=100)"
+FBCNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times, sfreq",11812,"FCNet(n_chans=22, n_outputs=4, n_times=1000, sfreq=250)"
+FBMSNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times, sfreq",16231,"FBMSNet(n_chans=22, n_outputs=4, n_times=1000, sfreq=250)"
+FBLightConvNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times, sfreq",6596,"FBLightConvNet(n_chans=22, n_outputs=4, n_times=1000, sfreq=250)"
+IFNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times, sfreq",9860,"IFNet(n_chans=22, n_outputs=4, n_times=1000, sfreq=250)"

{braindecode-1.2.0.dev176281713 → braindecode-1.2.0.dev180217551}/braindecode/models/util.py

@@ -55,6 +55,7 @@ models_mandatory_parameters = [
     ("EEGInceptionERP", ["n_chans", "n_outputs", "n_times", "sfreq"], None),
     ("EEGInceptionMI", ["n_chans", "n_outputs", "n_times", "sfreq"], None),
     ("EEGITNet", ["n_chans", "n_outputs", "n_times"], None),
+    ("EEGNetv1", ["n_chans", "n_outputs", "n_times"], None),
     ("EEGNetv4", ["n_chans", "n_outputs", "n_times"], None),
     ("EEGResNet", ["n_chans", "n_outputs", "n_times"], None),
     ("ShallowFBCSPNet", ["n_chans", "n_outputs", "n_times"], None),

braindecode-1.2.0.dev180217551/braindecode/version.py

@@ -0,0 +1 @@
+__version__ = "1.2.0.dev180217551"

{braindecode-1.2.0.dev176281713 → braindecode-1.2.0.dev180217551/braindecode.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.2.0.dev176281713
+Version: 1.2.0.dev180217551
 Summary: Deep learning software to decode EEG, ECG or MEG signals
 Author-email: Robin Tibor Schirrmeister <robintibor@gmail.com>
 Maintainer-email: Alexandre Gramfort <agramfort@meta.com>, Bruno Aristimunha Pinto <b.aristimunha@gmail.com>, Robin Tibor Schirrmeister <robintibor@gmail.com>
@@ -49,9 +49,6 @@ Requires-Dist: mypy; extra == "tests"
 Provides-Extra: docs
 Requires-Dist: sphinx_gallery; extra == "docs"
 Requires-Dist: sphinx_rtd_theme; extra == "docs"
-Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
-Requires-Dist: sphinx-autobuild; extra == "docs"
-Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
 Requires-Dist: pydata_sphinx_theme; extra == "docs"
 Requires-Dist: numpydoc; extra == "docs"
 Requires-Dist: memory_profiler; extra == "docs"
@@ -62,7 +59,6 @@ Requires-Dist: lightning; extra == "docs"
 Requires-Dist: seaborn; extra == "docs"
 Requires-Dist: pre-commit; extra == "docs"
 Requires-Dist: openneuro-py; extra == "docs"
-Requires-Dist: plotly; extra == "docs"
 Provides-Extra: all
 Requires-Dist: braindecode[docs,moabb,tests]; extra == "all"
 Dynamic: license-file

{braindecode-1.2.0.dev176281713 → braindecode-1.2.0.dev180217551}/braindecode.egg-info/SOURCES.txt

@@ -24,7 +24,6 @@ braindecode/datasets/base.py
 braindecode/datasets/bbci.py
 braindecode/datasets/bcicomp.py
 braindecode/datasets/bids.py
-braindecode/datasets/experimental.py
 braindecode/datasets/mne.py
 braindecode/datasets/moabb.py
 braindecode/datasets/nmt.py
@@ -111,14 +110,11 @@ docs/cite.rst
 docs/conf.py
 docs/help.rst
 docs/index.rst
+docs/models_summary.rst
 docs/sg_execution_times.rst
 docs/whats_new.rst
 docs/_templates/autosummary/class.rst
 docs/_templates/autosummary/function.rst
 docs/install/install.rst
 docs/install/install_pip.rst
-docs/install/install_source.rst
-docs/models/models.rst
-docs/models/models_categorization.rst
-docs/models/models_table.rst
-docs/models/models_visualization.rst
+docs/install/install_source.rst

{braindecode-1.2.0.dev176281713 → braindecode-1.2.0.dev180217551}/braindecode.egg-info/requires.txt

@@ -22,9 +22,6 @@ braindecode[docs,moabb,tests]
 [docs]
 sphinx_gallery
 sphinx_rtd_theme
-sphinx-autodoc-typehints
-sphinx-autobuild
-sphinxcontrib-bibtex
 pydata_sphinx_theme
 numpydoc
 memory_profiler
@@ -35,7 +32,6 @@ lightning
 seaborn
 pre-commit
 openneuro-py
-plotly
 
 [moabb]
 moabb>=1.2.0

{braindecode-1.2.0.dev176281713 → braindecode-1.2.0.dev180217551}/docs/api.rst

@@ -19,12 +19,12 @@ Model zoo availables in braindecode. The models are implemented as
 All the models have the convention of having the signal related parameters
 named the same way, following the braindecode's standards:
 
-+ :fa:`shapes`\  ``n_outputs``: Number of labels or outputs of the model.
-+ :fa:`wave-square`\  ``n_chans``: Number of EEG channels.
-+ :fa:`clock`\  ``n_times``: Number of time points of the input window.
-+ :fa:`wifi`\  ``sfreq``: Sampling frequency of the EEG recordings.
-+ (:fa:`clock`\ / :fa:`wifi`\)  ``input_window_seconds``: Length of the input window in seconds.
-+ :fa:`info-circle`\  ``chs_info``: Information about each individual EEG channel. Refer to :class:`mne.Info["chs"]`.
++ ``n_outputs``: Number of labels or outputs of the model.
++ ``n_chans``: Number of EEG channels.
++ ``n_times``: Number of time points of the input window.
++ ``input_window_seconds``: Length of the input window in seconds.
++ ``sfreq``: Sampling frequency of the EEG recordings.
++ ``chs_info``: Information about each individual EEG channel. Refer to :class:`mne.Info["chs"]`.
 
 All the models assume that the input data is a 3D tensor of shape
 ``(batch_size, n_chans, n_times)``, and some models also accept a 4D tensor of shape
@@ -65,6 +65,7 @@ provides a common interface for all EEG models and derivate variables names if n
     EEGInceptionMI
     EEGITNet
     EEGMiner
+    EEGNetv1
     EEGNetv4
     EEGNeX
     EEGResNet

{braindecode-1.2.0.dev176281713 → braindecode-1.2.0.dev180217551}/docs/conf.py

@@ -42,10 +42,6 @@ curdir = os.path.dirname(__file__)
 sys.path.append(os.path.abspath(os.path.join(curdir, "..", "braindecode")))
 sys.path.append(os.path.abspath(os.path.join(curdir, "sphinxext")))
 
-import sphinx_design
-
-print(f"--- Sphinx is using sphinx_design version: {sphinx_design.__version__} ---")
-
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
@@ -59,9 +55,7 @@ extensions = [
     "sphinx.ext.ifconfig",
     "sphinx.ext.intersphinx",
     "sphinx.ext.githubpages",
-    "sphinxcontrib.bibtex",
     "sphinx.ext.napoleon",
-    "sphinx_autodoc_typehints",
     "sphinx_gallery.gen_gallery",
     "sphinx.ext.linkcode",
     "sphinx_design",
@@ -172,15 +166,15 @@ templates_path = ["_templates"]
 # source_suffix = ['.rst', '.md']
 source_suffix = ".rst"
 
-
+rst_prolog = """
+.. role:: tag(bdg-success)
+"""
 # The master toctree document.
 master_doc = "index"
 
 # General information about the project.
 
-bibtex_bibfiles = ["references.bib"]
-bibtex_reference_style = "author_year"
-bibtex_default_style = "unsrt"
+
 # -- Project information -----------------------------------------------------
 
 project = "Braindecode"
@@ -362,6 +356,7 @@ html_context = {
 }
 
 html_sidebars = {
+    "models_summary": [],
     "cite": [],
     "help": [],
     "whats_new": [],
@@ -396,7 +391,7 @@ latex_documents = [
         master_doc,
         "Braindecode.tex",
         "Braindecode",
-        "Bruno Aristimunha",
+        "Robin Tibor Schirrmeister",
         "manual",
     ),
 ]
@@ -435,16 +430,6 @@ other_icons = (
     "cloud-download-alt",
     "wrench",
     "hourglass",
-    # Add your new icons here
-    "braille",
-    "repeat",
-    "lightbulb",
-    "layer-group",
-    "eye",
-    "circle-nodes",
-    "magnifying-glass-chart",
-    "share-nodes",
-    "clone",
 )
 icons = dict()
 for icon in brand_icons + fixed_icons + other_icons:
@@ -472,7 +457,7 @@ prolog += """
 prolog += """
 .. |ensp| unicode:: U+2002 .. EN SPACE
 """
-rst_prolog = prolog
+
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples

{braindecode-1.2.0.dev176281713 → braindecode-1.2.0.dev180217551}/docs/index.rst

@@ -42,7 +42,7 @@ Braindecode Homepage
    :hidden:
 
    Install <install/install>
-   Models <models/models>
+   Models <models_summary>
    Cite <cite>
    Tutorial and Examples <auto_examples/index>
    API <api>

braindecode-1.2.0.dev180217551/docs/models_summary.rst

@@ -0,0 +1,134 @@
+.. raw:: html
+
+   <style>
+    .tag {
+      display: inline-block;
+      background-color: #e0f7fa;
+      color: #00796b;
+      padding: 4px 8px;
+      margin: 2px;
+      border-radius: 4px;
+      font-size: 0.9em;
+    }
+   </style>
+   <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
+   <link rel="stylesheet" type="text/css" href="https://cdn.datatables.net/v/bm/dt-1.13.4/datatables.min.css"/>
+
+.. _models-summary:
+
+Models Summary
+~~~~~~~~~~~~~~
+
+This page offers a summary of many implemented models. Please note that this list may not be exhaustive. For the definitive and most current list, including detailed class documentation, please consult the :doc:`API documentation <api>`.
+
+We are continually expanding this collection and welcome contributions! If you have implemented a model relevant to EEG, EcoG, or MEG analysis, consider adding it to Braindecode. See the "Submit a New Model" section below for details.
+
+.. figure:: _static/model/models_analysis.png
+   :alt: Braindecode Models
+   :align: center
+
+   Visualization comparing the models based on their total number of parameters (left plot) and the primary experimental paradigm they were designed for (right plot).
+
+Columns definitions:
+    - **Model**: The name of the model.
+    - **Paradigm**: The paradigm(s) the model is typically used for (e.g., Motor Imagery, P300, Sleep Staging). 'General' indicates applicability across multiple paradigms or no specific paradigm focus.
+    - **Type**: The model's primary function (e.g., Classification, Regression, Embedding).
+    - **Freq (Hz)**: The data sampling rate (in Hertz) the model is designed for. Note that this might be adaptable depending on the specific dataset and application.
+    - **Hyperparameters**: The mandatory hyperparameters required for instantiating the model class. These may include `n_chans` (number of channels), `n_outputs` (number of output classes or regression targets), `n_times` (number of time points in the input window), or `sfreq` (sampling frequency). Also, `n_times` can be derived implicitly by providing both `sfreq` and `input_window_seconds`.
+    - **#Parameters**: The approximate total number of trainable parameters in the model, calculated using a consistent configuration (see note below).
+
+.. raw:: html
+
+   <!-- Dropdown filter container -->
+   <div id="custom-filters" style="margin-bottom: 15px;"></div>
+
+.. raw:: html
+   :file: generated/models_summary_table.html
+
+The parameter counts shown in the table were calculated using consistent hyperparameters for models within the same paradigm, based largely on Braindecode's default implementation values. These counts provide a relative comparison but may differ from those reported in the original publications due to variations in specific architectural details, input dimensions used in the paper, or calculation methods.
+
+Submit a new model
+~~~~~~~~~~~~~~~~~~
+
+Want to contribute a new model to Braindecode? Great! You can propose a new model by opening an `issue <braindecode-issues_>`_ (please include a link to the relevant publication or description) or, even better, directly submit your implementation via a `pull request <braindecode-pulls_>`_. We appreciate your contributions to expanding the library!
+
+.. raw:: html
+
+   <script type="text/javascript" src="https://cdn.datatables.net/v/bm/dt-1.13.4/datatables.min.js"></script>
+   <script type="text/javascript">
+    $(document).ready(function () {
+      var table = $('.sortable').DataTable({
+        paging: false,
+        searching: true,
+        info: false,
+        language: {
+          search: "Filter models:"
+        }
+      });
+
+      var filterColumns = {
+        1: "Select Paradigm",
+        2: "Choose Model Type",
+        4: "Select Required Hyperparameter"
+      };
+
+      var $filterContainer = $('#custom-filters');
+      var dropdowns = {};
+
+      $.each(filterColumns, function (colIdx, label) {
+        var select = $('<select><option value="" disabled selected>' + label + '</option></select>')
+          .css({ 'margin-right': '10px', 'padding': '5px', 'margin-bottom': '10px' });
+
+        var uniqueTags = new Set();
+
+        table.column(colIdx).data().each(function (d) {
+          if (d) {
+            var tags = [];
+            var $temp = $('<div>' + d + '</div>');
+            var $foundTags = $temp.find('.tag');
+
+            if ($foundTags.length > 0) {
+              $foundTags.each(function () {
+                var tag = $(this).text().trim();
+                if (tag) tags.push(tag);
+              });
+            } else {
+              var plainText = $temp.text();
+              tags = plainText.split(/,\s*|\s+/).map(function (tag) {
+                return tag.trim();
+              });
+            }
+
+            tags.forEach(function (tag) {
+              if (tag) uniqueTags.add(tag);
+            });
+          }
+        });
+
+        Array.from(uniqueTags).sort().forEach(function (tag) {
+          select.append('<option value="' + tag + '">' + tag + '</option>');
+        });
+
+        select.on('change', function () {
+          var val = $(this).val();
+          table.column(colIdx).search(val ? val : '', true, false).draw();
+        });
+
+        dropdowns[colIdx] = select;
+        $filterContainer.append(select);
+      });
+
+      var clearBtn = $('<button>Clear Filters</button>')
+        .css({ 'margin-left': '10px', 'padding': '5px 10px', 'cursor': 'pointer' })
+        .on('click', function () {
+          $.each(dropdowns, function (colIdx, select) {
+            select.prop('selectedIndex', 0);
+            table.column(colIdx).search('').draw();
+          });
+        });
+
+      $filterContainer.append(clearBtn);
+    });
+   </script>
+
+.. include:: links.inc

{braindecode-1.2.0.dev176281713 → braindecode-1.2.0.dev180217551}/docs/whats_new.rst

@@ -24,11 +24,9 @@ Enhancements
 ~~~~~~~~~~~~
 - Improving the docstring for :class:`braindecode.models.EEGNetv4`  (:gh:`768` by `Bruno Aristimunha`_)
 - Improving the docstring for :class:`braindecode.models.EEGConformer`  (:gh:`769` by `Bruno Aristimunha`_)
-- Experimental BIDS Iterable Dataset support (:gh:`766` by `Bruno Aristimunha`_ and `Pierre Guetschel`_)
 - Improving the docstring for :class:`braindecode.models.ATCNet`  (:gh:`771` by `Bruno Aristimunha`_)
 - Improving the docstring for :class:`braindecode.models.AttentionBaseNet`  (:gh:`772` by `Bruno Aristimunha`_)
 - Improving the docstring for :class:`braindecode.models.EEGNeX`  (:gh:`773` by `Bruno Aristimunha`_)
-- Massive refactor of the models webpage (:gh:`774` by `Bruno Aristimunha`_)
 
 
 API changes
@@ -43,7 +41,6 @@ Current 1.1.1 (stable)
 
 Enhancements
 ~~~~~~~~~~~~
-- Massive refactor of the model webpage
 
 API changes
 ~~~~~~~~~~~

{braindecode-1.2.0.dev176281713 → braindecode-1.2.0.dev180217551}/pyproject.toml

@@ -75,9 +75,6 @@ tests = [
 docs = [
     'sphinx_gallery',
     'sphinx_rtd_theme',
-    'sphinx-autodoc-typehints',
-    'sphinx-autobuild',
-    'sphinxcontrib-bibtex',
     'pydata_sphinx_theme',
     'numpydoc',
     'memory_profiler',
@@ -87,8 +84,7 @@ docs = [
     'lightning',
     'seaborn',
     'pre-commit',
-    'openneuro-py',
-    'plotly',
+    'openneuro-py'
 ]
 all = [
     "braindecode[moabb,tests,docs]"