Braindecode 1.5.0.dev990__tar.gz → 1.5.0.dev996__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.5.0.dev990
+Version: 1.5.0.dev996
 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>
@@ -43,8 +43,6 @@ Requires-Dist: eegprep[eeglabio]>=0.2.23; extra == "eegprep"
 Provides-Extra: hub
 Requires-Dist: huggingface_hub[torch]>=0.20.0; extra == "hub"
 Requires-Dist: zarr>=3.0; extra == "hub"
-Provides-Extra: viz
-Requires-Dist: captum>=0.7.0; extra == "viz"
 Provides-Extra: tests
 Requires-Dist: pytest; extra == "tests"
 Requires-Dist: pytest-cov; extra == "tests"
@@ -63,7 +61,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"
@@ -73,7 +70,7 @@ Requires-Dist: sphinx_design; extra == "docs"
 Requires-Dist: lightning; extra == "docs"
 Requires-Dist: seaborn; extra == "docs"
 Requires-Dist: pre-commit; extra == "docs"
-Requires-Dist: openneuro-py>=2026.4.0; extra == "docs"
+Requires-Dist: openneuro-py; extra == "docs"
 Requires-Dist: plotly; extra == "docs"
 Requires-Dist: shap; extra == "docs"
 Requires-Dist: nbformat; extra == "docs"
@@ -85,7 +82,6 @@ Requires-Dist: braindecode[docs]; extra == "all"
 Requires-Dist: braindecode[hub]; extra == "all"
 Requires-Dist: braindecode[eegprep]; extra == "all"
 Requires-Dist: braindecode[typing]; extra == "all"
-Requires-Dist: braindecode[viz]; extra == "all"
 Dynamic: license-file
 
 .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.17699192.svg

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev996}/braindecode/datasets/sleep_physionet.py

@@ -6,12 +6,10 @@
 from __future__ import annotations
 
 import os
-import time
 
 import mne
 import numpy as np
 import pandas as pd
-import requests
 from mne.datasets.sleep_physionet.age import fetch_data
 
 from .base import BaseConcatDataset, RawDataset
@@ -61,19 +59,7 @@ class SleepPhysionet(BaseConcatDataset):
         if recording_ids is None:
             recording_ids = [1, 2]
 
-        max_attempts = 5
-        retry_delay_s = 10
-
-        for attempt in range(max_attempts):
-            try:
-                paths = fetch_data(
-                    subject_ids, recording=recording_ids, on_missing="warn"
-                )
-                break
-            except requests.exceptions.RequestException:
-                if attempt == max_attempts - 1:
-                    raise
-                time.sleep(retry_delay_s)
+        paths = fetch_data(subject_ids, recording=recording_ids, on_missing="warn")
 
         all_base_ds = list()
         for p in paths:

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev996}/braindecode/models/__init__.py

@@ -25,7 +25,6 @@ from .eegpt import EEGPT
 from .eegsimpleconv import EEGSimpleConv
 from .eegsym import EEGSym
 from .eegtcnet import EEGTCNet
-from .emg2qwerty import EMG2QwertyNet
 from .fbcnet import FBCNet
 from .fblightconvnet import FBLightConvNet
 from .fbmsnet import FBMSNet
@@ -96,7 +95,6 @@ __all__ = [
     "EEGSimpleConv",
     "EEGTCNet",
     "DGCNN",
-    "EMG2QwertyNet",
     "FBCNet",
     "FBLightConvNet",
     "FBMSNet",

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev996}/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.dev996}/braindecode/models/summary.csv

@@ -40,7 +40,6 @@ USleep,Sleep Staging,Classification,128,"n_chans, n_outputs, n_times, sfreq",248
 FBCNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times, sfreq",11812,"FCNet(n_chans=22, n_outputs=4, n_times=1000, sfreq=250)","Convolution,FilterBank"
 FBMSNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times, sfreq",16231,"FBMSNet(n_chans=22, n_outputs=4, n_times=1000, sfreq=250)","Convolution,FilterBank"
 MetaNeuromotorHand,Handwriting (sEMG),CTC Sequence,2000,"n_chans, n_outputs, n_times, sfreq",1021284,"MetaNeuromotorHand(n_chans=16, n_outputs=100, n_times=32000, sfreq=2000)","Convolution,Attention/Transformer"
