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

braindecode/datasets/base.py

@@ -1,4 +1,6 @@
-"""Dataset classes."""
+"""
+Dataset classes.
+"""
 
 # Authors: Hubert Banville <hubert.jbanville@gmail.com>
 #          Lukas Gemein <l.gemein@gmail.com>
@@ -26,7 +28,7 @@ from mne.utils.docs import deprecated
 from torch.utils.data import ConcatDataset, Dataset
 from typing_extensions import TypeVar
 
-from .bids.hub import HubDatasetMixin
+from .hub import HubDatasetMixin
 from .registry import register_dataset
 
 
@@ -63,9 +65,9 @@ class RecordDataset(Dataset[tuple[np.ndarray, int | str, tuple[int, int, int]]])
 
         Parameters
         ----------
-        description : dict | pd.Series
+        description: dict | pd.Series
             Description in the form key: value.
-        overwrite : bool
+        overwrite: bool
             Has to be True if a key in description already exists in the
             dataset description.
         """
@@ -399,6 +401,7 @@ class BaseConcatDataset(ConcatDataset, HubDatasetMixin, Generic[T]):
         list of RecordDataset
     target_transform : callable | None
         Optional function to call on targets before returning them.
+
     """
 
     datasets: list[T]
@@ -433,8 +436,8 @@ class BaseConcatDataset(ConcatDataset, HubDatasetMixin, Generic[T]):
 
     def __getitem__(self, idx: int | list):
         """
-        ---
-
+        Parameters
+        ----------
         idx : int | list
             Index of window and target to return. If provided as a list of
             ints, multiple windows and targets will be extracted and
@@ -569,8 +572,7 @@ class BaseConcatDataset(ConcatDataset, HubDatasetMixin, Generic[T]):
         self._target_transform = fn
 
     def _outdated_save(self, path, overwrite=False):
-        """This is a copy of the old saving function, that had inconsistent.
-
+        """This is a copy of the old saving function, that had inconsistent
         functionality for BaseDataset and WindowsDataset. It only exists to
         assure backwards compatibility by still being able to run the old tests.
 
@@ -666,10 +668,10 @@ class BaseConcatDataset(ConcatDataset, HubDatasetMixin, Generic[T]):
 
         Parameters
         ----------
-        description : dict | pd.DataFrame
+        description: dict | pd.DataFrame
             Description in the form key: value where the length of the value
             has to match the number of datasets.
-        overwrite : bool
+        overwrite: bool
             Has to be True if a key in description already exists in the
             dataset description.
         """
@@ -717,14 +719,8 @@ class BaseConcatDataset(ConcatDataset, HubDatasetMixin, Generic[T]):
             hasattr(self.datasets[0], "raw") or hasattr(self.datasets[0], "windows")
         ):
             raise ValueError("dataset should have either raw or windows attribute")
-
-        # Create path if it doesn't exist
-        os.makedirs(path, exist_ok=True)
-
         path_contents = os.listdir(path)
-        n_sub_dirs = len(
-            [e for e in path_contents if os.path.isdir(os.path.join(path, e))]
-        )
+        n_sub_dirs = len([os.path.isdir(e) for e in path_contents])
         for i_ds, ds in enumerate(self.datasets):
             # remove subdirectory from list of untouched files / subdirectories
             if str(i_ds + offset) in path_contents:

braindecode/datasets/bbci.py

@@ -27,11 +27,11 @@ class BBCIDataset(object):
 
     Parameters
     ----------
-    filename : str
-    load_sensor_names : list of str, optional
+    filename: str
+    load_sensor_names: list of str, optional
         Also speeds up loading if you only load some sensors.
         None means load all sensors.
-    check_class_names : bool, optional
+    check_class_names: bool, optional
         check if the class names are part of some known class names at
         Translational NeuroTechnology Lab, AG Ball, Freiburg, Germany.
     """
@@ -134,13 +134,13 @@ class BBCIDataset(object):
 
         Parameters
         ----------
-        filename : str
-        pattern : str, optional
+        filename: str
+        pattern: str, optional
             Only return those sensor names that match the given pattern.
 
         Returns
         -------
-        sensor_names : list of str
+        sensor_names: list of str
             Sensor names that match the pattern or all sensor names in the file.
         """
         with h5py.File(filename, "r") as h5file:
@@ -237,17 +237,17 @@ class BBCIDataset(object):
 
 def _check_class_names(all_class_names, event_times_in_ms, event_classes):
     """
-    Checks if the class names are part of some known class names used in.
-
+    Checks if the class names are part of some known class names used in
     translational neurotechnology lab, AG Ball, Freiburg.
 
     Logs warning in case class names are not known.
 
     Parameters
     ----------
-    all_class_names : list of str
-    event_times_in_ms : list of number
-    event_classes : list of number
+    all_class_names: list of str
+    event_times_in_ms: list of number
+    event_classes: list of number
+
     """
     if all_class_names == ["Right Hand", "Left Hand", "Rest", "Feet"]:
         pass
