Changing: name of TimeSeriesSplit to PseudoOnlineSplit

Adding: figures for documentation
NeuroTechX · Sep 30, 2024 · 26b13d5 · 26b13d5
1 parent a6b5772
commit 26b13d5
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 0 deletions.
diff --git a/docs/source/images/crosssess.pdf b/docs/source/images/crosssess.pdf
diff --git a/docs/source/images/crosssubj.pdf b/docs/source/images/crosssubj.pdf
diff --git a/docs/source/images/withinsess.pdf b/docs/source/images/withinsess.pdf
diff --git a/docs/source/whats_new.rst b/docs/source/whats_new.rst
@@ -54,6 +54,7 @@ Enhancements
 - Add new dataset :class:`moabb.datasets.Rodrigues2017` dataset (:gh:`602` by `Gregoire Cattan`_ and `Pedro L. C. Rodrigues`_)
 - Change unittest to pytest (:gh:`618` by `Bruno Aristimunha`_)
 - Remove tensorflow import warning (:gh:`622` by `Bruno Aristimunha`_)
+- Add data splitter classes (:gh:`612` by `Bruna Lopes_`)
 
 Bugs
 ~~~~

diff --git a/moabb/evaluations/splitters.py b/moabb/evaluations/splitters.py
@@ -14,6 +14,10 @@ class WithinSessionSplitter(BaseCrossValidator):
     and test sets on separate session for each subject. This splitter assumes that
     all data from all subjects is already known and loaded.
 
+     . image:: images/withinsess.pdf
+    :alt: The schematic diagram of the WithinSession split
+    :align: center
+
     Parameters
     ----------
     n_folds : int
@@ -139,6 +143,10 @@ class CrossSessionSplitter(BaseCrossValidator):
     evaluate performance across sessions, but for a single subject. This splitter
     assumes that all data from all subjects is already known and loaded.
 
+     . image:: images/crosssess.pdf
+        :alt: The schematic diagram of the CrossSession split
+        :align: center
+
     Parameters
     ----------
     n_folds :
@@ -246,6 +254,10 @@ class CrossSubjectSplitter(BaseCrossValidator):
     evaluate performance across sessions, but for a single subject. This splitter
     assumes that all data from all subjects is already known and loaded.
 
+     . image:: images/crosssubj.pdf
+    :alt: The schematic diagram of the CrossSubj split
+    :align: center
+
     Parameters
     ----------
     n_groups : int or None