eegdash 0.3.8__tar.gz → 0.3.9.dev114__tar.gz

{eegdash-0.3.8/eegdash.egg-info → eegdash-0.3.9.dev114}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eegdash
-Version: 0.3.8
+Version: 0.3.9.dev114
 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
@@ -63,6 +63,7 @@ Requires-Dist: memory_profiler; extra == "docs"
 Requires-Dist: ipython; extra == "docs"
 Requires-Dist: lightgbm; extra == "docs"
 Requires-Dist: plotly; extra == "docs"
+Requires-Dist: nbformat; extra == "docs"
 Provides-Extra: all
 Requires-Dist: eegdash[docs]; extra == "all"
 Requires-Dist: eegdash[dev]; extra == "all"

{eegdash-0.3.8 → eegdash-0.3.9.dev114}/docs/source/dataset_summary.rst

@@ -1,8 +1,7 @@
 .. meta::
    :hide_sidebar: true
-
-:html_theme.sidebar_secondary.remove:
-:html_theme.sidebar_primary.remove:
+   :html_theme.sidebar_secondary.remove: true
+   :html_theme.sidebar_primary.remove: true
 
 .. _data_summary:
 

{eegdash-0.3.8 → eegdash-0.3.9.dev114}/docs/source/index.rst

@@ -1,4 +1,5 @@
-:html_theme.sidebar_secondary.remove:
+.. meta::
+   :html_theme.sidebar_secondary.remove: true
 
 EEGDASH Documentation
 =====================
@@ -58,4 +59,3 @@ The archive is currently still in :bdg-danger:`beta testing` mode, so be kind.
    API <api/modules.rst>
    Dataset Summary <dataset_summary>
    Examples <generated/auto_examples/index>
-

{eegdash-0.3.8 → eegdash-0.3.9.dev114}/eegdash/__init__.py

@@ -7,4 +7,4 @@ _init_mongo_client()
 
 __all__ = ["EEGDash", "EEGDashDataset", "EEGChallengeDataset", "preprocessing"]
 
-__version__ = "0.3.8"
+__version__ = "0.3.9.dev114"

{eegdash-0.3.8 → eegdash-0.3.9.dev114}/eegdash/api.py

@@ -92,16 +92,13 @@ class EEGDash:
     ) -> list[Mapping[str, Any]]:
         """Find records in the MongoDB collection.
 
-        This method supports four usage patterns:
-        1. With a pre-built MongoDB query dictionary (positional argument):
-           >>> eegdash.find({"dataset": "ds002718", "subject": {"$in": ["012", "013"]}})
-        2. With user-friendly keyword arguments for simple and multi-value queries:
-           >>> eegdash.find(dataset="ds002718", subject="012")
-           >>> eegdash.find(dataset="ds002718", subject=["012", "013"])
-        3. With an explicit empty query to return all documents:
-           >>> eegdash.find({})  # fetches all records (use with care)
-        4. By combining a raw query with kwargs (merged via logical AND):
-           >>> eegdash.find({"dataset": "ds002718"}, subject=["012", "013"])  # yields {"$and":[{"dataset":"ds002718"}, {"subject":{"$in":["012","013"]}}]}
+        Examples
+        --------
+        >>> eegdash.find({"dataset": "ds002718", "subject": {"$in": ["012", "013"]}})  # pre-built query
+        >>> eegdash.find(dataset="ds002718", subject="012")  # keyword filters
+        >>> eegdash.find(dataset="ds002718", subject=["012", "013"])  # sequence -> $in
+        >>> eegdash.find({})  # fetch all (use with care)
+        >>> eegdash.find({"dataset": "ds002718"}, subject=["012", "013"])  # combine query + kwargs (AND)
 
         Parameters
         ----------
@@ -641,8 +638,8 @@ class EEGDashDataset(BaseConcatDataset, metaclass=NumpyDocstringInheritanceInitM
     and dataset name. An EEGDashDataset is pooled collection of EEGDashBaseDataset
     instances (individual recordings) and is a subclass of braindecode's BaseConcatDataset.
 
-    Querying Examples:
-    ------------------
+    Examples
+    --------
     # Find by single subject
     >>> ds = EEGDashDataset(dataset="ds005505", subject="NDARCA153NKE")
 
@@ -695,10 +692,11 @@ class EEGDashDataset(BaseConcatDataset, metaclass=NumpyDocstringInheritanceInitM
         a new client is created on demand, not used in the case of no download.
     **kwargs : dict
         Additional keyword arguments serving two purposes:
-        - Filtering: any keys present in ``ALLOWED_QUERY_FIELDS`` are treated
-            as query filters (e.g., ``dataset``, ``subject``, ``task``, ...).
-        - Dataset options: remaining keys are forwarded to the
-            ``EEGDashBaseDataset`` constructor.
+
+        - Filtering: any keys present in ``ALLOWED_QUERY_FIELDS`` are treated as
+          query filters (e.g., ``dataset``, ``subject``, ``task``, ...).
+        - Dataset options: remaining keys are forwarded to
+          ``EEGDashBaseDataset``.
 
     """
 

