Braindecode 1.8.0.dev180516540__tar.gz → 1.8.0.dev180935432__tar.gz

{braindecode-1.8.0.dev180516540/braindecode.egg-info → braindecode-1.8.0.dev180935432}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.8.0.dev180516540
+Version: 1.8.0.dev180935432
 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>
@@ -34,6 +34,7 @@ Requires-Dist: pandas
 Requires-Dist: wfdb>=4.3.1
 Requires-Dist: linear_attention_transformer
 Requires-Dist: docstring_inheritance
+Requires-Dist: rotary_embedding_torch
 Requires-Dist: pydantic>=2.0
 Provides-Extra: moabb
 Requires-Dist: moabb>=1.4.3; extra == "moabb"
@@ -50,7 +51,6 @@ Requires-Dist: pytest-cov; extra == "tests"
 Requires-Dist: codecov; extra == "tests"
 Requires-Dist: pytest_cases; extra == "tests"
 Requires-Dist: mypy; extra == "tests"
-Requires-Dist: ipython; extra == "tests"
 Requires-Dist: transformers>=4.57.0; extra == "tests"
 Requires-Dist: bids_validator; extra == "tests"
 Provides-Extra: typing

{braindecode-1.8.0.dev180516540 → braindecode-1.8.0.dev180935432}/braindecode/datasets/base.py

@@ -32,7 +32,6 @@ from mne.utils.docs import deprecated
 from torch.utils.data import ConcatDataset, Dataset, IterableDataset
 from typing_extensions import TypeVar
 
-from ._notebook_viewer import plot as _viewer_plot
 from .bids.hub import HubDatasetMixin
 from .bids.hub_io import _restore_nan_from_json
 from .registry import register_dataset
@@ -1175,8 +1174,6 @@ class BaseConcatDataset(ConcatDataset, HubDatasetMixin, Generic[T]):
         If True, defer computing cumulative sizes until length or item access.
     """
 
-    plot = _viewer_plot  # eegdash-viewer embed; a direct member so the API docs list it
-
     datasets: list[T]
 
     def __init__(

{braindecode-1.8.0.dev180516540 → braindecode-1.8.0.dev180935432}/braindecode/functional/functions.py

@@ -40,7 +40,7 @@ def drop_path(
     x : torch.Tensor
         input tensor
     drop_prob : float, optional
-        probability of dropping a path, by default 0.0
+        survival rate (i.e. probability of being kept), by default 0.0
     training : bool, optional
         whether the model is in training mode, by default False
     scale_by_keep : bool, optional
@@ -68,10 +68,9 @@ def drop_path(
     shape = (x.shape[0],) + (1,) * (
         x.ndim - 1
     )  # work with diff dim tensors, not just 2D ConvNets
-    probabilities = torch.full(shape, keep_prob, dtype=torch.float32, device=x.device)
-    random_tensor = torch.bernoulli(probabilities).to(dtype=x.dtype)
+    random_tensor = x.new_empty(shape).bernoulli_(keep_prob)
     if keep_prob > 0.0 and scale_by_keep:
-        random_tensor = random_tensor / keep_prob
+        random_tensor.div_(keep_prob)
     return x * random_tensor
 
 

{braindecode-1.8.0.dev180516540 → braindecode-1.8.0.dev180935432}/braindecode/models/base.py

@@ -80,7 +80,7 @@ class _BraindecodeDocstringMeta(NumpyDocstringInheritanceInitMeta):
     unwrapped function and correctly inherits ``cls.__doc__``.
     """
 
-    def __init__(cls, class_name, class_bases, class_dict, **kwargs):
+    def __init__(cls, class_name, class_bases, class_dict):
         super().__init__(class_name, class_bases, class_dict)
         # Only wrap subclass __init__s, not EEGModuleMixin itself.
         # Wrapping the mixin would cause super().__init__() calls to
@@ -214,8 +214,6 @@ class EEGModuleMixin(_BaseHubMixin, metaclass=_BraindecodeDocstringMeta):
     __jit_unused_properties__ = ["chs_info"]
 
     def __init_subclass__(cls, **kwargs):
-        license = kwargs.pop("license", "bsd-3-clause")
-
         # TorchScript only honours ``__jit_ignored_attributes__`` for
         # properties defined directly on the concrete class: it collects them
         # with ``vars(type(module))``, which skips inherited ones. Rebinding
