Braindecode 1.3.0.dev177628147__tar.gz → 1.3.0.dev178811222__tar.gz

{braindecode-1.3.0.dev177628147/braindecode.egg-info → braindecode-1.3.0.dev178811222}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.3.0.dev177628147
+Version: 1.3.0.dev178811222
 Summary: Deep learning software to decode EEG, ECG or MEG signals
-Author-email: Robin Tibor Schirrmeister <robintibor@gmail.com>, Bruno Aristimunha Pinto <b.aristimunha@gmail.com>, Alexandre Gramfort <agramfort@meta.com>
+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>
 License: BSD-3-Clause
 Project-URL: homepage, https://braindecode.org
@@ -38,14 +38,8 @@ Requires-Dist: wfdb
 Requires-Dist: h5py
 Requires-Dist: linear_attention_transformer
 Requires-Dist: docstring_inheritance
-Requires-Dist: rotary_embedding_torch
 Provides-Extra: moabb
 Requires-Dist: moabb>=1.2.0; extra == "moabb"
-Provides-Extra: eegprep
-Requires-Dist: eegprep[eeglabio]>=0.1.1; extra == "eegprep"
-Provides-Extra: hub
-Requires-Dist: huggingface_hub[torch]>=0.20.0; extra == "hub"
-Requires-Dist: zarr<3.0,>=2.18; extra == "hub"
 Provides-Extra: tests
 Requires-Dist: pytest; extra == "tests"
 Requires-Dist: pytest-cov; extra == "tests"
@@ -71,11 +65,7 @@ Requires-Dist: pre-commit; extra == "docs"
 Requires-Dist: openneuro-py; extra == "docs"
 Requires-Dist: plotly; extra == "docs"
 Provides-Extra: all
-Requires-Dist: braindecode[moabb]; extra == "all"
-Requires-Dist: braindecode[hub]; extra == "all"
-Requires-Dist: braindecode[tests]; extra == "all"
-Requires-Dist: braindecode[docs]; extra == "all"
-Requires-Dist: braindecode[eegprep]; extra == "all"
+Requires-Dist: braindecode[docs,moabb,tests]; extra == "all"
 Dynamic: license-file
 
 .. image:: https://badges.gitter.im/braindecodechat/community.svg

{braindecode-1.3.0.dev177628147 → braindecode-1.3.0.dev178811222}/braindecode/augmentation/base.py

@@ -189,7 +189,7 @@ class AugmentedDataLoader(DataLoader):
 
     Parameters
     ----------
-    dataset : RecordDataset
+    dataset : BaseDataset
         The dataset containing the signals.
     transforms : list | Transform, optional
         Transform or sequence of Transform to be applied to each batch.

{braindecode-1.3.0.dev177628147 → braindecode-1.3.0.dev178811222}/braindecode/augmentation/functional.py

@@ -1,7 +1,6 @@
 # Authors: Cédric Rommel <cedric.rommel@inria.fr>
 #          Alexandre Gramfort <alexandre.gramfort@inria.fr>
 #          Gustavo Rodrigues <gustavenrique01@gmail.com>
-#          Bruna Lopes <brunajaflopes@gmail.com>
 #
 # License: BSD (3-clause)
 