{eegdash-0.3.8 → eegdash-0.3.9.dev114}/eegdash/dataset/dataset.py

@@ -12,6 +12,31 @@ logger = logging.getLogger("eegdash")
 
 
 class EEGChallengeDataset(EEGDashDataset):
+    """EEG 2025 Challenge dataset helper.
+
+    This class provides a convenient wrapper around :class:`EEGDashDataset`
+    configured for the EEG 2025 Challenge releases. It maps a given
+    ``release`` to its corresponding OpenNeuro dataset and optionally restricts
+    to the official "mini" subject subset.
+
+    Parameters
+    ----------
+    release : str
+        Release name. One of ["R1", ..., "R11"].
+    cache_dir : str
+        Local cache directory for data files.
+    mini : bool, default True
+        If True, restrict subjects to the challenge mini subset.
+    query : dict | None
+        Additional MongoDB-style filters to AND with the release selection.
+        Must not contain the key ``dataset``.
+    s3_bucket : str | None, default "s3://nmdatasets/NeurIPS25"
+        Base S3 bucket used to locate the challenge data.
+    **kwargs
+        Passed through to :class:`EEGDashDataset`.
+
+    """
+
     def __init__(
         self,
         release: str,
@@ -21,31 +46,6 @@ class EEGChallengeDataset(EEGDashDataset):
         s3_bucket: str | None = "s3://nmdatasets/NeurIPS25",
         **kwargs,
     ):
-        """Create a new EEGDashDataset from a given query or local BIDS dataset directory
-        and dataset name. An EEGDashDataset is pooled collection of EEGDashBaseDataset
-        instances (individual recordings) and is a subclass of braindecode's BaseConcatDataset.
-
-        Parameters
-        ----------
-        release: str
-            Release name. Can be one of ["R1", ..., "R11"]
-        mini: bool, default True
-            Whether to use the mini-release version of the dataset. It is recommended
-            to use the mini version for faster training and evaluation.
-        query : dict | None
-            Optionally a dictionary that specifies a query to be executed,
-            in addition to the dataset (automatically inferred from the release argument).
-            See EEGDash.find() for details on the query format.
-        cache_dir : str
-            A directory where the dataset will be cached locally.
-        s3_bucket : str | None
-            An optional S3 bucket URI to use instead of the
-            default OpenNeuro bucket for loading data files.
-        kwargs : dict
-            Additional keyword arguments to be passed to the EEGDashDataset
-            constructor.
-
-        """
         self.release = release
         self.mini = mini
 

{eegdash-0.3.8 → eegdash-0.3.9.dev114}/eegdash/dataset/registry.py