@@ -255,6 +253,8 @@ class EEGModuleMixin(_BaseHubMixin, metaclass=_BraindecodeDocstringMeta):
         )
         repo_url = kwargs.pop("repo_url", "https://braindecode.org")
         library_name = kwargs.pop("library_name", "braindecode")
+        license = kwargs.pop("license", "bsd-3-clause")
+
         # Register a coder so that type[nn.Module] parameters
         # (e.g. activation=nn.ELU) are serialized as importable
         # strings in config.json and decoded back on load.

{braindecode-1.8.0.dev180516540 → braindecode-1.8.0.dev180935432}/braindecode/models/luna.py

@@ -20,6 +20,7 @@ import torch.fft as fft
 import torch.nn as nn
 import torch.nn.functional as F
 from einops import rearrange
+from rotary_embedding_torch import RotaryEmbedding
 
 from braindecode.models.base import EEGModuleMixin
 from braindecode.models.util import extract_channel_locations_from_chs_info
@@ -534,7 +535,7 @@ class _RotarySelfAttentionBlock(nn.Module):
         self.dim = dim
         self.num_heads = num_heads
         head_dim = dim // num_heads
-        self.rotary_emb = _RotaryEmbedding(head_dim)
+        self.rotary_emb = RotaryEmbedding(dim=head_dim, learned_freq=False)
 
         self.scale = qk_scale or head_dim**-0.5
 
@@ -544,17 +545,6 @@ class _RotarySelfAttentionBlock(nn.Module):
         self.proj = nn.Linear(dim, dim)
         self.proj_drop = nn.Dropout(proj_drop)
 
-    def _rotate_queries_or_keys(self, tensor: torch.Tensor) -> torch.Tensor:
-        """Apply full-head RoPE without concatenating empty boundary views."""
-        seq_len = tensor.shape[-2]
-        positions = torch.arange(seq_len, device=tensor.device, dtype=tensor.dtype)
-        freqs = self.rotary_emb(positions)
-
-        pairs = tensor.reshape(*tensor.shape[:-1], -1, 2)
-        rotated = torch.stack((-pairs[..., 1], pairs[..., 0]), dim=-1).flatten(-2)
-        transformed = tensor * freqs.cos() + rotated * freqs.sin()
-        return transformed.to(tensor.dtype)
-
     def forward(self, x: torch.Tensor) -> torch.Tensor:
         B, N, C = x.shape
         qkv = (
@@ -563,8 +553,8 @@ class _RotarySelfAttentionBlock(nn.Module):
             .permute(2, 0, 3, 1, 4)
         )  # (K, B, H, N, D)
         q, k, v = qkv[0], qkv[1], qkv[2]
-        q = self._rotate_queries_or_keys(q)
-        k = self._rotate_queries_or_keys(k)
+        q = self.rotary_emb.rotate_queries_or_keys(q)
+        k = self.rotary_emb.rotate_queries_or_keys(k)
         # Calculate attention scores
         attn_weights = (q @ k.transpose(-2, -1)) * self.scale  # (B, H, N, N)
 
@@ -580,21 +570,6 @@ class _RotarySelfAttentionBlock(nn.Module):
         return self.proj_drop(self.proj(attn))
 
 
-class _RotaryEmbedding(nn.Module):
-    """Minimal language RoPE frequency generator used by LUNA."""
-
-    def __init__(self, dim: int, theta: float = 10000.0) -> None:
-        super().__init__()
-        frequencies = 1.0 / (
-            theta ** (torch.arange(0, dim, 2, dtype=torch.float32) / dim)
-        )
-        self.freqs = nn.Parameter(frequencies, requires_grad=False)
-
-    def forward(self, positions: torch.Tensor) -> torch.Tensor:
-        angles = positions.to(self.freqs.dtype).unsqueeze(-1) * self.freqs
-        return angles.repeat_interleave(2, dim=-1)
-
-
 class _FeedForwardBlock(nn.Module):
     def __init__(self, dim: int, hidden_dim: int, dropout: float = 0.0) -> None:
         super().__init__()

{braindecode-1.8.0.dev180516540 → braindecode-1.8.0.dev180935432}/braindecode/models/summary.csv