-EMG2QwertyNet,Touch typing (sEMG),CTC Sequence,2000,"n_chans, n_outputs, n_times, sfreq",5293315,"EMG2QwertyNet(n_chans=32, n_outputs=99, n_times=8000, sfreq=2000)","Convolution"
 FBLightConvNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times, sfreq",6596,"FBLightConvNet(n_chans=22, n_outputs=4, n_times=1000, sfreq=250)","Convolution,FilterBank"
 IFNet,Motor Imagery,Classification,250,"n_chans, n_outputs, n_times, sfreq",9860,"IFNet(n_chans=22, n_outputs=4, n_times=1000, sfreq=250)","Convolution,FilterBank"
 BrainModule,Speech Decoding,Classification,250,"n_chans, n_outputs, n_times, sfreq",6186909,"BrainModule(n_chans=64, n_outputs=29, n_times=160, sfreq=1000)","Convolution"

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev996}/braindecode/models/util.py

@@ -347,17 +347,6 @@ models_mandatory_parameters: list[
             "n_outputs": 100,
         },
     ),
-    (
-        "EMG2QwertyNet",
-        ["n_chans", "n_outputs", "n_times", "sfreq"],
-        {
-            "n_chans": 32,
-            "n_times": 8000,
-            "sfreq": 2000.0,
-            "input_window_seconds": 4.0,
-            "n_outputs": 99,
-        },
-    ),
     ("FBLightConvNet", ["n_chans", "n_outputs", "n_times", "sfreq"], {"sfreq": 200.0}),
     ("IFNet", ["n_chans", "n_outputs", "n_times", "sfreq"], {"sfreq": 200.0}),
     ("PBT", ["n_chans", "n_outputs", "n_times"], None),
@@ -408,7 +397,6 @@ non_classification_models = [
     "InterpolatedSignalJEPA",
     # Emits a (batch, T_out, vocab) sequence for CTC, not class logits.
     "MetaNeuromotorHand",
-    "EMG2QwertyNet",
 ]
 
 ################################################################

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev996}/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.dev996}/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.dev996/braindecode/version.py

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

braindecode-1.5.0.dev996/braindecode/visualization/__init__.py

@@ -0,0 +1,8 @@
+"""
+Functions for visualisations, especially of the ConvNets.
+"""
+
+from .confusion_matrices import plot_confusion_matrix
+from .gradients import compute_amplitude_gradients
+
+__all__ = ["compute_amplitude_gradients", "plot_confusion_matrix"]

braindecode-1.5.0.dev996/braindecode/visualization/gradients.py

@@ -0,0 +1,62 @@
+# Authors: Robin Schirrmeister <robintibor@gmail.com>
+#          Sarthak Tayal <sarthaktayal2@gmail.com>
+#
+# License: BSD (3-clause)
+
+import numpy as np
+import torch
+from skorch.utils import to_numpy, to_tensor
+
+from braindecode.util import set_random_seeds
+
+
+def compute_amplitude_gradients(model, dataset, batch_size, seed=20240205):
+    """Compute amplitude gradients after seeding for reproducibility."""
+    cuda = next(model.parameters()).is_cuda
+    set_random_seeds(seed=seed, cuda=cuda)
+    loader = torch.utils.data.DataLoader(
+        dataset, batch_size=batch_size, drop_last=False, shuffle=False
+    )
+    all_amp_grads = []
+    for batch_X, _, _ in loader:
+        this_amp_grads = compute_amplitude_gradients_for_X(
+            model,
+            batch_X,
+        )
+        all_amp_grads.append(this_amp_grads)
+    all_amp_grads = np.concatenate(all_amp_grads, axis=1)
+    return all_amp_grads
+
+
+def compute_amplitude_gradients_for_X(model, X):
+    device = next(model.parameters()).device
+    ffted = np.fft.rfft(X, axis=2)
+    amps = np.abs(ffted)
+    phases = np.angle(ffted)
+    amps_th = to_tensor(amps.astype(np.float32), device=device).requires_grad_(True)
+    phases_th = to_tensor(phases.astype(np.float32), device=device).requires_grad_(True)
+
+    # rebuild fft coefficients from amplitude and phase as real valued pairs,
+    # convert to complex, and invert back to the time domain.
+    # torch.irfft was removed after being deprecated since pytorch 1.7,
+    # so we use torch.fft.irfft which expects complex input directly.
+    fft_coefs = amps_th.unsqueeze(-1) * torch.stack(
+        (torch.cos(phases_th), torch.sin(phases_th)), dim=-1
+    )
+    fft_coefs = fft_coefs.squeeze(3)
+
+    complex_fft_coefs = torch.view_as_complex(fft_coefs)
+    iffted = torch.fft.irfft(complex_fft_coefs, n=X.shape[2], dim=2)
+
+    outs = model(iffted)
+
+    n_filters = outs.shape[1]
+    amp_grads_per_filter = np.full((n_filters,) + ffted.shape, np.nan, dtype=np.float32)
+    for i_filter in range(n_filters):
+        mean_out = torch.mean(outs[:, i_filter])
+        mean_out.backward(retain_graph=True)
+        amp_grads = to_numpy(amps_th.grad.clone())
+        amp_grads_per_filter[i_filter] = amp_grads
+        amps_th.grad.zero_()
+    assert not np.any(np.isnan(amp_grads_per_filter))
+    return amp_grads_per_filter

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.5.0.dev990
+Version: 1.5.0.dev996
 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>
