eegdash 0.4.1__py3-none-any.whl → 0.4.1.dev185__py3-none-any.whl

eegdash/features/inspect.py

@@ -4,7 +4,7 @@ import inspect
 from collections.abc import Callable
 
 from . import extractors, feature_bank
-from .extractors import FeatureExtractor, MultivariateFeature, _get_underlying_func
+from .extractors import _get_underlying_func
 
 __all__ = [
     "get_all_feature_extractors",
@@ -25,21 +25,24 @@ def get_feature_predecessors(feature_or_extractor: Callable) -> list:
     Parameters
     ----------
     feature_or_extractor : callable
-        The feature function or :class:`FeatureExtractor` class to inspect.
+        The feature function or :class:`~eegdash.features.extractors.FeatureExtractor`
+        class to inspect.
 
     Returns
     -------
     list
         A nested list representing the dependency tree. For a simple linear
         chain, this will be a flat list from the specific feature up to the
-        base `FeatureExtractor`. For multiple dependencies, it will contain
-        tuples of sub-dependencies.
+        base :class:`~eegdash.features.extractors.FeatureExtractor`. For
+        multiple dependencies, it will contain tuples of sub-dependencies.
 
     """
     current = _get_underlying_func(feature_or_extractor)
-    if current is FeatureExtractor:
+    if current is extractors.FeatureExtractor:
         return [current]
-    predecessor = getattr(current, "parent_extractor_type", [FeatureExtractor])
+    predecessor = getattr(
+        current, "parent_extractor_type", [extractors.FeatureExtractor]
+    )
     if len(predecessor) == 1:
         return [current, *get_feature_predecessors(predecessor[0])]
     else:
@@ -50,7 +53,7 @@ def get_feature_predecessors(feature_or_extractor: Callable) -> list:
         return [current, tuple(predecessors)]
 
 
-def get_feature_kind(feature: Callable) -> MultivariateFeature:
+def get_feature_kind(feature: Callable) -> extractors.MultivariateFeature:
     """Get the 'kind' of a feature function.
 
     The feature kind (e.g., univariate, bivariate) is typically attached by a
@@ -63,8 +66,8 @@ def get_feature_kind(feature: Callable) -> MultivariateFeature:
 
     Returns
     -------
-    MultivariateFeature
-        An instance of the feature kind (e.g., `UnivariateFeature()`).
+    :class:`~eegdash.features.extractors.MultivariateFeature`
+        An instance of the feature kind (e.g., ``UnivariateFeature()``).
 
     """
     return _get_underlying_func(feature).feature_kind
@@ -89,30 +92,30 @@ def get_all_features() -> list[tuple[str, Callable]]:
     return inspect.getmembers(feature_bank, isfeature)
 
 
-def get_all_feature_extractors() -> list[tuple[str, type[FeatureExtractor]]]:
-    """Get a list of all available `FeatureExtractor` classes.
+def get_all_feature_extractors() -> list[tuple[str, type[extractors.FeatureExtractor]]]:
+    """Get a list of all available :class:`~eegdash.features.extractors.FeatureExtractor` classes.
 
     Scans the `eegdash.features.feature_bank` module for all classes that
     subclass :class:`~eegdash.features.extractors.FeatureExtractor`.
 
     Returns
     -------
-    list[tuple[str, type[FeatureExtractor]]]
+    list[tuple[str, type[eegdash.features.extractors.FeatureExtractor]]]
         A list of (name, class) tuples for all discovered feature extractors,
-        including the base `FeatureExtractor` itself.
+        including the base :class:`~eegdash.features.extractors.FeatureExtractor` itself.
 
     """
 
     def isfeatureextractor(x):
-        return inspect.isclass(x) and issubclass(x, FeatureExtractor)
+        return inspect.isclass(x) and issubclass(x, extractors.FeatureExtractor)
 
     return [
-        ("FeatureExtractor", FeatureExtractor),
+        ("FeatureExtractor", extractors.FeatureExtractor),
         *inspect.getmembers(feature_bank, isfeatureextractor),
     ]
 
 
-def get_all_feature_kinds() -> list[tuple[str, type[MultivariateFeature]]]:
+def get_all_feature_kinds() -> list[tuple[str, type[extractors.MultivariateFeature]]]:
     """Get a list of all available feature 'kind' classes.
 
     Scans the `eegdash.features.extractors` module for all classes that
@@ -120,12 +123,12 @@ def get_all_feature_kinds() -> list[tuple[str, type[MultivariateFeature]]]:
 
     Returns
     -------
-    list[tuple[str, type[MultivariateFeature]]]
+    list[tuple[str, type[eegdash.features.extractors.MultivariateFeature]]]
         A list of (name, class) tuples for all discovered feature kinds.
 
     """
 
     def isfeaturekind(x):
-        return inspect.isclass(x) and issubclass(x, MultivariateFeature)
+        return inspect.isclass(x) and issubclass(x, extractors.MultivariateFeature)
 
     return inspect.getmembers(extractors, isfeaturekind)

eegdash/features/serialization.py

@@ -26,11 +26,13 @@ __all__ = [
 def load_features_concat_dataset(
     path: str | Path, ids_to_load: list[int] | None = None, n_jobs: int = 1
 ) -> FeaturesConcatDataset:
-    """Load a stored `FeaturesConcatDataset` from a directory.
+    """Load a stored :class:`~eegdash.features.datasets.FeaturesConcatDataset` from a directory.
 
-    This function reconstructs a :class:`FeaturesConcatDataset` by loading
-    individual :class:`FeaturesDataset` instances from subdirectories within
-    the given path. It uses joblib for parallel loading.
+    This function reconstructs a
+    :class:`~eegdash.features.datasets.FeaturesConcatDataset` by loading
+    individual :class:`~eegdash.features.datasets.FeaturesDataset` instances
+    from subdirectories within the given path. It uses joblib for parallel
+    loading.
 
     Parameters
     ----------
@@ -48,7 +50,8 @@ def load_features_concat_dataset(
     Returns
     -------
     eegdash.features.datasets.FeaturesConcatDataset
-        A concatenated dataset containing the loaded `FeaturesDataset` instances.
+        A concatenated dataset containing the loaded
+        :class:`~eegdash.features.datasets.FeaturesDataset` instances.
 
     """
     # Make sure we always work with a pathlib.Path
@@ -65,15 +68,17 @@ def load_features_concat_dataset(
 
 
 def _load_parallel(path: Path, i: str) -> FeaturesDataset:
-    """Load a single `FeaturesDataset` from its subdirectory.
+    """Load a single :class:`~eegdash.features.datasets.FeaturesDataset` from its subdirectory.
 
-    This is a helper function for `load_features_concat_dataset` that handles
-    the loading of one dataset's files (features, metadata, descriptions, etc.).
+    This is a helper function for
+    :func:`~eegdash.features.serialization.load_features_concat_dataset` that
+    handles the loading of one dataset's files (features, metadata, descriptions, etc.).
 
     Parameters
     ----------
     path : pathlib.Path
-        The root directory of the saved `FeaturesConcatDataset`.
+        The root directory of the saved
+        :class:`~eegdash.features.datasets.FeaturesConcatDataset`.
     i : str
         The identifier of the dataset to load, corresponding to its
         subdirectory name.

eegdash/features/utils.py

@@ -14,8 +14,8 @@ from braindecode.datasets.base import (
     WindowsDataset,
 )
 
+from . import extractors
 from .datasets import FeaturesConcatDataset, FeaturesDataset
-from .extractors import FeatureExtractor
 
 __all__ = [
     "extract_features",
@@ -25,7 +25,7 @@ __all__ = [
 
 def _extract_features_from_windowsdataset(
     win_ds: EEGWindowsDataset | WindowsDataset,
-    feature_extractor: FeatureExtractor,
+    feature_extractor: extractors.FeatureExtractor,
     batch_size: int = 512,
 ) -> FeaturesDataset:
     """Extract features from a single `WindowsDataset`.
@@ -38,14 +38,14 @@ def _extract_features_from_windowsdataset(
     ----------
     win_ds : EEGWindowsDataset or WindowsDataset
         The windowed dataset to extract features from.
-    feature_extractor : FeatureExtractor
+    feature_extractor : ~eegdash.features.extractors.FeatureExtractor
         The feature extractor instance to apply.
     batch_size : int, default 512
         The number of windows to process in each batch.
 
     Returns
     -------
-    FeaturesDataset
+    ~eegdash.features.datasets.FeaturesDataset
         A new dataset containing the extracted features and associated metadata.
 
     """
@@ -93,7 +93,7 @@ def _extract_features_from_windowsdataset(
 
 def extract_features(
     concat_dataset: BaseConcatDataset,
-    features: FeatureExtractor | Dict[str, Callable] | List[Callable],
+    features: extractors.FeatureExtractor | Dict[str, Callable] | List[Callable],
     *,
     batch_size: int = 512,
     n_jobs: int = 1,
@@ -109,8 +109,9 @@ def extract_features(
     concat_dataset : BaseConcatDataset
         A concatenated dataset of `WindowsDataset` or `EEGWindowsDataset`
         instances.
-    features : FeatureExtractor or dict or list
-        The feature extractor(s) to apply. Can be a `FeatureExtractor`
+    features : ~eegdash.features.extractors.FeatureExtractor or dict or list
+        The feature extractor(s) to apply. Can be a
+        :class:`~eegdash.features.extractors.FeatureExtractor`
         instance, a dictionary of named feature functions, or a list of
         feature functions.
     batch_size : int, default 512
@@ -121,14 +122,14 @@ def extract_features(
 
     Returns
     -------
-    FeaturesConcatDataset
+    ~eegdash.features.datasets.FeaturesConcatDataset
         A new concatenated dataset containing the extracted features.
 
     """
     if isinstance(features, list):
         features = dict(enumerate(features))
-    if not isinstance(features, FeatureExtractor):
-        features = FeatureExtractor(features)
+    if not isinstance(features, extractors.FeatureExtractor):
+        features = extractors.FeatureExtractor(features)
     feature_ds_list = list(
         tqdm(
             Parallel(n_jobs=n_jobs, return_as="generator")(
@@ -146,34 +147,35 @@ def extract_features(
 
 def fit_feature_extractors(
     concat_dataset: BaseConcatDataset,
-    features: FeatureExtractor | Dict[str, Callable] | List[Callable],
+    features: extractors.FeatureExtractor | Dict[str, Callable] | List[Callable],
     batch_size: int = 8192,
-) -> FeatureExtractor:
+) -> extractors.FeatureExtractor:
     """Fit trainable feature extractors on a dataset.
 
     If the provided feature extractor (or any of its sub-extractors) is
-    trainable (i.e., subclasses `TrainableFeature`), this function iterates
-    through the dataset to fit it.
+    trainable (i.e., subclasses
+    :class:`~eegdash.features.extractors.TrainableFeature`), this function
+    iterates through the dataset to fit it.
 
     Parameters
     ----------
     concat_dataset : BaseConcatDataset
         The dataset to use for fitting the feature extractors.
-    features : FeatureExtractor or dict or list
+    features : ~eegdash.features.extractors.FeatureExtractor or dict or list
         The feature extractor(s) to fit.
     batch_size : int, default 8192
         The batch size to use when iterating through the dataset for fitting.
 
     Returns
     -------
-    FeatureExtractor
+    ~eegdash.features.extractors.FeatureExtractor
         The fitted feature extractor.
 
     """
     if isinstance(features, list):
         features = dict(enumerate(features))
-    if not isinstance(features, FeatureExtractor):
-        features = FeatureExtractor(features)
+    if not isinstance(features, extractors.FeatureExtractor):
+        features = extractors.FeatureExtractor(features)
     if not features._is_trainable:
         return features
     features.clear()

eegdash/paths.py

@@ -22,11 +22,12 @@ def get_default_cache_dir() -> Path:
 
     The function determines the cache directory based on the following
     priority order:
-    1. The path specified by the ``EEGDASH_CACHE_DIR`` environment variable.
-    2. The path specified by the ``MNE_DATA`` configuration in the MNE-Python
-       config file.
-    3. A hidden directory named ``.eegdash_cache`` in the current working
-       directory.
+
+     1. The path specified by the ``EEGDASH_CACHE_DIR`` environment variable.
+     2. The path specified by the ``MNE_DATA`` configuration in the MNE-Python
+         config file.
+     3. A hidden directory named ``.eegdash_cache`` in the current working
+         directory.
 
     Returns
     -------

{eegdash-0.4.1.dist-info → eegdash-0.4.1.dev185.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eegdash
-Version: 0.4.1
+Version: 0.4.1.dev185
 Summary: EEG data for machine learning
 Author-email: Young Truong <dt.young112@gmail.com>, Arnaud Delorme <adelorme@gmail.com>, Aviv Dotan <avivd220@gmail.com>, Oren Shriki <oren70@gmail.com>, Bruno Aristimunha <b.aristimunha@gmail.com>
 License-Expression: GPL-3.0-only
@@ -60,6 +60,7 @@ Requires-Dist: lightgbm; extra == "docs"
 Requires-Dist: plotly; extra == "docs"
 Requires-Dist: nbformat; extra == "docs"
 Requires-Dist: graphviz; extra == "docs"
+Requires-Dist: neato; extra == "docs"
 Provides-Extra: digestion
 Requires-Dist: pybids; extra == "digestion"
 Requires-Dist: python-dotenv; extra == "digestion"

{eegdash-0.4.1.dist-info → eegdash-0.4.1.dev185.dist-info}/RECORD

@@ -1,24 +1,25 @@
-eegdash/__init__.py,sha256=EmkUVFpceFXHYEKj0yDMa8TMCc1KWWSYs02P4ItZrbA,697
-eegdash/api.py,sha256=CK1sYV401ZAcJ22YVcvZdv3BnG7GpPvf-C9iJDCLNCY,38467
+eegdash/__init__.py,sha256=GEDA8-xE1JPDzIRGN6fmVpGsBOFd2_uNrnAxp-UuN6w,704
+eegdash/api.py,sha256=saCl7_9tvblPVeTWZphw8fRXW4A2t1t2JBBp-RDvq1M,19632
 eegdash/bids_eeg_metadata.py,sha256=kEmFUe07tivkuIoC5T-YwfO4QQYJBxuc769ZBV1UCKo,16682
 eegdash/const.py,sha256=9WMetN7YMQJbkN2PhzItxtVRZ4VBXLP82vFu9pY6xok,9066
-eegdash/data_utils.py,sha256=t7m00gwfST3MlOFmGwEr2LNPo-fPbQ1WFwC6y8XW7yw,26119
 eegdash/downloader.py,sha256=Z-9EEJildqJxIihwdtXc_h9kzCkuF9LWIwQEfyG9Huw,6030
 eegdash/logging.py,sha256=OQ4jMtwv1h-gzjxmr3PCpcsKi5-3Nhd3r9PJ4UN7oQI,1467
 eegdash/mongodb.py,sha256=9FJDeEebOD5RzNYfAf1lhr0R-pECAlnug6Sjhd9_oUw,3469
-eegdash/paths.py,sha256=dKaDlF87q47KwP-5arAFwx83i5IwGgmEfPfNauEtkds,1499
+eegdash/paths.py,sha256=iXzBUindjIwgkf2k0Phm2InChOfPZNGilQmGwJ8zNO0,1507
 eegdash/utils.py,sha256=u_fQ8DiA1b7dVLzwzZBhm8H-LUk6dga54WyqbbqYEJ4,1282
-eegdash/dataset/__init__.py,sha256=HKDfV2DHBv63BqYLBWDMvU8jbFNRC7DqQbxL7RG1DKQ,863
-eegdash/dataset/dataset.py,sha256=DnR6LoirPNV45MECq42MNtIPyhL7DTFuwPWavVWZmmA,8137
+eegdash/dataset/__init__.py,sha256=EXmCtcIWz2_iq7-04AzOPmOxfv1hvUGnrSRgu_Je800,975
+eegdash/dataset/base.py,sha256=dHCiUtoZddflLpUD-q2yIDImMfcIVZmTuvRRJflVS8s,11718
+eegdash/dataset/bids_dataset.py,sha256=577D_kqig4xmW_fYz1VbaUbGWPquL33eT97ge_CbXpQ,14919
+eegdash/dataset/dataset.py,sha256=IDAGg5qDeh1R48nFMiyG6_9CxenS2KK56VeuvM_w5tM,27593
 eegdash/dataset/dataset_summary.csv,sha256=YJX-BitOyo-5nsHBd3ECIY1u7lFBjMQAFfCUPLYEgpo,25289
 eegdash/dataset/registry.py,sha256=5TOCWalA0RV7omRoYS0OzdcSaOTvXvqos74_Vj2jv0M,9127
 eegdash/features/__init__.py,sha256=BXNhjvL4_SSFAY1lcP9nyGpkbJNtoOMH4AHlF6OyABo,4078
-eegdash/features/datasets.py,sha256=-Y-CxBypJu3dHyNDLFKFIo-zIi4qEInahZTgJslnrVQ,24636
-eegdash/features/decorators.py,sha256=VOCeL6rFa8wqkRJRnecWaTqdBW2B9MO724vGGk1AkGo,3965
+eegdash/features/datasets.py,sha256=79Xey6SouPHMKybF78madVl5i7P0f03jnostBV6Dr7M,24880
+eegdash/features/decorators.py,sha256=Gvk-5VtqatpH7BBVVV3pcz1KJKygd-ZU8mniR_Tpvlw,4052
 eegdash/features/extractors.py,sha256=R4csU3jj95xndtWI1VuMKoKi26xprzmuOp9wcy9iVzI,11937
-eegdash/features/inspect.py,sha256=XYuEDkiwNhEFYS0a0auyn8E96WvMaPrpNn4nMRk2foM,4069
-eegdash/features/serialization.py,sha256=Um5fseiyk7SXmXoSLaaVRl2-0a6iAiRLm5rAmqdYfpg,3938
-eegdash/features/utils.py,sha256=DiutW7SOVU0pnkRTKvWpdca0RW4UCJD6JvHGDNJPjXk,6161
+eegdash/features/inspect.py,sha256=GpNV4708XPn4LXl5BXy8e0GNr_DSrojxjAT9c7POxqk,4373
+eegdash/features/serialization.py,sha256=f981K8DcfaLZ0q98IBrXeAbMHnPmKBbp7cFiXZnjezw,4194
+eegdash/features/utils.py,sha256=SuvPE6N_ccm-Ar4g-1dgVj1qaW2bV9hNQivtz946hlY,6487
 eegdash/features/feature_bank/__init__.py,sha256=YsMXLC1FEtHL3IEw9pYw1fc5IY0x_hr2qWQowI5gZj8,2991
 eegdash/features/feature_bank/complexity.py,sha256=eOLN0X_xaS15ZpLPDQcychuwjL459-FqZKYfOG51z-g,3366
 eegdash/features/feature_bank/connectivity.py,sha256=bQ6KlxWm5GNpCS9ypLqBUr2L171Yq7wpBQT2tRQKTZ4,2159
@@ -30,8 +31,8 @@ eegdash/features/feature_bank/utils.py,sha256=zCdkfDMLWJhPjBqb5Xz0jLKg8gm3qQDY1G
 eegdash/hbn/__init__.py,sha256=hsI5pmIuYDzr--aE5UiToO-P9XL5fVRKahZzdsAodro,794
 eegdash/hbn/preprocessing.py,sha256=xp0HBz8WGhLI5c2Zkk4QiVUzGoIZep8YypnHNZsUJ4o,3800
 eegdash/hbn/windows.py,sha256=Z_fhG3kaHd5MAPg60FwFnxMJay8EzacXytUaCsOENGc,14408
-eegdash-0.4.1.dist-info/licenses/LICENSE,sha256=asisR-xupy_NrQBFXnx6yqXeZcYWLvbAaiETl25iXT0,931
-eegdash-0.4.1.dist-info/METADATA,sha256=2bAo2XqxBWJS3qR8b4knurNH6KBgXYMKbSUqHAn5h6o,6835
-eegdash-0.4.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-eegdash-0.4.1.dist-info/top_level.txt,sha256=zavO69HQ6MyZM0aQMR2zUS6TAFc7bnN5GEpDpOpFZzU,8
-eegdash-0.4.1.dist-info/RECORD,,
+eegdash-0.4.1.dev185.dist-info/licenses/LICENSE,sha256=asisR-xupy_NrQBFXnx6yqXeZcYWLvbAaiETl25iXT0,931
+eegdash-0.4.1.dev185.dist-info/METADATA,sha256=kprps0odUjO5HR9uFhU6L1GCUFf69AqfX91lSh5ojkM,6880
+eegdash-0.4.1.dev185.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+eegdash-0.4.1.dev185.dist-info/top_level.txt,sha256=zavO69HQ6MyZM0aQMR2zUS6TAFc7bnN5GEpDpOpFZzU,8
+eegdash-0.4.1.dev185.dist-info/RECORD,,