@@ -31,7 +31,7 @@ SincShallowNet,Motor Imagery,Prediction,250,"n_chans, n_outputs, n_times, sfreq"
 ShallowFBCSPNet,General,Prediction,250,"n_chans, n_outputs, n_times",46084,"ShallowFBCSPNet(n_chans=22,  n_outputs=4,  n_times=1000, sfreq=250)","Convolution",EEG
 SleepStagerBlanco2020,Sleep Staging,Prediction,100,"n_chans, n_outputs, n_times",2845,"SleepStagerBlanco2020(n_chans=2, n_outputs=5, n_times=3000, sfreq=100)","Convolution",EEG
 SleepStagerChambon2018,Sleep Staging,Prediction,128,"n_chans, n_outputs, n_times, sfreq",5835,"SleepStagerChambon2018(n_chans=2, n_outputs=5, n_times=3840, sfreq=128)","Convolution",EEG
-AttnSleep,Sleep Staging,Prediction,100,"n_chans, n_outputs, n_times, sfreq",522805,"AttnSleep(n_chans=1, n_outputs=5, n_times=3000, sfreq=100)","Convolution, Attention/Transformer",EEG
+AttnSleep,Sleep Staging,Prediction,100,"n_chans, n_outputs, n_times, sfreq",719925,"AttnSleep(n_chans=2, n_outputs=5, n_times=3000, sfreq=100)","Convolution, Attention/Transformer",EEG
 SPARCNet,Epilepsy,Prediction,200,"n_chans, n_outputs, n_times",1141921,"SPARCNet(n_chans=16, n_outputs=6, n_times=2000, sfreq=200)","Convolution",EEG
 SyncNet,"Emotion Recognition, Alcoholism",Prediction,256,"n_chans, n_outputs, n_times",554,"SyncNet(n_chans=62, n_outputs=3, n_times=5120, sfreq=256)","Interpretability",EEG
 TSception,Emotion Recognition,Prediction,256,"n_chans, n_outputs, n_times, sfreq",2187206,"TSception(n_chans=62, n_outputs=3, n_times=5120, sfreq=256)","Convolution",EEG

{braindecode-1.8.0.dev180516540 → braindecode-1.8.0.dev180935432}/braindecode/models/usleep.py

@@ -431,7 +431,11 @@ class _DecoderBlock(nn.Module):
     ) -> tuple[torch.Tensor, torch.Tensor]:
         """Crops two tensors to their lowest-common-dimension along an axis."""
         dim_cropped = min(x1.shape[axis], x2.shape[axis])
-        return (
-            x1.narrow(axis, 0, dim_cropped),
-            x2.narrow(axis, 0, dim_cropped),
+
+        x1_cropped = torch.index_select(
+            x1, dim=axis, index=torch.arange(dim_cropped).to(device=x1.device)
+        )
+        x2_cropped = torch.index_select(
+            x2, dim=axis, index=torch.arange(dim_cropped).to(device=x1.device)
         )
+        return x1_cropped, x2_cropped

{braindecode-1.8.0.dev180516540 → braindecode-1.8.0.dev180935432}/braindecode/models/zuna.py

@@ -11,6 +11,7 @@ from typing import Optional
 import torch
 from einops import rearrange
 from einops.layers.torch import Rearrange
+from rotary_embedding_torch import RotaryEmbedding
 from torch import nn
 from torch.nn import functional
 
@@ -274,11 +275,18 @@ class ZUNA(EEGModuleMixin, nn.Module):
             (channel_position_indices, coarse_time_indices.unsqueeze(1)), dim=1
         )
 