@@ -43,8 +43,6 @@ Requires-Dist: eegprep[eeglabio]>=0.2.23; extra == "eegprep"
 Provides-Extra: hub
 Requires-Dist: huggingface_hub[torch]>=0.20.0; extra == "hub"
 Requires-Dist: zarr>=3.0; extra == "hub"
-Provides-Extra: viz
-Requires-Dist: captum>=0.7.0; extra == "viz"
 Provides-Extra: tests
 Requires-Dist: pytest; extra == "tests"
 Requires-Dist: pytest-cov; extra == "tests"
@@ -63,7 +61,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"
@@ -73,7 +70,7 @@ Requires-Dist: sphinx_design; extra == "docs"
 Requires-Dist: lightning; extra == "docs"
 Requires-Dist: seaborn; extra == "docs"
 Requires-Dist: pre-commit; extra == "docs"
-Requires-Dist: openneuro-py>=2026.4.0; extra == "docs"
+Requires-Dist: openneuro-py; extra == "docs"
 Requires-Dist: plotly; extra == "docs"
 Requires-Dist: shap; extra == "docs"
 Requires-Dist: nbformat; extra == "docs"
@@ -85,7 +82,6 @@ Requires-Dist: braindecode[docs]; extra == "all"
 Requires-Dist: braindecode[hub]; extra == "all"
 Requires-Dist: braindecode[eegprep]; extra == "all"
 Requires-Dist: braindecode[typing]; extra == "all"
-Requires-Dist: braindecode[viz]; extra == "all"
 Dynamic: license-file
 
 .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.17699192.svg

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev996}/braindecode.egg-info/SOURCES.txt

@@ -77,7 +77,6 @@ braindecode/models/eegpt.py
 braindecode/models/eegsimpleconv.py
 braindecode/models/eegsym.py
 braindecode/models/eegtcnet.py
-braindecode/models/emg2qwerty.py
 braindecode/models/fbcnet.py
 braindecode/models/fblightconvnet.py
 braindecode/models/fbmsnet.py
@@ -133,12 +132,8 @@ braindecode/training/callbacks.py
 braindecode/training/losses.py
 braindecode/training/scoring.py
 braindecode/visualization/__init__.py
-braindecode/visualization/attribution.py
 braindecode/visualization/confusion_matrices.py
-braindecode/visualization/frequency.py
-braindecode/visualization/metrics.py
-braindecode/visualization/sanity.py
-braindecode/visualization/topology.py
+braindecode/visualization/gradients.py
 docs/Makefile
 docs/api.rst
 docs/cite.rst

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

@@ -20,7 +20,6 @@ braindecode[docs]
 braindecode[hub]
 braindecode[eegprep]
 braindecode[typing]
-braindecode[viz]
 
 [docs]
 sphinx_gallery
@@ -29,7 +28,6 @@ sphinx-autodoc-typehints
 sphinx-autobuild
 sphinxcontrib-bibtex
 sphinx_sitemap
-sphinxext-opengraph
 pydata_sphinx_theme
 numpydoc
 memory_profiler
@@ -39,7 +37,7 @@ sphinx_design
 lightning
 seaborn
 pre-commit
-openneuro-py>=2026.4.0
+openneuro-py
 plotly
 shap
 nbformat
@@ -67,6 +65,3 @@ bids_validator
 [typing]
 exca>=0.5.10
 numpydantic>=1.7
-
-[viz]
-captum>=0.7.0

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev996}/docs/api.rst