@@ -1195,103 +1194,3 @@ def mask_encoding(
     X[mask] = 0
 
     return X, y  # Return the masked tensor and labels
-
-
-def channels_rereference(
-    X: torch.Tensor,
-    y: torch.Tensor,
-    random_state: int | np.random.RandomState | None = None,
-) -> tuple[torch.Tensor, torch.Tensor]:
-    """Randomly re-reference channels in EEG data matrix.
-
-    Part of the augmentations proposed in [1]_
-
-    Parameters
-    ----------
-    X : torch.Tensor
-        EEG input example or batch.
-    y : torch.Tensor
-        EEG labels for the example or batch.
-    random_state: int | numpy.random.Generator, optional
-        Seed to be used to instantiate numpy random number generator instance.
-        Defaults to None.
-
-    Returns
-    -------
-    torch.Tensor
-        Transformed inputs.
-    torch.Tensor
-        Transformed labels.
-
-    References
-    ----------
-    .. [1] Mohsenvand, M.N., Izadi, M.R. &amp; Maes, P.. (2020). Contrastive
-        Representation Learning for Electroencephalogram Classification. Proceedings
-        of the Machine Learning for Health NeurIPS Workshop, in Proceedings of Machine
-        Learning Research 136:238-253
-
-    """
-
-    rng = check_random_state(random_state)
-    batch_size, n_channels, _ = X.shape
-
-    ch = rng.randint(0, n_channels, size=batch_size)
-
-    X_ch = X[torch.arange(batch_size), ch, :]
-    X = X - X_ch.unsqueeze(1)
-    X[torch.arange(batch_size), ch, :] = -X_ch
-
-    return X, y
-
-
-def amplitude_scale(
-    X: torch.Tensor,
-    y: torch.Tensor,
-    scale: tuple,
-    random_state: int | np.random.RandomState | None = None,
-) -> tuple[torch.Tensor, torch.Tensor]:
-    """Rescale amplitude of each channel based on a random sampled scaling value.
-
-    Part of the augmentations proposed in [1]_
-
-    Parameters
-    ----------
-    X : torch.Tensor
-        EEG input example or batch.
-    y : torch.Tensor
-        EEG labels for the example or batch.
-    scale : tuple of floats
-        Interval from which ypu sample the scaling value
-    random_state: int | numpy.random.Generator, optional
-        Seed to be used to instantiate numpy random number generator instance.
-        Defaults to None.
-
-    Returns
-    -------
-    torch.Tensor
-        Transformed inputs.
-    torch.Tensor
-        Transformed labels.
-
-    References
-    ----------
-    .. [1] Mohsenvand, M.N., Izadi, M.R. &amp; Maes, P.. (2020). Contrastive
-        Representation Learning for Electroencephalogram Classification. Proceedings
-        of the Machine Learning for Health NeurIPS Workshop, in Proceedings of Machine
-        Learning Research 136:238-253
-
-    """
-
-    rng = torch.Generator()
-    rng.manual_seed(random_state)
-    batch_size, n_channels, _ = X.shape
-
-    # Parameter for scaling amplitude / channel / trial
-    l, h = scale
-    s = l + (h - l) * torch.rand(
-        batch_size, n_channels, 1, generator=rng, device=X.device, dtype=X.dtype
-    )
-
-    X = s * X
-
-    return X, y

{braindecode-1.3.0.dev177628147 → braindecode-1.3.0.dev178811222}/braindecode/augmentation/transforms.py

@@ -1,7 +1,6 @@
 # Authors: Cédric Rommel <cedric.rommel@inria.fr>
 #          Alexandre Gramfort <alexandre.gramfort@inria.fr>
 #          Gustavo Rodrigues <gustavenrique01@gmail.com>
-#          Bruna Lopes <brunajaflopes@gmail.com>
 #
 # License: BSD (3-clause)
 
@@ -14,11 +13,9 @@ from mne.channels import make_standard_montage
 
 from .base import Transform
 from .functional import (
-    amplitude_scale,
     bandstop_filter,
     channels_dropout,
     channels_permute,
-    channels_rereference,
     channels_shuffle,
     frequency_shift,
     ft_surrogate,
@@ -1274,74 +1271,3 @@ class MaskEncoding(Transform):
             "segment_length": segment_length,
             "n_segments": self.n_segments,
         }
-
-
-class ChannelsReref(Transform):
-    """Randomly re-reference channels in EEG data matrix.
-
-    Part of the augmentations proposed in [1]_
-
-    Parameters
-    ----------
-    probability: float
-        Float setting the probability of applying the operation.
-    random_state: int | numpy.random.Generator, optional
-        Seed to be used to instantiate numpy random number generator instance.
-        Used to decide whether or not to transform given the probability
-        argument, to sample which channels to shuffle and to carry the shuffle.
-        Defaults to None.
-
-    References
-    ----------
-    .. [1] Mohsenvand, M.N., Izadi, M.R. &amp; Maes, P.. (2020). Contrastive
-        Representation Learning for Electroencephalogram Classification. Proceedings
-        of the Machine Learning for Health NeurIPS Workshop, in Proceedings of Machine
-        Learning Research 136:238-253 Available from https://proceedings.mlr.press/v136/mohsenvand20a.html.
-
-    """
-
-    operation = staticmethod(channels_rereference)  # type: ignore[assignment]
-
-    def __init__(self, probability, random_state=None):
-        super().__init__(probability=probability, random_state=random_state)
-
-    def get_augmentation_params(self, *batch):
-        """Return transform parameters"""
-        return {
-            "random_state": self.rng,
-        }
-
-
-class AmplitudeScale(Transform):
-    """Rescale amplitude based on a random sampled scaling value.
-
-    Part of the augmentations proposed in [1]_
-
-    Parameters
-    ----------
-    probability: float
-        Float setting the probability of applying the operation.
-    random_state: int | numpy.random.Generator, optional
-        Seed to be used to instantiate numpy random number generator instance.
-        Used to decide whether or not to transform given the probability
-        argument, to sample which channels to shuffle and to carry the shuffle.
-        Defaults to None.
-
-    References
-    ----------
-    .. [1] Mohsenvand, M.N., Izadi, M.R. &amp; Maes, P.. (2020). Contrastive
-        Representation Learning for Electroencephalogram Classification. Proceedings
-        of the Machine Learning for Health NeurIPS Workshop, in Proceedings of Machine
-        Learning Research 136:238-253 Available from https://proceedings.mlr.press/v136/mohsenvand20a.html.
-
-    """
-
-    operation = staticmethod(amplitude_scale)  # type: ignore[assignment]
-
-    def __init__(self, probability, interval=(0.5, 2), random_state=None):
-        super().__init__(probability=probability, random_state=random_state)
-        self.scale = interval
-
-    def get_augmentation_params(self, *batch):
-        """Return transform parameters"""
-        return {"random_state": self.rng, "scale": self.scale}

{braindecode-1.3.0.dev177628147 → braindecode-1.3.0.dev178811222}/braindecode/datasets/__init__.py

@@ -2,17 +2,11 @@
 Loader code for some datasets.
 """
 
-from .base import (
-    BaseConcatDataset,
-    EEGWindowsDataset,
-    RawDataset,
-    RecordDataset,
-    WindowsDataset,
-)
+from .base import BaseConcatDataset, BaseDataset, WindowsDataset
 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
@@ -21,15 +15,13 @@ from .xy import create_from_X_y
 
 __all__ = [
     "WindowsDataset",
-    "EEGWindowsDataset",
-    "RecordDataset",
-    "RawDataset",
+    "BaseDataset",
     "BaseConcatDataset",
     "BIDSDataset",
     "BIDSEpochsDataset",
     "MOABBDataset",
     "HGD",
-    "BNCI2014_001",
+    "BNCI2014001",
     "create_from_mne_raw",
     "create_from_mne_epochs",
     "TUH",