-        rotary_frequency_table = _build_rotary_frequency_table(
-            torch.arange(max_seqlen, dtype=torch.float32),
-            axis_dim=rotary_axis_dim,
+        rotary_embedding = RotaryEmbedding(
+            # rotary_embedding_torch cannot construct dim=2 directly because
+            # of its theta-rescaling formula; dim=4 followed by slicing is
+            # equivalent for the single-frequency dim=2 case.
+            dim=max(rotary_axis_dim, 4),
             theta=rope_theta,
+            cache_if_possible=False,
         )
+        with torch.no_grad():
+            rotary_frequency_table = rotary_embedding(
+                torch.arange(max_seqlen, dtype=torch.float32)
+            )[:, :rotary_axis_dim]
         token_rotary_frequencies = rearrange(
             rotary_frequency_table[token_position_indices],
             "token coordinate rotary_frequency -> token (coordinate rotary_frequency)",
@@ -336,28 +344,6 @@ class ZUNA(EEGModuleMixin, nn.Module):
         )
 
 
-def _build_rotary_frequency_table(
-    positions: torch.Tensor, *, axis_dim: int, theta: float
-) -> torch.Tensor:
-    """Build ZUNA's per-axis rotary frequencies with native PyTorch."""
-    embedding_dim = max(axis_dim, 4)
-    inverse_frequencies = 1.0 / (
-        theta
-        ** (
-            torch.arange(
-                0,
-                embedding_dim,
-                2,
-                device=positions.device,
-                dtype=torch.float32,
-            )
-            / embedding_dim
-        )
-    )
-    angles = positions.to(torch.float32).unsqueeze(-1) * inverse_frequencies
-    return angles.repeat_interleave(2, dim=-1)[:, :axis_dim]
-
-
 class _RotaryPositionEmbedding(nn.Module):
     def __init__(self):
         super().__init__()

braindecode-1.8.0.dev180935432/braindecode/version.py

@@ -0,0 +1 @@
+__version__ = "1.8.0.dev180935432"

{braindecode-1.8.0.dev180516540 → braindecode-1.8.0.dev180935432/braindecode.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.8.0.dev180516540
+Version: 1.8.0.dev180935432
 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>
@@ -34,6 +34,7 @@ Requires-Dist: pandas
 Requires-Dist: wfdb>=4.3.1
 Requires-Dist: linear_attention_transformer
 Requires-Dist: docstring_inheritance
+Requires-Dist: rotary_embedding_torch
 Requires-Dist: pydantic>=2.0
 Provides-Extra: moabb
 Requires-Dist: moabb>=1.4.3; extra == "moabb"
@@ -50,7 +51,6 @@ Requires-Dist: pytest-cov; extra == "tests"
 Requires-Dist: codecov; extra == "tests"
 Requires-Dist: pytest_cases; extra == "tests"
 Requires-Dist: mypy; extra == "tests"
-Requires-Dist: ipython; extra == "tests"
 Requires-Dist: transformers>=4.57.0; extra == "tests"
 Requires-Dist: bids_validator; extra == "tests"
 Provides-Extra: typing

{braindecode-1.8.0.dev180516540 → braindecode-1.8.0.dev180935432}/braindecode.egg-info/SOURCES.txt

@@ -20,7 +20,6 @@ braindecode/augmentation/base.py
 braindecode/augmentation/functional.py
 braindecode/augmentation/transforms.py
 braindecode/datasets/__init__.py
-braindecode/datasets/_notebook_viewer.py
 braindecode/datasets/base.py
 braindecode/datasets/bbci.py
 braindecode/datasets/bcicomp.py

{braindecode-1.8.0.dev180516540 → braindecode-1.8.0.dev180935432}/braindecode.egg-info/requires.txt

@@ -10,6 +10,7 @@ pandas
 wfdb>=4.3.1
 linear_attention_transformer
 docstring_inheritance
+rotary_embedding_torch
 pydantic>=2.0
 
 [all]
@@ -60,7 +61,6 @@ pytest-cov
 codecov
 pytest_cases
 mypy
-ipython
 transformers>=4.57.0
 bids_validator
 

{braindecode-1.8.0.dev180516540 → braindecode-1.8.0.dev180935432}/docs/whats_new.rst

@@ -28,12 +28,6 @@ Current 1.8.0 (GitHub)
 Enhancements
 ============
 
-- Add :meth:`braindecode.datasets.BaseConcatDataset.plot` (every dataset, ``BIDSDataset`` included): show a recording in the
-  `eegdash-viewer <https://github.com/eegdash/eegdash-viewer>`_ inside a
-  Jupyter cell — serverless (bytes inlined, viewer from CDN), with the
-  synchronized hand-pose panel when a ``*_desc-pose.json`` sidecar is present
-  (:gh:`1133` by `Bruno Aristimunha`_)
-
 - Preserve the recording-local row of each canonical MNE annotation as
   ``i_trial_in_dataset`` in event-window metadata, keeping it aligned with
   targets and annotation extras through event mapping, duration filtering,
@@ -73,30 +67,11 @@ API and behavior changes
 Requirements
 ============
 
-- Remove the ``rotary_embedding_torch`` dependency. The rotary frequency
-  generation used by :class:`braindecode.models.LUNA` and
-  :class:`braindecode.models.ZUNA` is now implemented directly with PyTorch.
-  (:gh:`1136` by `Bruno Aristimunha`_)
+- None yet
 
 Bug fixes
 ==========
 
-- Sample stochastic-depth masks with out-of-place
-  :func:`torch.bernoulli` instead of in-place ``Tensor.bernoulli_``. This keeps
-  the same per-sample Bernoulli mask and scaling while avoiding lazy
-  recipe-cache offset failures on Gaudi accelerators. The
-  :func:`braindecode.functional.drop_path` documentation now also correctly
-  describes ``drop_prob`` as the probability of dropping a path. By `Bruno
-  Aristimunha`_.
-
-- Make :class:`braindecode.models.LUNA` rotary attention portable to
-  accelerators that reject concatenations containing empty tensor views, while
-  preserving its pretrained-checkpoint parameter keys and numerical behavior.
-  Also crop mismatched :class:`braindecode.models.USleep` decoder tensors with
-  views instead of allocating index tensors, avoiding unsupported accelerator
-  lowering without changing the selected samples. (:gh:`1136` by `Bruno
-  Aristimunha`_)
-
 - Fix the docstrings of :class:`braindecode.models.ATCNet`,
   :class:`braindecode.models.AttnSleep`, :class:`braindecode.models.CTNet`,
   :class:`braindecode.models.EEGSimpleConv`, :class:`braindecode.models.IFNet`,

{braindecode-1.8.0.dev180516540 → braindecode-1.8.0.dev180935432}/pyproject.toml

@@ -57,6 +57,7 @@ dependencies = [
     'wfdb>=4.3.1',  # requests comes transitively via mne→pooch and wfdb
     'linear_attention_transformer',
     'docstring_inheritance',        # we get einops from here
+    'rotary_embedding_torch',
     'pydantic>=2.0',
 ]
 
@@ -84,7 +85,6 @@ tests = [
     'codecov',
     'pytest_cases',
     'mypy',
-    'ipython',
     "transformers>=4.57.0",
     "bids_validator",
 ]

braindecode-1.8.0.dev180516540/braindecode/datasets/_notebook_viewer.py

@@ -1,255 +0,0 @@
-# Authors: Bruno Aristimunha <b.aristimunha@gmail.com>
-#
-# License: BSD (3-clause)
-"""Serverless in-notebook viewer for file-backed recordings.
-
-The bytes on disk behind a dataset element are inlined in the cell output
-as base64 and handed to the deployed eegdash-viewer over its ``postMessage``
-bridge (``docs/embedding.md`` in https://github.com/eegdash/eegdash-viewer):
-no server, no CORS. The output is an iframe plus an inline script, so it
-renders when the cell ran in your session or the saved notebook is trusted
-(``jupyter trust``).
-"""
-
-from __future__ import annotations
-
-import base64
-import json
-import os
-import uuid
-from pathlib import Path
-from urllib.parse import urlsplit
-
-import mne_bids
-from mne.utils import _soft_import
-
-CDN = "https://eegdash.github.io/eegdash-viewer"
-MAX_BYTES = 64 * 2**20  # base64 output per call; it is saved with the notebook
-EXTENSIONS = {
-    ".set",
-    ".edf",
-    ".bdf",
-    ".vhdr",
-    ".fif",
-    ".snirf",
-    ".nwb",
-}  # viewer readers
-_BIDS = {"eeg", "ieeg", "emg", "meg", "nirs"}
-_SIBLINGS = {".vhdr": (".eeg", ".vmrk"), ".set": (".fdt",)}  # travel with the header
-_HEADER = {s: h for h, ss in _SIBLINGS.items() for s in ss}  # data file -> header
-
-_SCRIPT = """<iframe id=%(id)s title="eegdash trace viewer" style="width:100%%;height:%(height)spx;
-border:1px solid var(--jp-border-color1,#d9dce1);border-radius:6px;background:transparent"></iframe>
-<script>
-(function () {
-  var self = document.currentScript, id = %(id)s;   // Lab re-runs scripts in place; VS Code/nbclassic elsewhere
-  var frame = (self && self.previousElementSibling && self.previousElementSibling.tagName === "IFRAME")
-    ? self.previousElementSibling : document.getElementById(id);
-  if (!frame) { console.error("eegdash viewer: output iframe " + id + " not found"); return; }
-  var payload = %(payload)s, origin = %(origin)s, files = null, pose = null;
-  function decode(b64) {
-    if (Uint8Array.fromBase64) return Uint8Array.fromBase64(b64);
-    var bin = atob(b64), out = new Uint8Array(bin.length);
-    for (var i = 0; i < bin.length; i++) out[i] = bin.charCodeAt(i);
-    return out;
-  }
-  function send(target) {
-    try {
-      if (!files) {
-        files = payload.files.map(function (f) { return new File([decode(f.b64)], f.name); });
-        pose = payload.pose ? "data:application/json;base64," + payload.pose : null;
-        payload = null;
-      }
-      frame.contentWindow.postMessage({ type: "eegdash-viewer:open", files: files, pose: pose }, target || origin);
-    } catch (err) {
-      frame.insertAdjacentHTML("afterend", '<div style="font:12px system-ui;color:#b3261e">eegdash viewer: '
-        + String(err.message).replace(/</g, "&lt;") + "</div>");
-    }
-  }
-  window.addEventListener("message", function onMessage(e) {
-    if (e.source === frame.contentWindow && e.data && e.data.type === "eegdash-viewer:ready") send(e.origin);
-    else if (!frame.isConnected) window.removeEventListener("message", onMessage);
-  });
-  frame.src = %(src)s;   // after the listener, so "ready" can never precede it
-})();
-</script>"""
-
-
-def recording_files(recording: Path) -> tuple[list[Path], Path | None]:
-    """``(files, pose)`` to inline for a recording: the header first, then the
-    split-format siblings, the BIDS-inherited ``_channels.tsv``/``_events.tsv``
-    (``mne_bids`` parses the name; plain names get none) and, separately, the
-    ``<prefix>_desc-pose.json`` hand-pose sidecar next to it. Symlinks keep
-    their name (git-annex/datalad)."""
-    rec = Path(recording)
-    if not rec.exists():
-        raise ValueError(
-            f"{rec.name}: file not found (a datalad symlink may need `datalad get`)"
-        )
-    if (
-        rec.is_dir()
-        or rec.suffix.lower() not in EXTENSIONS
-        or rec.stem.endswith("_epo")
-    ):
-        raise ValueError(
-            f"{rec.name}: the viewer opens raw recordings in {' '.join(sorted(EXTENSIONS))}"
-        )
-    sidecars: list[Path | None] = []
-    try:
-        bids = mne_bids.get_bids_path_from_fname(rec, check=False)
-        if bids.subject is not None:  # hyphen-free names parse, but are not BIDS
-            sidecars = [
-                bids.find_matching_sidecar(
-                    suffix=s, extension=".tsv", on_error="ignore"
-                )
-                for s in ("channels", "events")
-            ]
-    except (
-        KeyError,
-        ValueError,
-    ):  # not a BIDS name / unknown entity somewhere in the tree
-        pass
-    files = [rec]
-    for p in [
-        rec.with_suffix(e) for e in _SIBLINGS.get(rec.suffix.lower(), ())
-    ] + sidecars:
-        if p and p.is_file():
-            if p not in files:
-                files.append(p)
-        elif p and p.is_symlink():  # dangling: git-annex/datalad content not fetched
-            raise ValueError(f"{p.name}: dangling symlink (try `datalad get`)")
-    stem, _, token = rec.stem.rpartition("_")
-    pose = rec.with_name((stem if token in _BIDS else rec.stem) + "_desc-pose.json")
-    return files, pose if pose.is_file() else None
-
-
-def build_viewer_html(
-    recording: Path,
-    *,
-    height: int = 520,
-    cdn_url: str = CDN,
-    max_bytes: int = MAX_BYTES,
-) -> str:
-    """Viewer iframe + inlined bytes + bridge script for one recording."""
-    url = urlsplit(cdn_url)
-    if (
-        url.scheme not in ("http", "https")
-        or not url.netloc
-        or url.username
-        or url.query
-        or url.fragment
-        or url.path.endswith(("index.html", "index.htm"))
-    ):
-        raise ValueError(
-            f"cdn_url must be the viewer's base http(s) URL, got {cdn_url!r}"
-        )
-    files, pose = recording_files(recording)
-    encoded = sum(
-        4 * -(-p.stat().st_size // 3) for p in files + ([pose] if pose else [])
-    )
-    if encoded > max_bytes:
-        raise ValueError(
-            f"{files[0].name}: {encoded / 2**20:.1f} MiB of base64 would be inlined into the "
-            f"notebook output (max_bytes={max_bytes / 2**20:.1f} MiB); crop/downsample or raise it"
-        )
-    rec = files[0]
-    # The viewer picks the recording by its *_<datatype>.<ext> name: plain names
-    # are posted as <stem>_eeg<ext>, an EEGLAB .fdt next to the posted .set name.
-    head = (
-        rec.name
-        if rec.stem.rpartition("_")[2] in _BIDS
-        else f"{rec.stem}_eeg{rec.suffix.lower()}"
-    )
-    names = [head] + [
-        head.rsplit("_", 1)[0] + "_eeg.fdt" if p.suffix.lower() == ".fdt" else p.name
-        for p in files[1:]
-    ]
-    b64 = [base64.b64encode(p.read_bytes()).decode() for p in files]
-    literals = {
-        "id": f"eegdash-viewer-{uuid.uuid4().hex[:8]}",
-        "height": int(height),
-        "payload": {
-            "files": [{"name": n, "b64": b} for n, b in zip(names, b64)],
-            "pose": base64.b64encode(pose.read_bytes()).decode() if pose else None,
-        },
-        "origin": f"{url.scheme}://{url.netloc}",
-        "src": f"{url.geturl().rstrip('/')}/index.html?embed=1",
-    }
-    return _SCRIPT % {
-        k: json.dumps(v).replace("<", "\\u003c") for k, v in literals.items()
-    }
-
-
-def _recording(dataset, index: int) -> Path:
-    """File behind ``dataset.datasets[index]``: the one its mne ``raw`` reads (a
-    data file maps back to its header; lazily downloading datasets fetch it when
-    ``raw`` is accessed) or the recorded ``description["path"]``."""
-    ds = dataset.datasets[index]
-    names = [
-        Path(f)
-        for f in getattr(getattr(ds, "raw", None), "filenames", None) or ()
-        if isinstance(f, (str, os.PathLike))
-    ]
-    if len(names) > 1:
-        raise ValueError(
-            f"{type(dataset).__name__}[{index}]: split recordings are not supported"
-        )
-    desc = getattr(ds, "description", None)  # dict or pandas Series
-    recorded = desc.get("path") if desc is not None else None
-    path = (
-        names[0]
-        if names
-        else Path(recorded)
-        if isinstance(recorded, (str, os.PathLike))
-        else None
-    )
-    if path is None:
-        raise ValueError(
-            f"{type(dataset).__name__}[{index}] is not backed by a recording file"
-        )
-    header = path.with_suffix(_HEADER.get(path.suffix.lower(), path.suffix))
-    return header if header.is_file() else path
-
-
-def plot(
-    dataset,
-    index: int = 0,
-    *,
-    height: int = 520,
-    cdn_url: str = CDN,
-    max_bytes: int = MAX_BYTES,
-):
-    """Show one recording in the eegdash-viewer inside a Jupyter cell.
-
-    Serverless: the recording bytes (as on disk) are inlined in the output and
-    pushed to the viewer at ``cdn_url`` over ``postMessage``; the output renders
-    when the cell ran in your session or the notebook is trusted. A
-    ``*_desc-pose.json`` sidecar next to the recording adds the synchronized
-    hand-pose panel. Needs IPython (soft dependency).
-
-    Parameters
-    ----------
-    index : int
-        Recording to display.
-    height : int
-        Viewer height in pixels.
-    cdn_url : str
-        Base URL of a deployed eegdash-viewer.
-    max_bytes : int
-        Refuse to inline more than this much base64 (default 64 MiB); the
-        payload is saved with the notebook and, like any cell output, stays
-        referenced by IPython's ``Out`` history for the session.
-
-    Returns
-    -------
-    IPython.display.HTML
-    """
-    ipython = _soft_import("IPython", purpose=f"{type(dataset).__name__}.plot()")
-    return ipython.display.HTML(
-        build_viewer_html(
-            _recording(dataset, index),
-            height=height,
-            cdn_url=cdn_url,
-            max_bytes=max_bytes,
-        )
-    )

braindecode-1.8.0.dev180516540/braindecode/version.py

@@ -1 +0,0 @@
-__version__ = "1.8.0.dev180516540"