@@ -153,7 +153,6 @@ interface for all EEG models and can derive variable names when needed.
      EEGSimpleConv
      EEGSym
      EEGTCNet
-     EMG2QwertyNet
      FBCNet
      FBLightConvNet
      FBMSNet
@@ -803,107 +802,16 @@ Functions available in braindecode util module.
  Visualization
 ***************
 
-Tools for opening up trained EEG decoders: per-trial attribution maps, sanity-check
-protocols that probe whether those maps reflect what the model actually learned,
-attribution-quality metrics, topographic projection, and confusion-matrix plotting.
-
-The end-to-end workflow tracks the EEG-XAI benchmark of Sujatha Ravindran &
-Contreras-Vidal (Sci Rep 2023, DOI `10.1038/s41598-023-43871-8
-<https://doi.org/10.1038/s41598-023-43871-8>`_): compute attributions, randomize labels
-and weights, score the resulting maps against the trained-model reference, and decide
-which methods are trustworthy on your data. See the :ref:`interpretability tutorial
-<interpretability-tutorial>` for a worked example on BCI IV 2a.
+Visualization module contains functions for visualizing EEG data, including plotting the
+confusion matrix and computing amplitude gradients. The visualization module is useful
+for understanding the performance of the model and for interpreting the results.
 
 :py:mod:`braindecode.visualization`:
 
 .. currentmodule:: braindecode.visualization
 
-Time-domain attribution
-=======================
-
-Per-trial attribution maps in the input domain. Each function takes ``(model, x,
-target)`` and returns a tensor with the same spatial shape as ``x``; all are thin
-wrappers around `captum <https://captum.ai/>`_ (a soft dependency installed via ``pip
-install braindecode[viz]``) and raise :class:`ImportError` without it.
-
-.. autosummary::
-    :toctree: generated/
-
-     saliency
-     input_x_gradient
-     integrated_gradients
-     layer_grad_cam
-     guided_backprop
-     deconvolution
-     deep_lift
-     lrp
-
-Frequency-domain attribution
-============================
-
-Gradient of each model output with respect to the **amplitude spectrum** of the input —
-a complement to the time-domain methods that makes oscillatory contributions (e.g.
-alpha/beta motor imagery) visible directly in the topomap. Implemented in pure PyTorch
-via ``rfft``/``irfft`` round-tripping; no captum needed.
-
-.. autosummary::
-    :toctree: generated/
-
-     amplitude_gradients
-     amplitude_gradients_per_trial
-
-Sanity-check protocols
-======================
-
-Adebayo et al. (NeurIPS 2018) randomization checks for attribution maps, reused on EEG
-decoders by Sujatha Ravindran & Contreras-Vidal. :func:`random_target` powers the
-**label-randomization** check (does the map change when you ask about the wrong class?)
-and :func:`cascading_layer_reset` powers the **weight-randomization** check (does the
-map collapse as the trained weights are progressively replaced?). An attribution method
-that survives both is suspicious — its output likely reflects architecture rather than
-learning.
-
-.. autosummary::
-    :toctree: generated/
-
-     random_target
-     cascading_layer_reset
-
-Attribution-quality metrics
-===========================
-
-Score how similar two attribution maps are: typically a trained-model attribution
-against a randomized-model attribution, or against a ground-truth mask from a simulator.
-:func:`compute_metrics` returns twelve cosine / Pearson / mass-accuracy / rank-accuracy
-variants; :func:`compute_ssim_metrics` adds four SSIM-based scores using a pure-torch
-reimplementation of skimage's structural similarity (no extra dependency). Pass
-``chs_info=`` to score topographic projections instead of raw attribution maps.
-
-.. autosummary::
-    :toctree: generated/
-
-     compute_metrics
-     compute_ssim_metrics
-     METRIC_NAMES
-     SSIM_METRIC_NAMES
-
-Topography
-==========
-
-Project per-channel scalar values onto a 2-D scalp topomap grid via Clough-Tocher
-triangulation on MNE-derived sensor coordinates. Returns a plain ``ndarray`` so callers
-can compose with their own plotting stack rather than going through
-:func:`mne.viz.plot_topomap` (and its matplotlib roundtrip).
-
-.. autosummary::
-    :toctree: generated/
-
-     project_to_topomap
-
-Plotting
-========
-
 .. autosummary::
     :toctree: generated/
 
+     compute_amplitude_gradients
      plot_confusion_matrix

{braindecode-1.5.0.dev990 → braindecode-1.5.0.dev996}/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.dev996}/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