[GSOC] Add decoding module (#193)

mne-tools · Jun 19, 2024 · 57a1271 · 57a1271
1 parent 57afdcc
commit 57a1271
Show file tree

Hide file tree

Showing 9 changed files with 1,735 additions and 71 deletions.
diff --git a/doc/api.rst b/doc/api.rst
@@ -49,9 +49,24 @@ on numpy array inputs.
    spectral_connectivity_epochs
    spectral_connectivity_time
 
+Decoding classes
+================
+
+These classes fit filters which decompose data into discrete sources of
+connectivity, amplifying the signal-to-noise ratio of these interactions.
+
+.. currentmodule:: mne_connectivity.decoding
+
+.. autosummary::
+   :toctree: generated/
+
+   CoherencyDecomposition
+
 Reading functions
 =================
 
+.. currentmodule:: mne_connectivity
+
 .. autosummary::
    :toctree: generated/
 

diff --git a/doc/conf.py b/doc/conf.py
@@ -111,6 +111,7 @@
     "n_node_names",
     "n_tapers",
     "n_signals",
+    "n_components",
     "n_step",
     "n_freqs",
     "epochs",

diff --git a/examples/decoding/README.txt b/examples/decoding/README.txt
@@ -0,0 +1,6 @@
+
+Decoding & Decomposition Examples
+---------------------------------
+
+Examples demonstrating multivariate connectivity analysis using the decomposition tools
+of the decoding module.