eegdash 0.4.0.dev150__tar.gz → 0.4.0.dev153__tar.gz

{eegdash-0.4.0.dev150/eegdash.egg-info → eegdash-0.4.0.dev153}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eegdash
-Version: 0.4.0.dev150
+Version: 0.4.0.dev153
 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

eegdash-0.4.0.dev153/docs/source/_templates/autosummary/module.rst

@@ -0,0 +1,65 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: bysource
+
+   {% block attributes %}
+   {%- if attributes %}
+   .. rubric:: {{ _('Module Attributes') }}
+
+   .. autosummary::
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {%- endblock %}
+
+   {%- block functions %}
+   {%- if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {%- endblock %}
+
+   {%- block classes %}
+   {%- if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {%- endblock %}
+
+   {%- block exceptions %}
+   {%- if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {%- endblock %}
+
+{%- block modules %}
+{%- if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{%- endblock %}
+

{eegdash-0.4.0.dev150 → eegdash-0.4.0.dev153}/docs/source/conf.py

@@ -293,6 +293,14 @@ EEGDash currently exposes **{dataset_count} OpenNeuro EEG datasets** that are
 registered dynamically from mongo database. The table below summarises
 the distribution by experimental type as tracked in the summary file.
 
+Base Dataset API
+----------------
+
+.. toctree::
+   :maxdepth: 1
+
+   eegdash.dataset.EEGChallengeDataset
+
 .. list-table:: Dataset counts by experimental type
    :widths: 60 20
    :header-rows: 1
@@ -314,6 +322,22 @@ All Datasets
 """
 
 
+BASE_DATASET_TEMPLATE = """{notice}.. _api_eegdash_challenge_dataset:
+
+.. currentmodule:: eegdash.dataset
+
+EEGChallengeDataset
+===================
+
+.. autoclass:: eegdash.dataset.EEGChallengeDataset
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: bysource
+
+"""
+
+
 def _write_if_changed(path: Path, content: str) -> bool:
     """Write ``content`` to ``path`` if it differs from the current file."""
     existing = path.read_text(encoding="utf-8") if path.exists() else None
@@ -540,6 +564,11 @@ def _generate_dataset_docs(app) -> None:
     if _write_if_changed(index_path, index_content):
         LOGGER.info("[dataset-docs] Updated %s", index_path.relative_to(app.srcdir))
 
+    base_content = BASE_DATASET_TEMPLATE.format(notice=AUTOGEN_NOTICE)
+    base_path = dataset_dir / "eegdash.dataset.EEGChallengeDataset.rst"
+    if _write_if_changed(base_path, base_content):
+        LOGGER.info("[dataset-docs] Updated %s", base_path.relative_to(app.srcdir))
+
     generated_paths: set[Path] = set()
     for name in dataset_names:
         title = f"eegdash.dataset.{name}"

{eegdash-0.4.0.dev150 → eegdash-0.4.0.dev153}/docs/source/dataset_summary/bubble.rst

@@ -1,3 +1,5 @@
+.. rubric:: Dataset landscape
+
 .. raw:: html
 
    <figure class="eegdash-figure" style="margin: 0 0 1.25rem 0;">

{eegdash-0.4.0.dev150 → eegdash-0.4.0.dev153}/docs/source/dataset_summary/kde.rst

@@ -1,3 +1,5 @@
+.. rubric:: Participant Distribution by Modality
+
 .. raw:: html
 
    <figure class="eegdash-figure" style="margin: 0 0 1.25rem 0;">

{eegdash-0.4.0.dev150 → eegdash-0.4.0.dev153}/docs/source/user_guide.rst

@@ -1,16 +1,21 @@
 .. _user_guide:
 
+:html_theme.sidebar_secondary.remove: true
+
+.. currentmodule:: eegdash.api
+
+
 User Guide
 ==========
 
-This guide provides a comprehensive overview of the ``eegdash`` library, focusing on its core data access object, ``EEGDashDataset``. You will learn how to use this object to find, access, and manage EEG data for your research and analysis tasks.
+This guide provides a comprehensive overview of the :mod:`eegdash` library, focusing on its core data access object, :class:`~eegdash.api.EEGDashDataset`. You will learn how to use this object to find, access, and manage EEG data for your research and analysis tasks.
 
 The EEGDash Object
 ------------------
 
-While :class:`~eegdash.EEGDashDataset` is the main tool for loading data for machine learning, the :class:`~eegdash.EEGDash` object provides a lower-level interface for directly interacting with the metadata database. It is useful for exploring the available data, performing complex queries, or managing metadata records.
+While :class:`~eegdash.api.EEGDashDataset` is the main tool for loading data for machine learning, the :class:`~eegdash.api.EEGDash` object provides a lower-level interface for directly interacting with the metadata database. It is useful for exploring the available data, performing complex queries, or managing metadata records.
 
-Initializing ``EEGDash``
+Initializing EEGDash
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
 You can create a client to connect to the public database like this:
@@ -38,25 +43,25 @@ The ``find()`` method allows you to query the database for records matching spec
     records_advanced = eegdash.find(query)
     print(f"Found {len(records_advanced)} records with advanced query.")
 
-``EEGDash`` vs. ``EEGDashDataset``
+EEGDash vs. EEGDashDataset
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 It's important to understand the distinction between these two objects:
 
--   **EEGDash**: Use this for querying and managing metadata. It returns a list of dictionaries, where each dictionary is a record from the database.
--   **EEGDashDataset**: Use this when you need to load EEG data for analysis or machine learning. It returns a PyTorch-compatible dataset object where each item can load the actual EEG signal.
+-   :class:`~eegdash.api.EEGDash`: Use this for querying and managing metadata. It returns a list of dictionaries, where each dictionary is a record from the database.
+-   :class:`~eegdash.api.EEGDashDataset`: Use this when you need to load EEG data for analysis or machine learning. It returns a PyTorch-compatible dataset object where each item can load the actual EEG signal.
 
-In general, you will use ``EEGDashDataset`` for most of your data loading needs.
+In general, you will use :class:`~eegdash.api.EEGDashDataset` for most of your data loading needs.
 
 The EEGDashDataset Object
 -------------------------
 
-The :class:`~eegdash.EEGDashDataset` is the primary entry point for working with EEG recordings in ``eegdash``. It acts as a high-level interface that allows you to query a metadata database and load corresponding EEG data, either from a remote source or from a local cache.
+The :class:`~eegdash.api.EEGDashDataset` is the primary entry point for working with EEG recordings in :mod:`eegdash`. It acts as a high-level interface that allows you to query a metadata database and load corresponding EEG data, either from a remote source or from a local cache.
 
-Initializing ``EEGDashDataset``
+Initializing EEGDashDataset
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To get started, you need to create an instance of ``EEGDashDataset``. The two most important parameters are ``cache_dir`` and ``dataset``.
+To get started, you need to create an instance of :class:`~eegdash.api.EEGDashDataset`. The two most important parameters are ``cache_dir`` and ``dataset``.
 
 - ``cache_dir``: This is the local directory where ``eegdash`` will store downloaded data.
 - ``dataset``: The identifier of the dataset you want to work with (e.g., ``"ds002718"``).
@@ -80,7 +85,7 @@ This will create a dataset object containing all recordings from ``ds002718``. T
 Querying for Specific Data
 --------------------------
 
-``EEGDashDataset`` offers powerful filtering capabilities, allowing you to select a subset of recordings based on various criteria. You can filter by task, subject, session, or run.
+:class:`~eegdash.api.EEGDashDataset` offers powerful filtering capabilities, allowing you to select a subset of recordings based on various criteria. You can filter by task, subject, session, or run.
 
 Filtering by Task
 ~~~~~~~~~~~~~~~~~
@@ -162,11 +167,11 @@ For more complex queries, you can pass a MongoDB-style query dictionary directly
 Working with Local Data (Offline Mode)
 --------------------------------------
 
-``eegdash`` also supports working with local data that you have already downloaded or manage separately. By setting ``download=False``, you can instruct ``EEGDashDataset`` to use local BIDS-compliant data instead of accessing the database or remote storage.
+:mod:`eegdash` also supports working with local data that you have already downloaded or manage separately. By setting ``download=False``, you can instruct :class:`~eegdash.api.EEGDashDataset` to use local BIDS-compliant data instead of accessing the database or remote storage.
 
 To use this feature, your data must be organized in a BIDS-like structure within your ``cache_dir``. For example, if your ``cache_dir`` is ``./eeg_data`` and your dataset is ``ds002718``, the files should be located at ``./eeg_data/ds002718/``.
 
-Here is how to use ``EEGDashDataset`` in offline mode:
+Here is how to use :class:`~eegdash.api.EEGDashDataset` in offline mode:
 
 .. code-block:: python
 
@@ -179,12 +184,12 @@ Here is how to use ``EEGDashDataset`` in offline mode:
 
     print(f"Found {len(local_dataset)} local recordings.")
 
-When ``download=False``, ``eegdash`` will scan the specified directory for EEG files and construct the dataset from the local file system. This is useful for environments without internet access or when you want to work with your own curated datasets.
+When ``download=False``, :mod:`eegdash` will scan the specified directory for EEG files and construct the dataset from the local file system. This is useful for environments without internet access or when you want to work with your own curated datasets.
 
 Accessing Data from the Dataset
 -------------------------------
 
-Once you have your ``EEGDashDataset`` object, you can access individual recordings as if it were a list. Each item in the dataset is an ``EEGDashBaseDataset`` object, which contains the metadata and methods to load the actual EEG data.
+Once you have your :class:`~eegdash.api.EEGDashDataset` object, you can access individual recordings as if it were a list. Each item in the dataset is an :class:`~eegdash.data_utils.EEGDashBaseDataset` object, which contains the metadata and methods to load the actual EEG data.
 
 .. code-block:: python
 
@@ -199,4 +204,4 @@ Once you have your ``EEGDashDataset`` object, you can access individual recordin
         print(f"Sampling frequency: {raw.info['sfreq']} Hz")
         print(f"Number of channels: {len(raw.ch_names)}")
 
-This provides a powerful and flexible way to integrate ``eegdash`` into your data analysis pipelines, whether you are working with remote or local data.
+This provides a powerful and flexible way to integrate ``eegdash`` into your data analysis pipelines, whether you are working with remote or local data.

{eegdash-0.4.0.dev150 → eegdash-0.4.0.dev153}/eegdash/__init__.py

@@ -18,4 +18,4 @@ _init_mongo_client()
 
 __all__ = ["EEGDash", "EEGDashDataset", "EEGChallengeDataset", "preprocessing"]
 
-__version__ = "0.4.0.dev150"
+__version__ = "0.4.0.dev153"

{eegdash-0.4.0.dev150 → eegdash-0.4.0.dev153/eegdash.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eegdash
-Version: 0.4.0.dev150
+Version: 0.4.0.dev153
 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

{eegdash-0.4.0.dev150 → eegdash-0.4.0.dev153}/eegdash.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ docs/source/dataset_summary.rst
 docs/source/index.rst
 docs/source/sg_execution_times.rst
 docs/source/user_guide.rst
+docs/source/_templates/autosummary/module.rst
 docs/source/api/api.rst
 docs/source/api/api_core.rst
 docs/source/api/api_features.rst