Braindecode 1.5.0.dev990__tar.gz → 1.5.0.dev997__tar.gz

{braindecode-1.5.0.dev990/braindecode.egg-info → braindecode-1.5.0.dev997}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.5.0.dev990
+Version: 1.5.0.dev997
 Summary: Deep learning software to decode EEG, ECG or MEG signals
 Author-email: Robin Tibor Schirrmeister <robintibor@gmail.com>, Bruno Aristimunha Pinto <b.aristimunha@gmail.com>, Alexandre Gramfort <agramfort@meta.com>
 Maintainer-email: Alexandre Gramfort <agramfort@meta.com>, Bruno Aristimunha Pinto <b.aristimunha@gmail.com>, Robin Tibor Schirrmeister <robintibor@gmail.com>
@@ -63,7 +63,6 @@ Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
 Requires-Dist: sphinx-autobuild; extra == "docs"
 Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
 Requires-Dist: sphinx_sitemap; extra == "docs"
-Requires-Dist: sphinxext-opengraph; extra == "docs"
 Requires-Dist: pydata_sphinx_theme; extra == "docs"
 Requires-Dist: numpydoc; extra == "docs"
 Requires-Dist: memory_profiler; extra == "docs"

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev997}/braindecode/models/base.py

@@ -33,25 +33,13 @@ huggingface_hub = _soft_import(
 HAS_HF_HUB = huggingface_hub is not False
 
 
-_HF_INSTALL_HINT = (
-    "requires the `huggingface_hub` package. "
-    "Install with: pip install 'braindecode[hub]'"
-)
-
-
-class _BaseHubMixinStub:
-    @classmethod
-    def from_pretrained(cls, *args, **kwargs):
-        raise ImportError(f"{cls.__name__}.from_pretrained() {_HF_INSTALL_HINT}")
-
-    def push_to_hub(self, *args, **kwargs):
-        raise ImportError(f"{type(self).__name__}.push_to_hub() {_HF_INSTALL_HINT}")
+class _BaseHubMixin:
+    pass
 
 
 # Define base class for hub mixin
-_BaseHubMixin: Type = (
-    huggingface_hub.PyTorchModelHubMixin if HAS_HF_HUB else _BaseHubMixinStub
-)
+if HAS_HF_HUB:
+    _BaseHubMixin: Type = huggingface_hub.PyTorchModelHubMixin  # type: ignore
 
 
 def deprecated_args(obj, *old_new_args):

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev997}/braindecode/preprocessing/preprocess.py

@@ -6,7 +6,6 @@
 #          David Sabbagh <dav.sabbagh@gmail.com>
 #          Bruno Aristimunha <b.aristimunha@gmail.com>
 #          Léo Burgund <leo.burgund@gmail.com>
-#          Sarthak Tayal <sarthaktayal2@gmail.com>
 #
 # License: BSD (3-clause)
 
@@ -218,7 +217,6 @@ def preprocess(
     offset: int = 0,
     copy_data: bool | None = None,
     parallel_kwargs: dict | None = None,
-    max_nbytes: int | str | None = "1M",
 ):
     """Apply preprocessors to a concat dataset.
 
@@ -246,20 +244,14 @@ def preprocess(
         Additional keyword arguments forwarded to ``joblib.Parallel``.
         Defaults to None (equivalent to ``{}``).
         See https://joblib.readthedocs.io/en/stable/generated/joblib.Parallel.html for details.
-    max_nbytes : int, str, or None
-        Threshold (in bytes; or e.g. ``"1M"``) above which joblib memory-maps
-        preloaded arrays as read-only when dispatching to worker processes.
-        Effective only when ``n_jobs != 1``. Pass ``None`` to disable memory
-        mapping when a preprocessor resizes the underlying data (for example
-        ``filterbank``), which would otherwise fail with an ``mmap can't
-        resize a readonly`` error. ``parallel_kwargs['max_nbytes']`` takes
-        precedence if both are provided.
 
     Returns
     -------
     BaseConcatDataset
         Preprocessed dataset.
     """
+    # In case of serialization, make sure directory is available before
+    # preprocessing
     if save_dir is not None and not overwrite:
         _check_save_dir_empty(save_dir)
 
