braindecode 1.8.1.dev182436253__tar.gz → 1.8.1.dev183674431__tar.gz

{braindecode-1.8.1.dev182436253/braindecode.egg-info → braindecode-1.8.1.dev183674431}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.8.1.dev182436253
+Version: 1.8.1.dev183674431
 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>
@@ -60,6 +60,8 @@ Provides-Extra: typing
 Requires-Dist: exca>=0.5.10; extra == "typing"
 Requires-Dist: numpydantic>=1.7; extra == "typing"
 Provides-Extra: docs
+Requires-Dist: pytest<9.1; extra == "docs"
+Requires-Dist: sphinx-markdown-builder==0.6.11; extra == "docs"
 Requires-Dist: sphinx_gallery>=0.17; extra == "docs"
 Requires-Dist: sphinx_rtd_theme; extra == "docs"
 Requires-Dist: sphinx-autodoc-typehints; extra == "docs"

{braindecode-1.8.1.dev182436253 → braindecode-1.8.1.dev183674431}/braindecode/models/deep4.py

@@ -215,6 +215,7 @@ class Deep4Net(EEGModuleMixin, nn.Sequential):
                     filter_time_length=filter_time_length,
                     bias_time=True,
                     bias_spat=not self.batch_norm,
+                    stride=(conv_stride, 1),
                 ),
             )
             n_filters_conv = self.n_filters_spat

{braindecode-1.8.1.dev182436253 → braindecode-1.8.1.dev183674431}/braindecode/modules/convolution.py

@@ -143,6 +143,9 @@ class CombinedConv(nn.Module):
         Whether to use bias in the temporal conv
     bias_spat: bool
         Whether to use bias in the spatial conv
+    stride: int | tuple[int, int]
+        Stride of the merged convolution. This is applied at the spatial
+        convolution stage, matching the unmerged temporal-then-spatial form.
 
     Examples
     --------
@@ -164,6 +167,7 @@ class CombinedConv(nn.Module):
         filter_time_length=25,
         bias_time=True,
         bias_spat=True,
+        stride=1,
     ):
         super().__init__()
         self.bias_time = bias_time
@@ -172,7 +176,11 @@ class CombinedConv(nn.Module):
             1, n_filters_time, (filter_time_length, 1), bias=bias_time, stride=1
         )
         self.conv_spat = nn.Conv2d(
-            n_filters_time, n_filters_spat, (1, in_chans), bias=bias_spat, stride=1
+            n_filters_time,
+            n_filters_spat,
+            (1, in_chans),
+            bias=bias_spat,
+            stride=stride,
         )
 
     def forward(self, x: torch.Tensor) -> torch.Tensor:
@@ -210,7 +218,9 @@ class CombinedConv(nn.Module):
 
         bias = calculated_bias
 
-        return F.conv2d(x, weight=combined_weight, bias=bias, stride=(1, 1))
+        return F.conv2d(
+            x, weight=combined_weight, bias=bias, stride=self.conv_spat.stride
+        )
 
 
 class CausalConv1d(nn.Conv1d):

braindecode-1.8.1.dev183674431/braindecode/version.py

@@ -0,0 +1 @@
+__version__ = "1.8.1.dev183674431"

