braindecode 1.7.0.dev174022531__tar.gz → 1.7.0.dev182642410__tar.gz

{braindecode-1.7.0.dev174022531/braindecode.egg-info → braindecode-1.7.0.dev182642410}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.7.0.dev174022531
+Version: 1.7.0.dev182642410
 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>

{braindecode-1.7.0.dev174022531 → braindecode-1.7.0.dev182642410}/braindecode/eegneuralnet.py

@@ -8,7 +8,7 @@ import abc
 import inspect
 import logging
 import warnings
-from typing import Literal
+from typing import Any, Literal
 
 import mne
 import numpy as np
@@ -20,7 +20,7 @@ from skorch.utils import noop, to_numpy, train_loss_score, valid_loss_score
 
 from braindecode.datautil import infer_signal_properties
 
-from .models.util import models_dict
+from .models.util import _get_model_class
 from .training.scoring import (
     CroppedTimeSeriesEpochScoring,
     CroppedTrialEpochScoring,
@@ -30,13 +30,10 @@ from .training.scoring import (
 log = logging.getLogger(__name__)
 
 
-def _get_model(model: str):
+def _get_model(model: Any) -> Any:
     """Returns the corresponding class in case the model passed is a string."""
     if isinstance(model, str):
-        if model in models_dict:
-            model = models_dict[model]
-        else:
-            raise ValueError(f"Unknown model name {model!r}.")
+        model = _get_model_class(model)
     return model
 
 

{braindecode-1.7.0.dev174022531 → braindecode-1.7.0.dev182642410}/braindecode/models/__init__.py

@@ -66,6 +66,7 @@ from .util import (
     _init_models_dict,
     build_model_config,
     extract_channel_locations_from_chs_info,
+    interpolated_models_dict,
     models_mandatory_parameters,
     positions_from_chs_info,
 )
@@ -145,4 +146,5 @@ __all__ = [
     "build_model_config",
     "_init_models_dict",
     "models_mandatory_parameters",
+    "interpolated_models_dict",
 ]

{braindecode-1.7.0.dev174022531 → braindecode-1.7.0.dev182642410}/braindecode/models/config.py

@@ -11,7 +11,9 @@ from typing_extensions import TypedDict
 from braindecode.models.base import EEGModuleMixin
 from braindecode.models.util import (
     SigArgName,
+    _get_model_class,
     _init_models_dict,
+    interpolated_models_dict,
     models_dict,
     models_mandatory_parameters,
 )
@@ -65,9 +67,7 @@ class BaseBraindecodeModelConfig(pydantic.BaseModel):
     """Base class for braindecode model pydantic configs."""
 
     def create_instance(self) -> EEGModuleMixin:
-        if self.model_name_ not in models_dict:
-            _init_models_dict()
-        model_cls = models_dict[self.model_name_]
+        model_cls = _get_model_class(self.model_name_)
         kwargs = self.model_dump(mode="python", exclude={"model_name_"})
         if kwargs.get("n_chans") is not None and kwargs.get("chs_info") is not None:
             kwargs.pop("n_chans")
@@ -208,12 +208,12 @@ def make_model_config(
 # and define __all__ based on generated classes
 __all__ = ["make_model_config"]
 
-if not models_dict:
+if not models_dict and not interpolated_models_dict:
     _init_models_dict()
 
 models_configs: list[type[BaseBraindecodeModelConfig]] = []
 for model_name, req, _ in models_mandatory_parameters:
-    model_cls = models_dict[model_name]
+    model_cls = _get_model_class(model_name)
     model_cfg = make_model_config(model_cls, req)
     globals()[model_cfg.__name__] = model_cfg
     __all__.append(model_cfg.__name__)

{braindecode-1.7.0.dev174022531 → braindecode-1.7.0.dev182642410}/braindecode/models/util.py

@@ -16,6 +16,12 @@ import torch  # noqa: F401  # exposed so TorchScript can resolve ``torch`` throu
 from torch import nn
 
 models_dict = {}
+# Interpolated models are channel-interpolating wrappers around existing
+# braindecode backbones (see :func:`braindecode.models.InterpolatedModel`).
+# They are derivatives of existing models rather than standalone
+# architectures, so they are kept in a separate registry to avoid polluting
+# ``models_dict`` (e.g. for benchmarking that iterates over all "real" models).
+interpolated_models_dict = {}
 
 _IMPORT_ADAPTER = pydantic.TypeAdapter(pydantic.ImportString)
 
@@ -189,7 +195,45 @@ def _init_models_dict():
             issubclass(m[1], models.base.EEGModuleMixin)
             and m[1] != models.base.EEGModuleMixin
         ):
-            models_dict[m[0]] = m[1]
+            # Interpolated models are wrappers around existing backbones
+            # (identified by the ``_TARGET_CHS_INFO`` class attribute set by
+            # :func:`braindecode.models.InterpolatedModel`). Keep them in a
+            # dedicated registry instead of ``models_dict``.
+            if getattr(m[1], "_TARGET_CHS_INFO", None) is not None:
+                interpolated_models_dict[m[0]] = m[1]
+            else:
+                models_dict[m[0]] = m[1]
+
+
+def _get_model_class(model_name: str):
+    """Return the model class registered under ``model_name``.
+
+    Searches both the standard :data:`models_dict` and the
+    :data:`interpolated_models_dict` so that interpolated models remain
+    resolvable by name (e.g. for skorch wrappers and pydantic configs).
+
+    Parameters
+    ----------
+    model_name : str
+        Name of the model class to retrieve.
+
+    Returns
+    -------
+    type
+        The model class registered under ``model_name``.
+
+    Raises
+    ------
+    ValueError
+        If ``model_name`` is not found in either registry.
+    """
+    if not models_dict and not interpolated_models_dict:
+        _init_models_dict()
+    if model_name in models_dict:
+        return models_dict[model_name]
+    if model_name in interpolated_models_dict:
+        return interpolated_models_dict[model_name]
+    raise ValueError(f"Unknown model name {model_name!r}.")
 
 
 # Keep in sync with _EEG_PARAMS above.

braindecode-1.7.0.dev182642410/braindecode/version.py

@@ -0,0 +1 @@
+__version__ = "1.7.0.dev182642410"

{braindecode-1.7.0.dev174022531 → braindecode-1.7.0.dev182642410/braindecode.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.7.0.dev174022531
+Version: 1.7.0.dev182642410
 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>

{braindecode-1.7.0.dev174022531 → braindecode-1.7.0.dev182642410}/docs/index.rst

@@ -161,7 +161,7 @@
       <div class="container bd-facts-inner">
         <span class="bd-facts-label">By the numbers</span>
         <div class="bd-facts-row">
-          <a href="models/models.html"><b>65+</b> models</a>
+          <a href="models/models_table.html"><b>65+</b> models</a>
           <a href="api.html#augmentation"><b>20+</b> augmentations</a>
           <a href="https://moabb.neurotechx.com/" target="_blank" rel="noopener"><b>150+</b> datasets <span style="color:var(--bd-muted)">via MOABB</span></a>
           <a href="https://eegdash.org/" target="_blank" rel="noopener"><b>700+</b> datasets <span style="color:var(--bd-muted)">via EEGDash</span></a>
@@ -224,7 +224,7 @@
           <p class="section-sub">Built to <strong>plug into the EEG ecosystem you already use</strong>: every <a href="https://moabb.neurotechx.com/" target="_blank" rel="noopener">MOABB</a> dataset, every <a href="https://mne.tools/" target="_blank" rel="noopener">MNE-Python</a> preprocessing function, every <a href="https://scikit-learn.org/" target="_blank" rel="noopener">scikit-learn</a> training loop, plus 700+ BIDS datasets via <a href="https://eegdash.org/" target="_blank" rel="noopener">EEGDash</a>. One library, no lock-in.</p>
         </div>
         <div class="feature-grid">
-          <a href="models/models.html" class="feature-card">
+          <a href="models/models_table.html" class="feature-card">
             <span class="feature-icon"><svg width="26" height="26" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><path d="M2 12c2-4 4-4 6 0s4 4 6 0 4-4 6 0 4 4 2 0"/></svg></span>
             <h3>Decode raw electrophysiology</h3>
             <p>End-to-end models go straight from raw EEG/ECoG/MEG to predictions. No hand-crafted features required.</p>
@@ -248,7 +248,7 @@
             <p>Fully compatible with every <a class="feature-inline-link" href="https://mne.tools/" target="_blank" rel="noopener">MNE</a> preprocessing function and with <a class="feature-inline-link" href="https://eegprep.org/" target="_blank" rel="noopener">EEGPrep</a>, plus exponential standardization and 20+ EEG augmentations.</p>
             <a href="api.html#augmentation" class="feature-link">Augmentation <svg width="12" height="12" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.7" stroke-linecap="round" stroke-linejoin="round"><path d="M5 12h14M13 5l7 7-7 7"/></svg></a>
           </div>
-          <a href="models/models.html" class="feature-card">
+          <a href="models/models_table.html" class="feature-card">
             <span class="feature-icon"><svg width="26" height="26" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"><circle cx="6" cy="6" r="2"/><circle cx="6" cy="18" r="2"/><circle cx="18" cy="12" r="2"/><path d="M8 6h2a3 3 0 0 1 3 3v0a3 3 0 0 0 3 3M8 18h2a3 3 0 0 0 3-3v0a3 3 0 0 1 3-3"/></svg></span>
             <h3>Curated model zoo</h3>
             <p>EEGNeX, ConvNets, ATCNet, EEGConformer, foundation models. 60+ architectures reproduced from the original papers.</p>
@@ -359,7 +359,7 @@
         <div class="zoo-grid"><!-- populated by landing.js --></div>
         <div class="zoo-foot">
           <span class="zoo-foot-count">Loading…</span>
-          <a href="models/models.html">Browse the full zoo on the Models page <svg width="12" height="12" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.7" stroke-linecap="round" stroke-linejoin="round"><path d="M5 12h14M13 5l7 7-7 7"/></svg></a>
+          <a href="models/models_table.html">Browse the full zoo on the Models table <svg width="12" height="12" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.7" stroke-linecap="round" stroke-linejoin="round"><path d="M5 12h14M13 5l7 7-7 7"/></svg></a>
         </div>
       </div>
     </section>
@@ -521,7 +521,7 @@
               <span class="pipeline-col-name">Modeling</span>
             </div>
             <div class="pipeline-col-cards">
-              <a class="pipeline-card" href="models/models.html">
+              <a class="pipeline-card" href="models/models_table.html">
                 <span class="pipeline-card-icon"><svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.7" stroke-linecap="round" stroke-linejoin="round"><circle cx="6" cy="6" r="2"/><circle cx="6" cy="18" r="2"/><circle cx="18" cy="12" r="2"/><path d="M8 6h2a3 3 0 0 1 3 3v0a3 3 0 0 0 3 3M8 18h2a3 3 0 0 0 3-3v0a3 3 0 0 1 3-3"/></svg></span>
                 <span class="pipeline-card-text">
                   <span class="pipeline-card-name">braindecode.models</span>
@@ -679,7 +679,7 @@
             <ul>
               <li><a href="install/install.html">Install</a></li>
               <li><a href="auto_examples/index.html">Tutorials</a></li>
-              <li><a href="models/models.html">Models</a></li>
+              <li><a href="models/models_table.html">Models</a></li>
               <li><a href="api.html">API reference</a></li>
             </ul>
           </div>

{braindecode-1.7.0.dev174022531 → braindecode-1.7.0.dev182642410}/docs/models/models.rst

@@ -68,12 +68,12 @@ With this, in this model's sub-pages, we provide:
     - 4. :doc:`A visualization of the common important information from the models
          <models_visualization>`.
 
-.. button-ref:: models_categorization
+.. button-ref:: models_table
     :ref-type: doc
     :color: primary
     :expand:
 
-    Next: Models categorization →
+    Browse the models table →
 
 .. rubric:: References
 

{braindecode-1.7.0.dev174022531 → braindecode-1.7.0.dev182642410}/docs/models/models_table.rst

@@ -191,6 +191,15 @@ Braindecode.
       // Initial color pass
       applyTagPalette(document);
 
+      function applyInitialModelFilter() {
+        var model = new URLSearchParams(window.location.search).get('model');
+        if (!model) return;
+        table.search(model).draw();
+        $(table.table().container()).find('div.dataTables_filter input').val(model);
+      }
+
+      applyInitialModelFilter();
+
       /* --- Bonus UX: click a column header to open panes focused there ----- */
       $('.sortable thead th').each(function (i) {
         if (!FILTER_COLS.includes(i)) return;

{braindecode-1.7.0.dev174022531 → braindecode-1.7.0.dev182642410}/docs/whats_new.rst

@@ -28,12 +28,18 @@ Current 1.7.0 (GitHub)
 Enhancements
 ============
 
-- None yet
+- Add :data:`braindecode.models.util.interpolated_models_dict`, a dedicated
+  registry for the interpolated (channel-adapting) models, keeping them separate
+  from :data:`braindecode.models.util.models_dict` (:gh:`1093` by `Bruno Aristimunha`_)
 
 API and behavior changes
 ========================
 
-- None yet
+- Interpolated models (e.g. ``InterpolatedBIOT``, ``InterpolatedLaBraM``) are no
+  longer included in :data:`braindecode.models.util.models_dict`; they now live
+  in the separate :data:`braindecode.models.util.interpolated_models_dict`
+  registry. They remain fully usable and resolvable by name in the skorch
+  wrappers and pydantic configs (:gh:`1093` by `Bruno Aristimunha`_)
 
 Requirements
 ============

braindecode-1.7.0.dev174022531/braindecode/version.py

@@ -1 +0,0 @@
-__version__ = "1.7.0.dev174022531"