Braindecode 1.3.0.dev176122045__tar.gz → 1.3.0.dev176481332__tar.gz

{braindecode-1.3.0.dev176122045/braindecode.egg-info → braindecode-1.3.0.dev176481332}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.3.0.dev176122045
+Version: 1.3.0.dev176481332
 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>

{braindecode-1.3.0.dev176122045 → braindecode-1.3.0.dev176481332}/braindecode/datasets/__init__.py

@@ -12,7 +12,7 @@ from .base import (
 from .bcicomp import BCICompetitionIVDataset4
 from .bids import BIDSDataset, BIDSEpochsDataset
 from .mne import create_from_mne_epochs, create_from_mne_raw
-from .moabb import BNCI2014_001, HGD, MOABBDataset
+from .moabb import BNCI2014001, HGD, MOABBDataset
 from .nmt import NMT
 from .sleep_physio_challe_18 import SleepPhysionetChallenge2018
 from .sleep_physionet import SleepPhysionet
@@ -29,7 +29,7 @@ __all__ = [
     "BIDSEpochsDataset",
     "MOABBDataset",
     "HGD",
-    "BNCI2014_001",
+    "BNCI2014001",
     "create_from_mne_raw",
     "create_from_mne_epochs",
     "TUH",

{braindecode-1.3.0.dev176122045 → braindecode-1.3.0.dev176481332}/braindecode/datasets/moabb.py

@@ -15,7 +15,6 @@ from typing import Any
 
 import mne
 import pandas as pd
-from mne.utils import deprecated
 
 from braindecode.util import _update_moabb_docstring
 
@@ -170,8 +169,8 @@ class MOABBDataset(BaseConcatDataset):
         super().__init__(all_base_ds)
 
 
-class BNCI2014_001(MOABBDataset):
-    doc = """See moabb.datasets.bnci.BNCI2014_001
+class BNCI2014001(MOABBDataset):
+    doc = """See moabb.datasets.bnci.BNCI2014001
 
     Parameters
     ----------
@@ -180,14 +179,14 @@ class BNCI2014_001(MOABBDataset):
         subjects is fetched.
     """
     try:
-        from moabb.datasets import BNCI2014_001
+        from moabb.datasets import BNCI2014001
 
-        __doc__ = _update_moabb_docstring(BNCI2014_001, doc)
+        __doc__ = _update_moabb_docstring(BNCI2014001, doc)
     except ModuleNotFoundError:
         pass  # keep moabb soft dependency, otherwise crash on loading of datasets.__init__.py
 
     def __init__(self, subject_ids):
-        super().__init__("BNCI2014_001", subject_ids=subject_ids)
+        super().__init__("BNCI2014001", subject_ids=subject_ids)
 
 
 class HGD(MOABBDataset):
@@ -208,12 +207,3 @@ class HGD(MOABBDataset):
 
     def __init__(self, subject_ids):
         super().__init__("Schirrmeister2017", subject_ids=subject_ids)
-
-
-@deprecated(
-    "`BNCI2014001` was renamed to `BNCI2014_001` in v1.13; this alias will be removed in v1.14."
-)
-class BNCI2014001(BNCI2014_001):
-    """Deprecated alias for BNCI2014001."""
-
-    pass

{braindecode-1.3.0.dev176122045 → braindecode-1.3.0.dev176481332}/braindecode/datautil/__init__.py

@@ -2,10 +2,6 @@
 Utilities for data manipulation.
 """
 
-from .channel_utils import (
-    division_channels_idx,
-    match_hemisphere_chans,
-)
 from .serialization import (
     _check_save_dir_empty,
     load_concat_dataset,
@@ -53,10 +49,4 @@ def __getattr__(name):
     raise AttributeError("No possible import named " + name)
 
 
-__all__ = [
-    "load_concat_dataset",
-    "save_concat_dataset",
-    "_check_save_dir_empty",
-    "match_hemisphere_chans",
-    "division_channels_idx",
-]
+__all__ = ["load_concat_dataset", "save_concat_dataset", "_check_save_dir_empty"]

{braindecode-1.3.0.dev176122045 → braindecode-1.3.0.dev176481332}/braindecode/models/__init__.py

@@ -20,7 +20,6 @@ from .eegminer import EEGMiner
 from .eegnet import EEGNet, EEGNetv4
 from .eegnex import EEGNeX
 from .eegsimpleconv import EEGSimpleConv
-from .eegsym import EEGSym
 from .eegtcnet import EEGTCNet
 from .fbcnet import FBCNet
 from .fblightconvnet import FBLightConvNet
@@ -73,7 +72,6 @@ __all__ = [
     "EEGNet",
     "EEGNetv4",
     "EEGNeX",
-    "EEGSym",
     "EEGSimpleConv",
     "EEGTCNet",
     "FBCNet",

{braindecode-1.3.0.dev176122045 → braindecode-1.3.0.dev176481332}/braindecode/models/fbcnet.py

@@ -69,9 +69,7 @@ class FBCNet(EEGModuleMixin, nn.Module):
     linear_max_norm : float, default=0.5
         Maximum norm for the final linear layer.
     filter_parameters: dict, default None
-        Dictionary of parameters to use for the FilterBankLayer.
-        If None, a default Chebyshev Type II filter with transition bandwidth of
-        2 Hz and stop-band ripple of 30 dB will be used.
+        Parameters for the FilterBankLayer
 
     References
     ----------

{braindecode-1.3.0.dev176122045 → braindecode-1.3.0.dev176481332}/braindecode/models/fbmsnet.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, Sequence
+from typing import Optional, Sequence
 
 import torch
 from einops.layers.torch import Rearrange
@@ -57,28 +57,16 @@ class FBMSNet(EEGModuleMixin, nn.Module):
     ----------
     n_bands : int, default=9
         Number of input channels (e.g., number of frequency bands).
-    n_filters_spat : int, default=36
-        Number of output channels from the MixedConv2d layer.
-    temporal_layer : str, default='LogVarLayer'
-        Temporal aggregation layer to use.
-    n_dim: int, default=3
-        Dimension of the temporal reduction layer.
     stride_factor : int, default=4
         Stride factor for temporal segmentation.
+    temporal_layer : str, default='LogVarLayer'
+        Temporal aggregation layer to use.
+    n_filters_spat : int, default=36
+        Number of output channels from the MixedConv2d layer.
     dilatability : int, default=8
         Expansion factor for the spatial convolution block.
     activation : nn.Module, default=nn.SiLU
         Activation function class to apply.
-    kernels_weights : Sequence[int], default=(15, 31, 63, 125)
-        Kernel sizes for the MixedConv2d layer.
-    cnn_max_norm : float, default=2
-        Maximum norm constraint for the convolutional layers.
-    linear_max_norm : float, default=0.5
-        Maximum norm constraint for the linear layers.
-    filter_parameters : dict, default=None
-        Dictionary of parameters to use for the FilterBankLayer.
-        If None, a default Chebyshev Type II filter with transition bandwidth of
-        2 Hz and stop-band ripple of 30 dB will be used.
     verbose: bool, default False
         Verbose parameter to create the filter using mne.
 
@@ -115,7 +103,7 @@ class FBMSNet(EEGModuleMixin, nn.Module):
         cnn_max_norm: float = 2,
         linear_max_norm: float = 0.5,
         verbose: bool = False,
-        filter_parameters: dict[Any, Any] | None = None,
+        filter_parameters: Optional[dict] = None,
     ):
         super().__init__(
             n_chans=n_chans,

{braindecode-1.3.0.dev176122045 → braindecode-1.3.0.dev176481332}/braindecode/models/summary.csv

@@ -13,7 +13,6 @@ EEGInceptionMI,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times",55
 EEGITNet,Motor Imagery,Classification,125,"n_chans, n_outputs, n_times",5212,"EEGITNet(n_chans=22,  n_outputs=4,  n_times=500)","Convolution,Recurrent"
 EEGNet,General,Classification,128,"n_chans, n_outputs, n_times",2484,"EEGNet(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"
-EEGSym,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times, sfreq",299218,"EEGSym(n_chans=22, n_outputs=4, n_times=1000, sfreq=250)","Convolution,Channel"
 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,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"

{braindecode-1.3.0.dev176122045 → braindecode-1.3.0.dev176481332}/braindecode/models/util.py

@@ -79,7 +79,6 @@ models_mandatory_parameters = [
     ("SPARCNet", ["n_chans", "n_outputs", "n_times"], None),
     ("ContraWR", ["n_chans", "n_outputs", "sfreq", "n_times"], dict(sfreq=200.0)),
     ("EEGNeX", ["n_chans", "n_outputs", "n_times"], None),
-    ("EEGSym", ["chs_info", "n_chans", "n_outputs", "n_times", "sfreq"], None),
     ("TSception", ["n_chans", "n_outputs", "n_times", "sfreq"], dict(sfreq=200.0)),
     ("EEGTCNet", ["n_chans", "n_outputs", "n_times"], None),
     ("SyncNet", ["n_chans", "n_outputs", "n_times"], None),

{braindecode-1.3.0.dev176122045 → braindecode-1.3.0.dev176481332}/braindecode/modules/filter.py

@@ -109,6 +109,11 @@ class FilterBankLayer(nn.Module):
         or "firwin2" to use :func:`scipy.signal.firwin2`. "firwin" uses
         a time-domain design technique that generally gives improved
         attenuation using fewer samples than "firwin2".
+    pad : str, default='reflect_limited'
+        The type of padding to use. Supports all func:`numpy.pad()` mode options.
+        Can also be "reflect_limited", which pads with a reflected version of
+        each vector mirrored on the first and last values of the vector,
+        followed by zeros. Only used for ``method='fir'``.
     verbose: bool | str | int | None, default=True
         Control verbosity of the logging output. If ``None``, use the default
         verbosity level. See the func:`mne.verbose` for details.
@@ -178,6 +183,7 @@ class FilterBankLayer(nn.Module):
                     "The band_filters items should be splitable in 2 values."
                 )
 
+        # and we accepted as
         self.band_filters = band_filters
         self.n_bands = len(band_filters)
         self.phase = phase

braindecode-1.3.0.dev176481332/braindecode/version.py

@@ -0,0 +1 @@
+__version__ = "1.3.0.dev176481332"

{braindecode-1.3.0.dev176122045 → braindecode-1.3.0.dev176481332/braindecode.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.3.0.dev176122045
+Version: 1.3.0.dev176481332
 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>

{braindecode-1.3.0.dev176122045 → braindecode-1.3.0.dev176481332}/braindecode.egg-info/SOURCES.txt

@@ -33,7 +33,6 @@ braindecode/datasets/sleep_physionet.py
 braindecode/datasets/tuh.py
 braindecode/datasets/xy.py
 braindecode/datautil/__init__.py
-braindecode/datautil/channel_utils.py
 braindecode/datautil/serialization.py
 braindecode/datautil/util.py
 braindecode/functional/__init__.py
@@ -58,7 +57,6 @@ braindecode/models/eegminer.py
 braindecode/models/eegnet.py
 braindecode/models/eegnex.py
 braindecode/models/eegsimpleconv.py
-braindecode/models/eegsym.py
 braindecode/models/eegtcnet.py
 braindecode/models/fbcnet.py
 braindecode/models/fblightconvnet.py

{braindecode-1.3.0.dev176122045 → braindecode-1.3.0.dev176481332}/docs/api.rst

@@ -73,7 +73,6 @@ save and load models from the Hugging Face Hub, if the ``braindecode[hug]`` pack
     EEGNet
     EEGNeX
     EEGSimpleConv
-    EEGSym
     EEGTCNet
     FBCNet
     FBLightConvNet
@@ -332,7 +331,7 @@ Common Datasets
    :toctree: generated/
 
     BCICompetitionIVDataset4
-    BNCI2014_001
+    BNCI2014001
     HGD
     MOABBDataset
     NMT

{braindecode-1.3.0.dev176122045 → braindecode-1.3.0.dev176481332}/docs/whats_new.rst

@@ -33,14 +33,10 @@ Enhancements
 - Fix minor documentation issues in Labram (:gh:`808` by `Matthew Chen`_)
 - Including missed tag in all the models and creating some test for it (:gh:`811` by `Bruno Aristimunha`_ )
 - Modify verbosity of create_window_from_events (:gh:`814` by `Matthew Chen`_)
-- Modify the interface of FBMSNet for consistency with FBCNet + Unit Tests (:gh:`819` by `Matthew Chen`_)
-- Adding :class:`braindecode.models.EEGSym` model (:gh:`697` by `Pierre Guetschel`_ and `Bruno Aristimunha`_ )
 
 
 API changes
 ~~~~~~~~~~~
-- Deprecating the old naming of MOABB Dataset name :gh:`826` by `Bruno Aristimunha`_
-
 
 Bugs
 ~~~~

braindecode-1.3.0.dev176122045/braindecode/datautil/channel_utils.py

@@ -1,114 +0,0 @@
-"""
-Utilities for EEG channel manipulation and selection.
-
-This module provides functions for dividing and matching EEG channels,
-particularly for hemisphere-aware processing.
-"""
-
-import re
-from re import search
-
-
-def match_hemisphere_chans(left_chs, right_chs):
-    """
-    Match channels of the left and right hemispheres based on their names.
-
-    This function pairs channels from the left and right hemispheres by matching
-    their numeric identifiers. For a left channel with number N, it finds the
-    corresponding right channel with number N+1.
-
-    Parameters
-    ----------
-    left_chs : list of str
-        A list of channel names from the left hemisphere.
-    right_chs : list of str
-        A list of channel names from the right hemisphere.
-
-    Returns
-    -------
-    list of tuples
-        List of tuples with matched channel names from the left and right hemispheres.
-        Each tuple contains (left_channel, right_channel).
-
-    Raises
-    ------
-    ValueError
-        If the left and right channels do not match in length.
-    ValueError
-        If a channel name does not contain a number.
-    ValueError
-        If no matching right hemisphere channel is found for a left channel.
-
-    Examples
-    --------
-    >>> left = ['C3', 'F3']
-    >>> right = ['C4', 'F4']
-    >>> match_hemisphere_chans(left, right)
-    [('C3', 'C4'), ('F3', 'F4')]
-    """
-    if len(left_chs) != len(right_chs):
-        raise ValueError("Left and right channels do not match.")
-    right_chs = list(right_chs)
-    regexp = r"\d+"
-    out = []
-    for left in left_chs:
-        match = re.search(regexp, left)
-        if match is None:
-            raise ValueError(f"Channel '{left}' does not contain a number.")
-        chan_idx = 1 + int(match.group())
-        target_r = re.sub(regexp, str(chan_idx), left)
-        for right in right_chs:
-            if right == target_r:
-                out.append((left, right))
-                right_chs.remove(right)
-                break
-        else:
-            raise ValueError(
-                f"Found no right hemisphere matching channel for '{left}'."
-            )
-    return out
-
-
-def division_channels_idx(ch_names):
-    """
-    Divide EEG channel names into left, right, and middle based on numbering.
-
-    This function categorizes channels by their numeric suffix:
-    - Odd-numbered channels → left hemisphere
-    - Even-numbered channels → right hemisphere
-    - Channels without numbers → middle/midline
-
-    Parameters
-    ----------
-    ch_names : list of str
-        A list of EEG channel names to be divided based on their numbering.
-
-    Returns
-    -------
-    tuple of lists
-        Three lists containing the channel names:
-        - left: Odd-numbered channels (e.g., C3, F3, P3)
-        - right: Even-numbered channels (e.g., C4, F4, P4)
-        - middle: Channels without numbers (e.g., Cz, Fz, Pz)
-
-    Notes
-    -----
-    The function identifies channel numbers by searching for numeric characters
-    in the channel names. Standard 10-20 system EEG channel naming conventions
-    use odd numbers for left hemisphere and even numbers for right hemisphere.
-
-    Examples
-    --------
-    >>> channels = ['FP1', 'FP2', 'O1', 'O2', 'FZ']
-    >>> division_channels_idx(channels)
-    (['FP1', 'O1'], ['FP2', 'O2'], ['FZ'])
-    """
-    left, right, middle = [], [], []
-    for ch in ch_names:
-        number = search(r"\d+", ch)
-        if number is not None:
-            (left if int(number[0]) % 2 else right).append(ch)
-        else:
-            middle.append(ch)
-
-    return left, right, middle