eegdash 0.3.8__py3-none-any.whl → 0.3.9.dev170082126__py3-none-any.whl

eegdash/__init__.py

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

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/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/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.dist-info → eegdash-0.3.9.dev170082126.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eegdash
-Version: 0.3.8
+Version: 0.3.9.dev170082126
 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.dist-info → eegdash-0.3.9.dev170082126.dist-info}/RECORD

@@ -1,5 +1,5 @@
-eegdash/__init__.py,sha256=i7v1mHVxMkRTcAuf2bt0COJ12jmgUmFF5aZBNvMY154,277
-eegdash/api.py,sha256=fzZ69wC8Rn0yP3RGQR08k7tQwNxFz-B8UYvEUJ_9hfg,40585
+eegdash/__init__.py,sha256=3XwLMBTwj7QLjXJZns9vcKBJy6gvnZeqBIV-1TSAswk,290
+eegdash/api.py,sha256=xuNi5mP8zFmTETbRkYajSS7ba320HaDeX7XzcR_t3ZU,40216
 eegdash/bids_eeg_metadata.py,sha256=LZrGPGVdnGUbZlD4M_aAW4kEItzwTTeZFicH-jyqDyc,9712
 eegdash/const.py,sha256=qdFBEL9kIrsj9CdxbXhBkR61R3CrTGSaj5Iq0YOACIs,7313
 eegdash/data_utils.py,sha256=DZ-B03VleA9-mOUzGXcS4N18dVC2uFkFGXMFsKK8nUc,34166
@@ -7,9 +7,9 @@ eegdash/mongodb.py,sha256=GD3WgA253oFgpzOHrYaj4P1mRjNtDMT5Oj4kVvHswjI,2006
 eegdash/paths.py,sha256=246xkectTxDAYcREs1Qma_F1Y-oSmLlb0hn0F2Za5Ss,866
 eegdash/utils.py,sha256=7TfQ9D0LrAJ7FgnSXEvWgeHWK2QqaqS-_WcWXD86ObQ,408
 eegdash/dataset/__init__.py,sha256=Qmzki5G8GaFlzTb10e4SmC3WkKuJyo1Ckii15tCEHAo,157
-eegdash/dataset/dataset.py,sha256=5ku9I-JTC8DNult_m1Dgem1OQnSPazp_Xdktq4s_2s4,6829
+eegdash/dataset/dataset.py,sha256=YuyzmqN5M0itimzUD1NF1hcDwkb6fg91dRZtK6HbYOc,6521
 eegdash/dataset/dataset_summary.csv,sha256=XF0vdHz77DFyVLTaET8lL5gQQ4r-q1xAfSDWH5GTPLA,23655
-eegdash/dataset/registry.py,sha256=4L8KHlCrY7LT2SDAjKSiEuwklZVKbP-KZceoMDM3zO4,4332
+eegdash/dataset/registry.py,sha256=genOqAuf9cQBnHhPqRwfLP7S1XsnkLot6sLyJozPtf4,4150
 eegdash/features/__init__.py,sha256=BXNhjvL4_SSFAY1lcP9nyGpkbJNtoOMH4AHlF6OyABo,4078
 eegdash/features/datasets.py,sha256=kU1DO70ArSIy-LF1hHD2NN4iT-kJrI0mVpSkyV_OSeI,18301
 eegdash/features/decorators.py,sha256=v0qaJz_dcX703p1fvFYbAIXmwK3d8naYGlq7fRVKn_w,1313
@@ -28,8 +28,8 @@ eegdash/features/feature_bank/utils.py,sha256=DGh-Q7-XFIittP7iBBxvsJaZrlVvuY5mw-
 eegdash/hbn/__init__.py,sha256=U8mK64napnKU746C5DOwkX7W7sg3iW5kb_cVv2pfFq0,394
 eegdash/hbn/preprocessing.py,sha256=7S_TTRKPKEk47tTnh2D6WExBt4cctAMxUxGDjJqq5lU,2221
 eegdash/hbn/windows.py,sha256=DU_QruLOHQOttZbXCgtO4mjKaG3E5STWjMQ0_s-g0gw,9929
-eegdash-0.3.8.dist-info/licenses/LICENSE,sha256=asisR-xupy_NrQBFXnx6yqXeZcYWLvbAaiETl25iXT0,931
-eegdash-0.3.8.dist-info/METADATA,sha256=BGXm7_rvJvGlDTbL-Zifh_-CeuIqdFyT4evdSeEkTMY,10294
-eegdash-0.3.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-eegdash-0.3.8.dist-info/top_level.txt,sha256=zavO69HQ6MyZM0aQMR2zUS6TAFc7bnN5GEpDpOpFZzU,8
-eegdash-0.3.8.dist-info/RECORD,,
+eegdash-0.3.9.dev170082126.dist-info/licenses/LICENSE,sha256=asisR-xupy_NrQBFXnx6yqXeZcYWLvbAaiETl25iXT0,931
+eegdash-0.3.9.dev170082126.dist-info/METADATA,sha256=JCBkJgWi7XWeiJx1_kfhtlU4af9hxuMSCp7Enczz_UQ,10348
+eegdash-0.3.9.dev170082126.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+eegdash-0.3.9.dev170082126.dist-info/top_level.txt,sha256=zavO69HQ6MyZM0aQMR2zUS6TAFc7bnN5GEpDpOpFZzU,8
+eegdash-0.3.9.dev170082126.dist-info/RECORD,,