braindecode 1.3.0.dev177069446__py3-none-any.whl → 1.3.0.dev177628147__py3-none-any.whl

braindecode/augmentation/__init__.py

@@ -1,12 +1,12 @@
-"""Utilities for data augmentation."""
+"""
+Utilities for data augmentation.
+"""
 
 from . import functional
 from .base import AugmentedDataLoader, Compose, IdentityTransform, Transform
 from .transforms import (
-    AmplitudeScale,
     BandstopFilter,
     ChannelsDropout,
-    ChannelsReref,
     ChannelsShuffle,
     ChannelsSymmetry,
     FrequencyShift,
@@ -46,7 +46,5 @@ __all__ = [
     "Mixup",
     "SegmentationReconstruction",
     "MaskEncoding",
-    "AmplitudeScale",
-    "ChannelsReref",
     "functional",
 ]

braindecode/augmentation/base.py

@@ -31,8 +31,7 @@ Operation = Callable[
 
 
 class Transform(torch.nn.Module):
-    """Basic transform class used for implementing data augmentation.
-
+    """Basic transform class used for implementing data augmentation
     operations.
 
     Parameters
@@ -43,7 +42,7 @@ class Transform(torch.nn.Module):
     probability : float, optional
         Float between 0 and 1 defining the uniform probability of applying the
         operation. Set to 1.0 by default (e.g always apply the operation).
-    random_state : int, optional
+    random_state: int, optional
         Seed to be used to instantiate numpy random number generator instance.
         Used to decide whether or not to transform given the probability
         argument. Defaults to None.
@@ -126,7 +125,7 @@ class Transform(torch.nn.Module):
             return out_X
 
     def _get_mask(self, batch_size, device) -> torch.Tensor:
-        """Samples whether to apply operation or not over the whole batch."""
+        """Samples whether to apply operation or not over the whole batch"""
         return torch.as_tensor(self.probability > self.rng.uniform(size=batch_size)).to(
             device
         )
@@ -154,7 +153,7 @@ class Compose(Transform):
 
     Parameters
     ----------
-    transforms : list
+    transforms: list
         Sequence of Transforms to be composed.
     """
 
@@ -170,9 +169,7 @@ class Compose(Transform):
 
 def _make_collateable(transform, device=None):
     """Wraps a transform to make it collateable.
-
-    with device control.
-    """
+    with device control."""
 
     def _collate_fn(batch):
         collated_batch = default_collate(batch)

braindecode/augmentation/functional.py

@@ -144,7 +144,7 @@ def ft_surrogate(
         EEG input example or batch.
     y : torch.Tensor
         EEG labels for the example or batch.
-    phase_noise_magnitude : float
+    phase_noise_magnitude: float
         Float between 0 and 1 setting the range over which the phase
         perturbation is uniformly sampled:
         [0, `phase_noise_magnitude` * 2 * `pi`].
@@ -152,7 +152,7 @@ def ft_surrogate(
         Whether to sample phase perturbations independently for each channel or
         not. It is advised to set it to False when spatial information is
         important for the task, like in BCI.
-    random_state : int | numpy.random.Generator, optional
+    random_state: int | numpy.random.Generator, optional
         Used to draw the phase perturbation. Defaults to None.
 
     Returns
@@ -289,10 +289,10 @@ def channels_shuffle(
         EEG input example or batch.
     y : torch.Tensor
         EEG labels for the example or batch.
-    p_shuffle : float | None
+    p_shuffle: float | None
         Float between 0 and 1 setting the probability of including the channel
         in the set of permutted channels.
-    random_state : int | numpy.random.Generator, optional
+    random_state: int | numpy.random.Generator, optional
         Seed to be used to instantiate numpy random number generator instance.
         Used to sample which channels to shuffle and to carry the shuffle.
         Defaults to None.
@@ -335,7 +335,7 @@ def gaussian_noise(
         EEG labels for the example or batch.
     std : float
         Standard deviation to use for the additive noise.
-    random_state : int | numpy.random.Generator, optional
+    random_state: int | numpy.random.Generator, optional
         Seed to be used to instantiate numpy random number generator instance.
         Defaults to None.
 
@@ -468,8 +468,7 @@ def bandstop_filter(
     bandwidth: float,
     freqs_to_notch: npt.ArrayLike | None,
 ) -> tuple[torch.Tensor, torch.Tensor]:
-    """Apply a band-stop filter with desired bandwidth at the desired frequency.
-
+    """Apply a band-stop filter with desired bandwidth at the desired frequency
     position.
 
     Suggested e.g. in [1]_ and [2]_
@@ -621,7 +620,6 @@ def _torch_legval(
 ) -> torch.Tensor:
     """
     Evaluate a Legendre series at points x.
-
     If `c` is of length `n + 1`, this function returns the value:
     .. math:: p(x) = c_0 * L_0(x) + c_1 * L_1(x) + ... + c_n * L_n(x)
     The parameter `x` is converted to an array only if it is a tuple or a
@@ -807,6 +805,12 @@ def _torch_make_interpolation_matrix(
         The interpolation matrix that maps good signals to the location
         of bad signals.
 
+    References
+    ----------
+    [1] Perrin, F., Pernier, J., Bertrand, O. and Echallier, JF. (1989).
+        Spherical splines for scalp potential and current density mapping.
+        Electroencephalography Clinical Neurophysiology, Feb; 72(2):184-7.
+
     Notes
     -----
     Code copied and modified from MNE-Python:
@@ -837,12 +841,6 @@ def _torch_make_interpolation_matrix(
     LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
     DAMAGE.
-
-    References
-    ----------
-    [1] Perrin, F., Pernier, J., Bertrand, O. and Echallier, JF. (1989).
-        Spherical splines for scalp potential and current density mapping.
-        Electroencephalography Clinical Neurophysiology, Feb; 72(2):184-7.
     """
     pos_from = pos_from.clone()
     pos_to = pos_to.clone()
@@ -970,8 +968,7 @@ def sensors_rotation(
     angles: npt.ArrayLike,
     spherical_splines: bool,
 ) -> tuple[torch.Tensor, torch.Tensor]:
-    """Interpolates EEG signals over sensors rotated around the desired axis.
-
+    """Interpolates EEG signals over sensors rotated around the desired axis
     with the desired angle.
 
     Suggested in [1]_
@@ -1030,7 +1027,7 @@ def mixup(
     lam : torch.Tensor
         Values between 0 and 1 setting the linear interpolation between
         examples.
-    idx_perm : torch.Tensor
+    idx_perm: torch.Tensor
         Permuted indices of example that are mixed into original examples.
 
     Returns
@@ -1083,20 +1080,18 @@ def segmentation_reconstruction(
         EEG labels for the example or batch.
     n_segments : int
         Number of segments to use in the batch.
-    data_classes : list[tuple[int, torch.Tensor]]
+    data_classes: list[tuple[int, torch.Tensor]]
         List of tuples. Each tuple contains the class index and the corresponding EEG data.
-    rand_indices : array-like
+    rand_indices: array-like
         Array of indices that indicates which trial to use in each segment.
-    idx_shuffle : array-like
+    idx_shuffle: array-like
         Array of indices to shuffle the new generated trials.
-
     Returns
     -------
     torch.Tensor
         Transformed inputs.
     torch.Tensor
         Transformed labels.
-
     References
     ----------
     .. [1] Lotte, F. (2015). Signal processing approaches to minimize or
@@ -1150,7 +1145,7 @@ def mask_encoding(
     segment_length: int,
     n_segments: int,
 ) -> tuple[torch.Tensor, torch.Tensor]:
-    """Mark encoding from Ding et al (2024) from [ding2024]_.
+    """Mark encoding from Ding et al. (2024) from [ding2024]_.
 
     Replaces a contiguous part (or parts) of all channels by zeros
     (if more than one segment, it may overlap).
@@ -1217,7 +1212,7 @@ def channels_rereference(
         EEG input example or batch.
     y : torch.Tensor
         EEG labels for the example or batch.
-    random_state : int | numpy.random.Generator, optional
+    random_state: int | numpy.random.Generator, optional
         Seed to be used to instantiate numpy random number generator instance.
         Defaults to None.
 
@@ -1234,6 +1229,7 @@ def channels_rereference(
         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)
@@ -1266,7 +1262,7 @@ def amplitude_scale(
         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
+    random_state: int | numpy.random.Generator, optional
         Seed to be used to instantiate numpy random number generator instance.
         Defaults to None.
 
@@ -1283,6 +1279,7 @@ def amplitude_scale(
         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()

braindecode/augmentation/transforms.py

@@ -40,7 +40,7 @@ class TimeReverse(Transform):
     ----------
     probability : float
         Float setting the probability of applying the operation.
-    random_state : int | numpy.random.Generator, optional
+    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. Defaults to None.
@@ -66,7 +66,7 @@ class SignFlip(Transform):
     ----------
     probability : float
         Float setting the probability of applying the operation.
-    random_state : int | numpy.random.Generator, optional
+    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. Defaults to None.
@@ -83,7 +83,7 @@ class FTSurrogate(Transform):
 
     Parameters
     ----------
-    probability : float
+    probability: float
         Float setting the probability of applying the operation.
     phase_noise_magnitude : float | torch.Tensor, optional
         Float between 0 and 1 setting the range over which the phase
@@ -93,7 +93,7 @@ class FTSurrogate(Transform):
         Whether to sample phase perturbations independently for each channel or
         not. It is advised to set it to False when spatial information is
         important for the task, like in BCI. Default False.
-    random_state : int | numpy.random.Generator, optional
+    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. Defaults to None.
@@ -162,12 +162,12 @@ class ChannelsDropout(Transform):
 
     Parameters
     ----------
-    probability : float
+    probability: float
         Float setting the probability of applying the operation.
-    p_drop : float | None, optional
+    p_drop: float | None, optional
         Float between 0 and 1 setting the probability of dropping each channel.
         Defaults to 0.2.
-    random_state : int | numpy.random.RandomState, optional
+    random_state: int | numpy.random.RandomState, optional
         Seed to be used to instantiate numpy random number generator instance.
         Used to decide whether or not to transform given the probability
         argument and to sample channels to erase. Defaults to None.
@@ -219,12 +219,12 @@ class ChannelsShuffle(Transform):
 
     Parameters
     ----------
-    probability : float
+    probability: float
         Float setting the probability of applying the operation.
-    p_shuffle : float | None, optional
+    p_shuffle: float | None, optional
         Float between 0 and 1 setting the probability of including the channel
         in the set of permuted channels. Defaults to 0.2.
-    random_state : int | numpy.random.Generator, optional
+    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.
@@ -281,7 +281,7 @@ class GaussianNoise(Transform):
         Float setting the probability of applying the operation.
     std : float, optional
         Standard deviation to use for the additive noise. Defaults to 0.1.
-    random_state : int | numpy.random.Generator, optional
+    random_state: int | numpy.random.Generator, optional
         Seed to be used to instantiate numpy random number generator instance.
         Defaults to None.
 
@@ -348,7 +348,7 @@ class ChannelsSymmetry(Transform):
         nomenclature) of the EEG channels that will be transformed. The
         first name should correspond the data in the first row of X, the
         second name in the second row and so on.
-    random_state : int | numpy.random.Generator, optional
+    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. Defaults to None.
@@ -410,8 +410,7 @@ class ChannelsSymmetry(Transform):
 
 
 class SmoothTimeMask(Transform):
-    """Smoothly replace a randomly chosen contiguous part of all channels by.
-
+    """Smoothly replace a randomly chosen contiguous part of all channels by
     zeros.
 
     Suggested e.g. in [1]_ and [2]_
@@ -423,7 +422,7 @@ class SmoothTimeMask(Transform):
     mask_len_samples : int | torch.Tensor, optional
         Number of consecutive samples to zero out. Will be ignored if
         magnitude is not set to None. Defaults to 100.
-    random_state : int | numpy.random.Generator, optional
+    random_state: int | numpy.random.Generator, optional
         Seed to be used to instantiate numpy random number generator instance.
         Defaults to None.
 
@@ -496,8 +495,7 @@ class SmoothTimeMask(Transform):
 
 
 class BandstopFilter(Transform):
-    """Apply a band-stop filter with desired bandwidth at a randomly selected.
-
+    """Apply a band-stop filter with desired bandwidth at a randomly selected
     frequency position between 0 and ``max_freq``.
 
     Suggested e.g. in [1]_ and [2]_
@@ -516,7 +514,7 @@ class BandstopFilter(Transform):
         that the corresponding high cut frequency + transition (=1Hz) are below
         ``max_freq``. If omitted or `None`, will default to the Nyquist
         frequency (``sfreq / 2``).
-    random_state : int | numpy.random.Generator, optional
+    random_state: int | numpy.random.Generator, optional
         Seed to be used to instantiate numpy random number generator instance.
         Defaults to None.
 
@@ -625,7 +623,7 @@ class FrequencyShift(Transform):
     max_delta_freq : float | torch.Tensor, optional
         Maximum shift in Hz that can be sampled (in absolute value).
         Defaults to 2 (shift sampled between -2 and 2 Hz).
-    random_state : int | numpy.random.Generator, optional
+    random_state: int | numpy.random.Generator, optional
         Seed to be used to instantiate numpy random number generator instance.
         Defaults to None.
     """
@@ -680,8 +678,7 @@ class FrequencyShift(Transform):
 
 
 def _get_standard_10_20_positions(raw_or_epoch=None, ordered_ch_names=None):
-    """Returns standard 10-20 sensors position matrix (for instantiating.
-
+    """Returns standard 10-20 sensors position matrix (for instantiating
     SensorsRotation for example).
 
     Parameters
@@ -709,8 +706,7 @@ def _get_standard_10_20_positions(raw_or_epoch=None, ordered_ch_names=None):
 
 
 class SensorsRotation(Transform):
-    """Interpolates EEG signals over sensors rotated around the desired axis.
-
+    """Interpolates EEG signals over sensors rotated around the desired axis
     with an angle sampled uniformly between ``-max_degree`` and ``max_degree``.
 
     Suggested in [1]_
@@ -738,7 +734,7 @@ class SensorsRotation(Transform):
         Whether to use spherical splines for the interpolation or not. When
         ``False``, standard scipy.interpolate.Rbf (with quadratic kernel) will
         be used (as in the original paper). Defaults to True.
-    random_state : int | numpy.random.Generator, optional
+    random_state: int | numpy.random.Generator, optional
         Seed to be used to instantiate numpy random number generator instance.
         Defaults to None.
 
@@ -837,8 +833,7 @@ class SensorsRotation(Transform):
 
 
 class SensorsZRotation(SensorsRotation):
-    """Interpolates EEG signals over sensors rotated around the Z axis.
-
+    """Interpolates EEG signals over sensors rotated around the Z axis
     with an angle sampled uniformly between ``-max_degree`` and ``max_degree``.
 
     Suggested in [1]_
@@ -860,7 +855,7 @@ class SensorsZRotation(SensorsRotation):
         Whether to use spherical splines for the interpolation or not. When
         ``False``, standard scipy.interpolate.Rbf (with quadratic kernel) will
         be used (as in the original paper). Defaults to True.
-    random_state : int | numpy.random.Generator, optional
+    random_state: int | numpy.random.Generator, optional
         Seed to be used to instantiate numpy random number generator instance.
         Defaults to None.
 
@@ -894,8 +889,7 @@ class SensorsZRotation(SensorsRotation):
 
 
 class SensorsYRotation(SensorsRotation):
-    """Interpolates EEG signals over sensors rotated around the Y axis.
-
+    """Interpolates EEG signals over sensors rotated around the Y axis
     with an angle sampled uniformly between ``-max_degree`` and ``max_degree``.
 
     Suggested in [1]_
@@ -917,7 +911,7 @@ class SensorsYRotation(SensorsRotation):
         Whether to use spherical splines for the interpolation or not. When
         ``False``, standard scipy.interpolate.Rbf (with quadratic kernel) will
         be used (as in the original paper). Defaults to True.
-    random_state : int | numpy.random.Generator, optional
+    random_state: int | numpy.random.Generator, optional
         Seed to be used to instantiate numpy random number generator instance.
         Defaults to None.
 
@@ -951,8 +945,7 @@ class SensorsYRotation(SensorsRotation):
 
 
 class SensorsXRotation(SensorsRotation):
-    """Interpolates EEG signals over sensors rotated around the X axis.
-
+    """Interpolates EEG signals over sensors rotated around the X axis
     with an angle sampled uniformly between ``-max_degree`` and ``max_degree``.
 
     Suggested in [1]_
@@ -974,7 +967,7 @@ class SensorsXRotation(SensorsRotation):
         Whether to use spherical splines for the interpolation or not. When
         ``False``, standard scipy.interpolate.Rbf (with quadratic kernel) will
         be used (as in the original paper). Defaults to True.
-    random_state : int | numpy.random.Generator, optional
+    random_state: int | numpy.random.Generator, optional
         Seed to be used to instantiate numpy random number generator instance.
         Defaults to None.
 
@@ -1008,19 +1001,17 @@ class SensorsXRotation(SensorsRotation):
 
 
 class Mixup(Transform):
-    """Implements Iterator for Mixup for EEG data.
-
-    See [1]_.
+    """Implements Iterator for Mixup for EEG data. See [1]_.
     Implementation based on [2]_.
 
     Parameters
     ----------
-    alpha : float
+    alpha: float
         Mixup hyperparameter.
-    beta_per_sample : bool (default=False)
+    beta_per_sample: bool (default=False)
         By default, one mixing coefficient per batch is drawn from a beta
         distribution. If True, one mixing coefficient per sample is drawn.
-    random_state : int | numpy.random.Generator, optional
+    random_state: int | numpy.random.Generator, optional
         Seed to be used to instantiate numpy random number generator instance.
         Defaults to None.
 
@@ -1055,7 +1046,7 @@ class Mixup(Transform):
 
         Returns
         -------
-        params : dict
+        params: dict
             Contains the values sampled uniformly between 0 and 1 setting the
             linear interpolation between examples (lam) and the shuffled
             indices of examples that are mixed into original examples
@@ -1100,7 +1091,7 @@ class SegmentationReconstruction(Transform):
     ----------
     probability : float
         Float setting the probability of applying the operation.
-    random_state : int | numpy.random.Generator, optional
+    random_state: int | numpy.random.Generator, optional
         Seed to be used to instantiate numpy random number generator instance.
         Used to decide whether to transform given the probability
         argument and to sample the segments mixing. Defaults to None.
@@ -1139,7 +1130,6 @@ class SegmentationReconstruction(Transform):
             The data.
         y : tensor.Tensor
             The labels.
-
         Returns
         -------
         params : dict
@@ -1208,12 +1198,12 @@ class MaskEncoding(Transform):
     ----------
     probability : float
         Float setting the probability of applying the operation.
-    max_mask_ratio : float, optional
+    max_mask_ratio: float, optional
         Signal ratio to zero out. Defaults to 0.1.
     n_segments : int, optional
         Number of segments to zero out in each example.
         Defaults to 1.
-    random_state : int | numpy.random.Generator, optional
+    random_state: int | numpy.random.Generator, optional
         Seed to be used to instantiate numpy random number generator instance.
         Defaults to None.
 
@@ -1257,7 +1247,6 @@ class MaskEncoding(Transform):
             The data.
         y : tensor.Tensor
             The labels.
-
         Returns
         -------
         params : dict
@@ -1294,9 +1283,9 @@ class ChannelsReref(Transform):
 
     Parameters
     ----------
-    probability : float
+    probability: float
         Float setting the probability of applying the operation.
-    random_state : int | numpy.random.Generator, optional
+    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.
@@ -1308,6 +1297,7 @@ class ChannelsReref(Transform):
         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]
@@ -1316,7 +1306,7 @@ class ChannelsReref(Transform):
         super().__init__(probability=probability, random_state=random_state)
 
     def get_augmentation_params(self, *batch):
-        """Return transform parameters."""
+        """Return transform parameters"""
         return {
             "random_state": self.rng,
         }
@@ -1329,9 +1319,9 @@ class AmplitudeScale(Transform):
 
     Parameters
     ----------
-    probability : float
+    probability: float
         Float setting the probability of applying the operation.
-    random_state : int | numpy.random.Generator, optional
+    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.
@@ -1343,6 +1333,7 @@ class AmplitudeScale(Transform):
         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]
@@ -1352,5 +1343,5 @@ class AmplitudeScale(Transform):
         self.scale = interval
 
     def get_augmentation_params(self, *batch):
-        """Return transform parameters."""
+        """Return transform parameters"""
         return {"random_state": self.rng, "scale": self.scale}

braindecode/classifier.py

@@ -8,6 +8,7 @@
 
 import warnings
 
+import numpy as np
 from skorch import NeuralNet
 from skorch.callbacks import EpochScoring
 from skorch.classifier import NeuralNetClassifier
@@ -94,8 +95,7 @@ class EEGClassifier(_EEGNeuralNet, NeuralNetClassifier):
             return iterator
 
     def predict_proba(self, X):
-        """Return the output of the module's forward method as a numpy.
-
+        """Return the output of the module's forward method as a numpy
         array. In case of cropped decoding returns averaged values for
         each trial.
 
@@ -125,6 +125,7 @@ class EEGClassifier(_EEGNeuralNet, NeuralNetClassifier):
         Returns
         -------
         y_proba : numpy ndarray
+
         """
         y_pred = super().predict_proba(X)
         # Normally, we have to average the predictions across crops/timesteps
@@ -191,28 +192,28 @@ class EEGClassifier(_EEGNeuralNet, NeuralNetClassifier):
         Returns
         -------
         y_pred : numpy ndarray
+
         """
         return self.predict_proba(X).argmax(1)
 
     def predict_trials(self, X, return_targets=True):
-        """Create trialwise predictions and optionally also return trialwise.
-
+        """Create trialwise predictions and optionally also return trialwise
         labels from cropped dataset.
 
         Parameters
         ----------
-        X : braindecode.datasets.BaseConcatDataset
+        X: braindecode.datasets.BaseConcatDataset
             A braindecode dataset to be predicted.
-        return_targets : bool
+        return_targets: bool
             If True, additionally returns the trial targets.
 
         Returns
         -------
-        trial_predictions : np.ndarray
+        trial_predictions: np.ndarray
             3-dimensional array (n_trials x n_classes x n_predictions), where
             the number of predictions depend on the chosen window size and the
             receptive field of the network.
-        trial_labels : np.ndarray
+        trial_labels: np.ndarray
             2-dimensional array (n_trials x n_targets) where the number of
             targets depends on the decoding paradigm and can be either a single
             value, multiple values, or a sequence.
@@ -236,9 +237,13 @@ class EEGClassifier(_EEGNeuralNet, NeuralNetClassifier):
             num_workers=self.get_iterator(X, training=False).loader.num_workers,
         )
 
-    @property
-    def mode(self):
-        return "classification"
+    def _get_n_outputs(self, y, classes):
+        classes_y = np.unique(y)
+        if classes is not None:
+            assert set(classes_y) <= set(classes)
+        else:
+            classes = classes_y
+        return len(classes)
 
     # Only add the 'accuracy' callback if we are not in cropped mode.
     @property

braindecode/datasets/__init__.py

@@ -1,4 +1,6 @@
-"""Loader code for some datasets."""
+"""
+Loader code for some datasets.
+"""
 
 from .base import (
     BaseConcatDataset,
@@ -9,11 +11,9 @@ from .base import (
 )
 from .bcicomp import BCICompetitionIVDataset4
 from .bids import BIDSDataset, BIDSEpochsDataset
-from .chb_mit import CHBMIT
 from .mne import create_from_mne_epochs, create_from_mne_raw
 from .moabb import BNCI2014_001, HGD, MOABBDataset
 from .nmt import NMT
-from .siena import SIENA
 from .sleep_physio_challe_18 import SleepPhysionetChallenge2018
 from .sleep_physionet import SleepPhysionet
 from .tuh import TUH, TUHAbnormal
@@ -34,9 +34,7 @@ __all__ = [
     "create_from_mne_epochs",
     "TUH",
     "TUHAbnormal",
-    "SIENA",
     "NMT",
-    "CHBMIT",
     "SleepPhysionet",
     "SleepPhysionetChallenge2018",
     "create_from_X_y",