@@ -665,15 +665,16 @@ def load_bbci_sets_from_folder(
 
     Parameters
     ----------
-    folder : str
+    folder: str
         Folder with .BBCI.mat files inside
-    runs : list of int
+    runs: list of int
         If you only want to load specific runs.
         Assumes filenames with such kind of part: S001R02 for Run 2.
         Tries to match this regex: ``'S[0-9]{3,3}R[0-9]{2,2}_'``.
 
     Returns
     -------
+
     """
     bbci_mat_files = sorted(glob(os.path.join(folder, "*.BBCI.mat")))
     if runs != "all":

braindecode/datasets/bcicomp.py

@@ -33,16 +33,16 @@ class BCICompetitionIVDataset4(BaseConcatDataset):
     http://www.bbci.de/competition/iv/ for the dataset and competition description.
     ECoG library containing the dataset: https://searchworks.stanford.edu/view/zk881ps0522
 
+    Notes
+    -----
+    When using this dataset please cite [1]_ .
+
     Parameters
     ----------
     subject_ids : list(int) | int | None
         (list of) int of subject(s) to be loaded. If None, load all available
         subjects. Should be in range 1-3.
 
-    Notes
-    -----
-    When using this dataset please cite [1]_ .
-
     References
     ----------
     .. [1] Miller, Kai J. "A library of human electrocorticographic data and analyses."
@@ -94,6 +94,7 @@ class BCICompetitionIVDataset4(BaseConcatDataset):
 
         Returns
         -------
+
         """
         signature = "BCICompetitionIVDataset4"
         folder_name = "BCI_Competion4_dataset4_data_fingerflexions"

braindecode/datasets/{bids/datasets.py → bids.py}

@@ -1,4 +1,3 @@
-# mypy: ignore-errors
 """Dataset for loading BIDS.
 
 More information on BIDS (Brain Imaging Data Structure) can be found at https://bids.neuroimaging.io
@@ -20,19 +19,26 @@ import numpy as np
 import pandas as pd
 from joblib import Parallel, delayed
 
-from ..base import BaseConcatDataset, RawDataset, WindowsDataset
+from .base import BaseConcatDataset, RawDataset, WindowsDataset
 
 
 def _description_from_bids_path(bids_path: mne_bids.BIDSPath) -> dict[str, Any]:
-    description = {"path": bids_path.fpath, **bids_path.entities}
-    description.update(
-        {
-            "suffix": bids_path.suffix,
-            "extension": bids_path.extension,
-            "datatype": bids_path.datatype,
-        }
-    )
-    return description
+    return {
+        "path": bids_path.fpath,
+        "subject": bids_path.subject,
+        "session": bids_path.session,
+        "task": bids_path.task,
+        "acquisition": bids_path.acquisition,
+        "run": bids_path.run,
+        "processing": bids_path.processing,
+        "recording": bids_path.recording,
+        "space": bids_path.space,
+        "split": bids_path.split,
+        "description": bids_path.description,
+        "suffix": bids_path.suffix,
+        "extension": bids_path.extension,
+        "datatype": bids_path.datatype,
+    }
 
 
 @dataclass
@@ -59,7 +65,7 @@ class BIDSDataset(BaseConcatDataset):
         The acquisition session. Corresponds to "ses".
     tasks : str | array-like of str | None
         The experimental task. Corresponds to "task".
-    acquisitions : str | array-like of str | None
+    acquisitions: str | array-like of str | None
         The acquisition parameters. Corresponds to "acq".
     runs : str | array-like of str | None
         The run number. Corresponds to "run".

braindecode/datasets/{bids/iterable.py → experimental.py}

@@ -25,13 +25,14 @@ class BIDSIterableDataset(IterableDataset):
 
     Examples
     --------
-    >>> from braindecode.datasets import BaseConcatDataset, RawDataset, RecordDataset
-    >>> from braindecode.datasets.bids import BIDSIterableDataset
+    >>> from braindecode.datasets import RecordDataset, BaseConcatDataset
+    >>> from braindecode.datasets.bids import BIDSIterableDataset, _description_from_bids_path
     >>> from braindecode.preprocessing import create_fixed_length_windows
     >>>
     >>> def my_reader_fn(path):
     ...     raw = mne_bids.read_raw_bids(path)
-    ...     ds: RecordDataset = RawDataset(raw, description={"path": path.fpath})
+    ...     desc = _description_from_bids_path(path)
+    ...     ds = RawDataset(raw, description=desc)
     ...     windows_ds = create_fixed_length_windows(
     ...         BaseConcatDataset([ds]),
     ...         window_size_samples=400,
@@ -47,8 +48,7 @@ class BIDSIterableDataset(IterableDataset):
     Parameters
     ----------
     reader_fn : Callable[[mne_bids.BIDSPath], Sequence]
-        A function that takes a BIDSPath and returns a dataset (e.g., a
-        RecordDataset or BaseConcatDataset of RecordDataset).
+        A function that takes a BIDSPath and returns a dataset.
     pool_size : int
         The number of recordings to read and sample from.
     bids_paths : list[mne_bids.BIDSPath] | None
@@ -62,7 +62,7 @@ class BIDSIterableDataset(IterableDataset):
         The acquisition session. Corresponds to "ses".
     tasks : str | array-like of str | None
         The experimental task. Corresponds to "task".
-    acquisitions : str | array-like of str | None
+    acquisitions: str | array-like of str | None
         The acquisition parameters. Corresponds to "acq".
     runs : str | array-like of str | None
         The run number. Corresponds to "run".
@@ -106,8 +106,6 @@ class BIDSIterableDataset(IterableDataset):
         If True, preload the data. Defaults to False.
     n_jobs : int
         Number of jobs to run in parallel. Defaults to 1.
-
-
     """
 
     def __init__(