@@ -25,8 +25,8 @@ def register_openneuro_datasets(
 
     df = pd.read_csv(summary_path, comment="#", skip_blank_lines=True)
     for _, row_series in df.iterrows():
-        row = row_series.tolist()
-        dataset_id = str(row[0]).strip()
+        # Use the explicit 'dataset' column, not the CSV index.
+        dataset_id = str(row_series.get("dataset", "")).strip()
         if not dataset_id:
             continue
 
@@ -61,20 +61,9 @@ def register_openneuro_datasets(
 
         {_markdown_table(row_series)}
 
-        Parameters
-        ----------
-        cache_dir : str
-            Local cache directory.
-        query : dict | None
-            Extra Mongo query merged with ``{{'dataset': '{dataset_id}'}}``.
-        s3_bucket : str | None
-            Optional S3 bucket name.
-        subject : str | None
-            Optional subject identifier.
-        task : str | None
-            Optional task identifier.
-        **kwargs
-            Passed through to {base_class.__name__}.
+        This class is a thin convenience wrapper for the dataset ``{dataset_id}``.
+        Constructor arguments are forwarded to :class:`{base_class.__name__}`; see the
+        base class documentation for parameter details and examples.
         """
 
         # init.__doc__ = doc

{eegdash-0.3.8 → eegdash-0.3.9.dev114/eegdash.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eegdash
-Version: 0.3.8
+Version: 0.3.9.dev114
 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
@@ -63,6 +63,7 @@ Requires-Dist: memory_profiler; extra == "docs"
 Requires-Dist: ipython; extra == "docs"
 Requires-Dist: lightgbm; extra == "docs"
 Requires-Dist: plotly; extra == "docs"
+Requires-Dist: nbformat; extra == "docs"
 Provides-Extra: all
 Requires-Dist: eegdash[docs]; extra == "all"
 Requires-Dist: eegdash[dev]; extra == "all"

eegdash-0.3.9.dev114/eegdash.egg-info/SOURCES.txt

@@ -0,0 +1,60 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+docs/Makefile
+docs/source/conf.py
+docs/source/dataset_summary.rst
+docs/source/index.rst
+docs/source/overview.rst
+docs/source/install/install.rst
+docs/source/install/install_pip.rst
+docs/source/install/install_source.rst
+eegdash/__init__.py
+eegdash/api.py
+eegdash/bids_eeg_metadata.py
+eegdash/const.py
+eegdash/data_utils.py
+eegdash/mongodb.py
+eegdash/paths.py
+eegdash/utils.py
+eegdash.egg-info/PKG-INFO
+eegdash.egg-info/SOURCES.txt
+eegdash.egg-info/dependency_links.txt
+eegdash.egg-info/requires.txt
+eegdash.egg-info/top_level.txt
+eegdash/dataset/__init__.py
+eegdash/dataset/dataset.py
+eegdash/dataset/dataset_summary.csv
+eegdash/dataset/registry.py
+eegdash/features/__init__.py
+eegdash/features/datasets.py
+eegdash/features/decorators.py
+eegdash/features/extractors.py
+eegdash/features/inspect.py
+eegdash/features/serialization.py
+eegdash/features/utils.py
+eegdash/features/feature_bank/__init__.py
+eegdash/features/feature_bank/complexity.py
+eegdash/features/feature_bank/connectivity.py
+eegdash/features/feature_bank/csp.py
+eegdash/features/feature_bank/dimensionality.py
+eegdash/features/feature_bank/signal.py
+eegdash/features/feature_bank/spectral.py
+eegdash/features/feature_bank/utils.py
+eegdash/hbn/__init__.py
+eegdash/hbn/preprocessing.py
+eegdash/hbn/windows.py
+tests/test_api.py
+tests/test_cache_folder_suffix.py
+tests/test_challenge_kwargs.py
+tests/test_correctness.py
+tests/test_dataset.py
+tests/test_dataset_registration.py
+tests/test_eegdash.py
+tests/test_functional.py
+tests/test_init.py
+tests/test_minirelease.py
+tests/test_mongo_connection.py
+tests/test_offline.py
+tests/test_query.py

{eegdash-0.3.8 → eegdash-0.3.9.dev114}/eegdash.egg-info/requires.txt

@@ -38,6 +38,7 @@ memory_profiler
 ipython
 lightgbm
 plotly
+nbformat
 
 [tests]
 pytest

{eegdash-0.3.8 → eegdash-0.3.9.dev114}/pyproject.toml

@@ -84,7 +84,8 @@ docs = [
   "memory_profiler",
   "ipython",
   "lightgbm",
-  "plotly"
+  "plotly",
+  "nbformat",
 ]
 
 all = [