{braindecode-1.8.1.dev182436253 → braindecode-1.8.1.dev183674431/braindecode.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: braindecode
-Version: 1.8.1.dev182436253
+Version: 1.8.1.dev183674431
 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>
@@ -60,6 +60,8 @@ Provides-Extra: typing
 Requires-Dist: exca>=0.5.10; extra == "typing"
 Requires-Dist: numpydantic>=1.7; extra == "typing"
 Provides-Extra: docs
+Requires-Dist: pytest<9.1; extra == "docs"
+Requires-Dist: sphinx-markdown-builder==0.6.11; extra == "docs"
 Requires-Dist: sphinx_gallery>=0.17; extra == "docs"
 Requires-Dist: sphinx_rtd_theme; extra == "docs"
 Requires-Dist: sphinx-autodoc-typehints; extra == "docs"

{braindecode-1.8.1.dev182436253 → braindecode-1.8.1.dev183674431}/braindecode.egg-info/SOURCES.txt

@@ -160,6 +160,7 @@ braindecode/visualization/metrics.py
 braindecode/visualization/sanity.py
 braindecode/visualization/topology.py
 docs/Makefile
+docs/agent_docs.rst
 docs/api.rst
 docs/cite.rst
 docs/conf.py

{braindecode-1.8.1.dev182436253 → braindecode-1.8.1.dev183674431}/braindecode.egg-info/requires.txt

@@ -22,6 +22,8 @@ braindecode[typing]
 braindecode[viz]
 
 [docs]
+pytest<9.1
+sphinx-markdown-builder==0.6.11
 sphinx_gallery>=0.17
 sphinx_rtd_theme
 sphinx-autodoc-typehints

braindecode-1.8.1.dev183674431/docs/agent_docs.rst

@@ -0,0 +1,60 @@
+:orphan:
+
+#######################################
+ Machine-readable documentation builds
+#######################################
+
+The documentation workflow renders selected canonical Sphinx pages with
+``sphinx-markdown-builder`` after the HTML build, then runs
+``docs/build_agent_docs.py``. The resulting ``llms.txt`` and Markdown siblings live
+inside the same version directory as their HTML pages. Nothing is written to the
+generated hosting repository by this script.
+
+The curated index covers installation, model selection, API conventions, two model
+references, tutorials and citation. It is not a complete Markdown mirror. Each exported
+page identifies the package version, documentation URL and exact source commit. Internal
+document links deliberately point to HTML so that pages outside this selection remain
+accessible. A small translator adapter preserves HTML image paths, bibliography anchors
+and gallery navigation, and omits raw HTML scripts/styles. Other unsupported nodes
+retain the converter's warnings rather than being silently accepted. Interactive tables
+and custom Sphinx content may not survive Markdown conversion; follow the canonical HTML
+link.
+
+**********************
+ Build and validation
+**********************
+
+After a successful normal HTML build, run from the repository root:
+
+::
+
+    sphinx-build -b markdown -d docs/_build/doctrees -D plot_gallery=0 docs docs/_build/markdown
+    python docs/build_agent_docs.py \
+        --markdown-root docs/_build/markdown \
+        --html-root docs/_build/html \
+        --site-url https://braindecode.org/dev/ \
+        --version "$(python -c 'import braindecode; print(braindecode.__version__)')" \
+        --revision "$(git rev-parse HEAD)"
+
+Use a clean output directory for each source revision. The Markdown pass disables
+example execution; the preceding normal HTML build still has its usual dataset and model
+requirements. Publication fails if any curated HTML or Markdown page is missing or its
+Markdown is empty. Offline tests require pytest, Sphinx, sphinx-markdown-builder,
+sphinx-gallery, sphinx-design, sphinxcontrib-bibtex and matplotlib. The integration
+fixture builds HTML then Markdown with shared doctrees and checks that its tiny,
+data-free example executes only once:
+
+::
+
+    python -m pytest -q docs/tests/test_agent_docs.py
+
+******************
+ Deployment scope
+******************
+
+The existing master-push workflow deploys only ``dev/``. A development checkout can
+contain a release-looking package version; the URL scope and source commit are therefore
+essential provenance. This change does not create a root index, retarget ``stable/`` or
+rebuild any historical version. A future release build must use its own source checkout,
+matching HTML and explicit version URL; do not copy development Markdown into stable
+documentation.

{braindecode-1.8.1.dev182436253 → braindecode-1.8.1.dev183674431}/docs/conf.py

@@ -86,6 +86,8 @@ print(f"--- Sphinx is using sphinx_design version: {sphinx_design.__version__} -
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    "sphinx_markdown_builder",
+    "agent_markdown",
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.doctest",
@@ -616,3 +618,8 @@ texinfo_documents = [
         "Miscellaneous",
     ),
 ]
+
+# Markdown siblings link to canonical HTML, including pages outside the curated index.
+markdown_uri_doc_suffix = ".html"
+# Preserve Sphinx IDs instead of depending on renderer-specific heading slugs.
+markdown_anchor_sections = True

{braindecode-1.8.1.dev182436253 → braindecode-1.8.1.dev183674431}/docs/whats_new.rst

@@ -28,6 +28,9 @@ Current 1.8.1 (2026-08-31)
 Enhancements
 ============
 
+- Generate a version-scoped ``llms.txt`` and selected Markdown documentation
+  entry points with source-commit attribution and critical-page coverage checks.
+
 - Restore acceptance tests on supported Python versions as seeded decoding
   checks on BNCI2014_001 (held-out accuracy thresholds, a shuffled-label
   control and a replicability check), run by a dedicated CI job
@@ -110,6 +113,9 @@ API and behavior changes
 Requirements
 ============
 
+- Add ``sphinx-markdown-builder==0.6.11`` and ``pytest<9.1`` to the docs extra
+  for version-scoped Markdown exports and their offline contract tests.
+
 - Require PyTorch and TorchAudio >= 2.4 and remove obsolete attention fallbacks.
   REVE and ZUNA now import PyTorch's RMSNorm layer directly, preserving their
   explicit epsilon values. Intel macOS is no longer supported because
@@ -119,6 +125,9 @@ Requirements
 Bug fixes
 ==========
 
+- Preserve ``Deep4Net``'s first-block temporal stride when using the merged
+  ``CombinedConv`` path with ``stride_before_pool=True``; dense-prediction
+  outputs now retain the historical temporal geometry (:gh:`1205` by `lindicaphxag-tech`_).
 - Fix :class:`braindecode.modules.CausalConv1d` to use explicit left-only causal padding. This prevents ``kernel_size=1`` from producing an empty time axis and keeps strided/dilated convolutions aligned with the causal reference instead of over-cropping downsampled outputs (:gh:`1216` by `lindicaphxag-tech`_).
 - :meth:`braindecode.EEGClassifier.predict_trials` and
   :meth:`braindecode.EEGRegressor.predict_trials` no longer raise a

{braindecode-1.8.1.dev182436253 → braindecode-1.8.1.dev183674431}/pyproject.toml

@@ -95,6 +95,8 @@ typing = [
 ]
 
 docs = [
+    'pytest<9.1',  # Offline agent documentation contract tests; match the test extra.
+    'sphinx-markdown-builder==0.6.11',
     'sphinx_gallery>=0.17',
     'sphinx_rtd_theme',
     'sphinx-autodoc-typehints',

braindecode-1.8.1.dev182436253/braindecode/version.py

@@ -1 +0,0 @@
-__version__ = "1.8.1.dev182436253"