@@ -274,35 +266,22 @@ def preprocess(
     parallel_params.setdefault(
         "prefer", "threads" if platform.system() == "Windows" else None
     )
-    parallel_params.setdefault("max_nbytes", max_nbytes)
-
-    try:
-        list_of_ds = Parallel(n_jobs=n_jobs, **parallel_params)(
-            delayed(_preprocess)(
-                ds,
-                i + offset,
-                preprocessors,
-                save_dir,
-                overwrite,
-                copy_data=(
-                    (parallel_processing and (save_dir is None))
-                    if copy_data is None
-                    else copy_data
-                ),
-            )
-            for i, ds in enumerate(concat_ds.datasets)
+
+    list_of_ds = Parallel(n_jobs=n_jobs, **parallel_params)(
+        delayed(_preprocess)(
+            ds,
+            i + offset,
+            preprocessors,
+            save_dir,
+            overwrite,
+            copy_data=(
+                (parallel_processing and (save_dir is None))
+                if copy_data is None
+                else copy_data
+            ),
         )
-    except (BufferError, ValueError, OSError) as exc:
-        msg = str(exc).lower().replace("-", "")
-        if "mmap" in msg and "readonly" in msg:
-            raise RuntimeError(
-                "Parallel preprocessing failed because joblib memory-mapped "
-                "a preloaded array that a preprocessor then attempted to "
-                "resize (e.g. ``filterbank``). Pass ``max_nbytes=None`` to "
-                "``preprocess`` to disable memory mapping, or supply a "
-                "``save_dir`` so the data is reloaded with ``preload=False``."
-            ) from exc
-        raise
+        for i, ds in enumerate(concat_ds.datasets)
+    )
 
     if save_dir is not None:  # Reload datasets and replace in concat_ds
         ids_to_load = [i + offset for i in range(len(concat_ds.datasets))]

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev997}/braindecode/preprocessing/windowers.py

@@ -498,7 +498,7 @@ def create_fixed_length_windows(
         EEGWindowsDataset objects with the extracted windows, depending on
         the value of ``use_mne_epochs``.
     """
-    stop_offset_samples, window_stride_samples, drop_last_window = (
+    stop_offset_samples, drop_last_window = (
         _check_and_set_fixed_length_window_arguments(
             start_offset_samples,
             stop_offset_samples,
@@ -1245,14 +1245,8 @@ def _check_and_set_fixed_length_window_arguments(
     lazy_metadata,
 ):
     """Raises warnings for incorrect input arguments and will set correct default values for
-    stop_offset_samples, window_stride_samples & drop_last_window, if necessary.
+    stop_offset_samples & drop_last_window, if necessary.
     """
-    # default stride to window size for non-overlapping windows
-    if window_size_samples is not None and window_stride_samples is None:
-        window_stride_samples = window_size_samples
-        if drop_last_window is None:
-            drop_last_window = True
-
     _check_windowing_arguments(
         start_offset_samples,
         stop_offset_samples,
@@ -1301,7 +1295,7 @@ def _check_and_set_fixed_length_window_arguments(
         raise ValueError(
             "Cannot have drop_last_window=False and lazy_metadata=True at the same time."
         )
-    return stop_offset_samples, window_stride_samples, drop_last_window
+    return stop_offset_samples, drop_last_window
 
 
 def _get_windowing_kwargs(windowing_func_locals):

braindecode-1.5.0.dev997/braindecode/version.py

@@ -0,0 +1 @@
+__version__ = "1.5.0.dev997"

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev997/braindecode.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.5.0.dev990
+Version: 1.5.0.dev997
 Summary: Deep learning software to decode EEG, ECG or MEG signals
 Author-email: Robin Tibor Schirrmeister <robintibor@gmail.com>, Bruno Aristimunha Pinto <b.aristimunha@gmail.com>, Alexandre Gramfort <agramfort@meta.com>
 Maintainer-email: Alexandre Gramfort <agramfort@meta.com>, Bruno Aristimunha Pinto <b.aristimunha@gmail.com>, Robin Tibor Schirrmeister <robintibor@gmail.com>
@@ -63,7 +63,6 @@ Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
 Requires-Dist: sphinx-autobuild; extra == "docs"
 Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
 Requires-Dist: sphinx_sitemap; extra == "docs"
-Requires-Dist: sphinxext-opengraph; extra == "docs"
 Requires-Dist: pydata_sphinx_theme; extra == "docs"
 Requires-Dist: numpydoc; extra == "docs"
 Requires-Dist: memory_profiler; extra == "docs"

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev997}/braindecode.egg-info/requires.txt

@@ -29,7 +29,6 @@ sphinx-autodoc-typehints
 sphinx-autobuild
 sphinxcontrib-bibtex
 sphinx_sitemap
-sphinxext-opengraph
 pydata_sphinx_theme
 numpydoc
 memory_profiler

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev997}/docs/cite.rst

@@ -21,7 +21,7 @@ You can use the following BibTeX entry:
 
 .. code-block:: bibtex
 
-    @misc{braindecode,
+    @software{braindecode,
       author = {Aristimunha, Bruno and
                 Guetschel, Pierre and
                 Wimpff, Martin and
@@ -41,9 +41,9 @@ You can use the following BibTeX entry:
                 Schirrmeister, Robin Tibor},
       title = {Braindecode: toolbox for decoding raw electrophysiological brain data
                with deep learning models},
-      howpublished = {Zenodo},
       url = {https://github.com/braindecode/braindecode},
       doi = {10.5281/zenodo.17699192},
+      publisher = {Zenodo},
       license = {BSD-3-Clause},
     }
 

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev997}/docs/conf.py

@@ -100,10 +100,8 @@ extensions = [
     "sphinx.ext.linkcode",
     "sphinx_sitemap",
     "sphinx_design",
-    "sphinxext.opengraph",
     "numpydoc",
     "gh_substitutions",
-    "zoo_data_gen",
 ]
 
 
@@ -350,9 +348,7 @@ html_theme_options = {
     },
     "footer_start": ["copyright"],
     # 'pygment_light_style': 'default',
-    # Analytics intentionally NOT configured here — the project uses GTM
-    # (GTM-NWDKLVNR) injected from _templates/layout.html as the single
-    # entry point. Adding theme analytics on top would double-count.
+    "analytics": dict(google_analytics_id="G-7Q43R82K6D"),
 }
 
 # The name of an image file (relative to this directory) to place at the top
@@ -363,16 +359,9 @@ html_logo = "_static/braindecode_symbol.png"
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
-# Files copied verbatim into the build root (robots.txt, etc.)
-html_extra_path = ["_extra"]
 html_css_files = [
     "style.css",
 ]
-# Note: landing.css and the landing JS files (zoo-data.js, landing.js)
-# are *not* registered globally — they only ship on the index page,
-# injected from `_templates/layout.html` under `pagename == 'index'`.
-# Loading them site-wide added ~2k lines of CSS + a third-party
-# Google-Fonts request to every doc page for no benefit.
 
 # Favicon for the site
 html_favicon = "_static/braindecode_symbol.png"
@@ -480,29 +469,8 @@ latex_documents = [
         "manual",
     ),
 ]
-# Master/dev builds publish under /dev/ on GitHub Pages (see
-# .github/workflows/docs.yml `destination_dir: dev`). The baseurl,
-# OG canonical, and the sitemap location must match the actual deploy
-# path or crawlers will end up on 404s.
-html_baseurl = "https://braindecode.org/dev/"
+html_baseurl = "https://braindecode.org"
 sitemap_filename = "sitemap.xml"
-# Flat URLs (no /en/{version}/) — same pattern as MOABB.
-sitemap_url_scheme = "{link}"
-
-# --- Open Graph / Twitter Card / meta description ---
-ogp_site_url = "https://braindecode.org/dev/"
-ogp_site_name = "Braindecode"
-ogp_image = "https://braindecode.org/dev/_static/braindecode_long.svg"
-ogp_image_alt = (
-    "Braindecode — open-source PyTorch toolbox for decoding raw EEG, ECoG and MEG"
-)
-ogp_description_length = 200
-ogp_enable_meta_description = True
-ogp_type = "website"
-ogp_custom_meta_tags = [
-    '<meta name="twitter:card" content="summary_large_image" />',
-    '<meta name="twitter:site" content="@braindecode" />',
-]
 # -- Fontawesome support -----------------------------------------------------
 
 # here the "fab" and "fas" refer to "brand" and "solid" (determines which font

braindecode-1.5.0.dev997/docs/index.rst

@@ -0,0 +1,48 @@
+..
+    The page title must be in rST for it to show in next/prev page buttons.
+    Therefore we add a special style rule to only this page that hides h1 tags
+
+.. raw:: html
+
+    <style type="text/css">h1 {display:none;}</style>
+
+######################
+ Braindecode Homepage
+######################
+
+.. LOGO
+
+.. image:: _static/braindecode.svg
+    :alt: Braindecode
+    :class: logo mainlogo only-light
+    :align: center
+
+.. image:: _static/braindecode.svg
+    :alt: Braindecode
+    :class: logo mainlogo only-dark
+    :align: center
+
+.. rst-class:: h4 text-center font-weight-light my-4
+
+    Braindecode is an open-source Python toolbox for decoding raw electrophysiological brain
+    data with deep learning models. It includes dataset fetchers, data preprocessing and
+    visualization tools, as well as implementations of several deep learning
+    architectures and data augmentations for analysis of EEG, ECoG and MEG.
+
+.. rst-class:: h4 text-center font-weight-light my-4
+
+    For neuroscientists who want to work with deep learning and
+    deep learning researchers who want to work with neurophysiological data.
+
+.. frontpage gallery is added by a conditional in _templates/layout.html
+
+.. toctree::
+    :hidden:
+
+    Install <install/install>
+    Models <models/models>
+    Cite <cite>
+    Tutorial and Examples <auto_examples/index>
+    API <api>
+    Get help <help>
+    What's new <whats_new>

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev997}/docs/whats_new.rst

@@ -28,13 +28,6 @@ Current 1.5.0 (GitHub)
 Enhancements
 ============
 
-- Redesign the documentation landing page (``docs/index.rst``) in a
-  pyhealth.dev-style layout: animated brain → EEG → net hero, fact strip
-  highlighting MOABB / EEGDash interoperability, interactive model-zoo
-  browser sourced from ``braindecode/models/summary.csv``, Hugging Face
-  Hub integration row, and a tutorial-thumbnail carousel. Adds
-  ``sphinxext-opengraph`` to docs extras and a ``SoftwareApplication``
-  JSON-LD block. (:gh:`1007` by `Bruno Aristimunha`_)
 - Tutorials now train for a few epochs then load pretrained weights from
   Hugging Face Hub to show full training curves and metrics. All 9 tutorial
   checkpoints published to ``huggingface.co/braindecode/``. The offline
@@ -173,10 +166,6 @@ Bug fixes
 - Fix ``TypeError: type 'Any' is not subscriptable`` when importing
   ``braindecode.models.config`` without ``numpydantic`` installed on
   Python 3.12+ (:gh:`871` by `Sarthak Tayal`_)
-- Fix :func:`braindecode.preprocessing.create_fixed_length_windows` crashing
-  when only ``window_size_samples`` is provided without ``window_stride_samples``,
-  stride now defaults to window size as documented
-  (:gh:`990` by `Sarthak Tayal`_)
 - Add ``channel_embedding`` parameter to :class:`braindecode.models.SignalJEPA` and
   :class:`braindecode.models.SignalJEPA_Contextual` to load pre-trained channel
   embedding weights when fine-tuning on a subset of the pre-training channels.
@@ -293,11 +282,6 @@ Requirements
 
 Bugs
 =====
-- Improve the error message when :meth:`from_pretrained` or :meth:`push_to_hub`
-  are called without the optional ``huggingface_hub`` dependency installed.
-  Users now get a clear :class:`ImportError` with installation instructions
-  (``pip install 'braindecode[hub]'``) instead of an ``AttributeError``.
-  (:gh:`1024` by `@copilot`_)
 - Fix the documentation header "Cite Braindecode" announcement link: it used a bare
   ``cite.html`` URL, which browsers resolve relative to the current page path and led
   to 404s (for example from ``install/install.html``). The link is now built with
@@ -350,14 +334,6 @@ Bugs
   marked all model-specific parameters as "The description is missing"
   when ``DOCSTRING_INHERITANCE_ENABLE=1`` was set during documentation
   builds (:gh:`971` by `Bruno Aristimunha`_)
-- Expose ``max_nbytes`` directly on
-  :func:`braindecode.preprocessing.preprocess.preprocess` and turn the
-  cryptic ``mmap can't resize a readonly`` failure (raised when joblib
-  memory-maps a preloaded array that a preprocessor later tries to
-  resize) into an actionable error explaining how to fix it: pass
-  ``max_nbytes=None`` to disable memory mapping, or supply a ``save_dir``
-  so data is reloaded with ``preload=False``
-  (:gh:`325` by `Sarthak Tayal`_)
 
 Code health
 ============

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev997}/pyproject.toml

@@ -100,7 +100,6 @@ docs = [
     'sphinx-autobuild',
     'sphinxcontrib-bibtex',
     'sphinx_sitemap',
-    'sphinxext-opengraph',
     'pydata_sphinx_theme',
     'numpydoc',
     'memory_profiler',

braindecode-1.5.0.dev990/braindecode/version.py

@@ -1 +0,0 @@
-__version__ = "1.5.0.dev990"