deploy: 8aaabf0

coffeine-labs · Jul 24, 2023 · d6f43e8 · d6f43e8
commit d6f43e8
Show file tree

Hide file tree

Showing 108 changed files with 22,513 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 61fa07eeb98b594aeb09c2db430645a2
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/index_4_0.png b/_images/index_4_0.png
diff --git a/_images/tutorials_filterbank_classification_bci_10_0.png b/_images/tutorials_filterbank_classification_bci_10_0.png
diff --git a/_images/tutorials_filterbank_classification_bci_10_1.png b/_images/tutorials_filterbank_classification_bci_10_1.png
diff --git a/_images/tutorials_filterbank_kernel_classification_bci_10_0.png b/_images/tutorials_filterbank_kernel_classification_bci_10_0.png
diff --git a/_images/tutorials_filterbank_kernel_classification_bci_10_1.png b/_images/tutorials_filterbank_kernel_classification_bci_10_1.png
diff --git a/_images/tutorials_filterbank_kernel_classification_bci_14_1.png b/_images/tutorials_filterbank_kernel_classification_bci_14_1.png
diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt
@@ -0,0 +1,77 @@
+.. _api_ref:
+
+=============
+API reference
+=============
+
+
+Composing modeling pipelines
+----------------------------
+.. _pipeline_api:
+.. currentmodule:: coffeine.pipelines
+
+.. autosummary::
+    :toctree: generated/
+    :template: function.rst
+
+    make_filter_bank_transformer
+    make_filter_bank_regressor
+    make_filter_bank_classifier
+
+
+.. autosummary::
+    :toctree: generated/
+    :template: class.rst
+
+    GaussianKernel
+    KernelSum
+
+
+Computing Power-Spectral Features
+---------------------------------
+.. _features_api:
+.. currentmodule:: coffeine.power_features
+
+.. autosummary::
+    :toctree: generated/
+    :template: function.rst
+
+    get_frequency_bands
+    make_coffeine_data_frame
+    compute_coffeine
+    compute_features
+
+
+Covariance Transformers
+-----------------------
+.. _covariance_transformer_api:
+.. currentmodule:: coffeine.covariance_transformers
+
+.. autosummary::
+    :toctree: generated/
+    :template: class.rst
+
+    NaiveVec
+    Diag
+    LogDiag
+    Riemann
+    RiemannSnp
+    Snp
+    ExpandFeatures
+
+
+Spatiel Filters
+---------------
+.. _spatial_filters_api:
+.. currentmodule:: coffeine.spatial_filters
+
+.. autosummary::
+    :toctree: generated/
+    :template: class.rst
+
+    ProjIdentitySpace
+    ProjCommonSpace
+    ProjLWSpace
+    ProjRandomSpace
+    ProjSPoCSpace
+
diff --git a/_sources/generated/coffeine.covariance_transformers.Diag.rst.txt b/_sources/generated/coffeine.covariance_transformers.Diag.rst.txt
@@ -0,0 +1,6 @@
+coffeine.covariance\_transformers.Diag
+======================================
+
+.. currentmodule:: coffeine.covariance_transformers
+
+.. autoclass:: Diag
diff --git a/_sources/generated/coffeine.covariance_transformers.ExpandFeatures.rst.txt b/_sources/generated/coffeine.covariance_transformers.ExpandFeatures.rst.txt
@@ -0,0 +1,6 @@
+coffeine.covariance\_transformers.ExpandFeatures
+================================================
+
+.. currentmodule:: coffeine.covariance_transformers
+
+.. autoclass:: ExpandFeatures
diff --git a/_sources/generated/coffeine.covariance_transformers.LogDiag.rst.txt b/_sources/generated/coffeine.covariance_transformers.LogDiag.rst.txt
@@ -0,0 +1,6 @@
+coffeine.covariance\_transformers.LogDiag
+=========================================
+
+.. currentmodule:: coffeine.covariance_transformers
+
+.. autoclass:: LogDiag
diff --git a/_sources/generated/coffeine.covariance_transformers.NaiveVec.rst.txt b/_sources/generated/coffeine.covariance_transformers.NaiveVec.rst.txt
@@ -0,0 +1,6 @@
+coffeine.covariance\_transformers.NaiveVec
+==========================================
+
+.. currentmodule:: coffeine.covariance_transformers
+
+.. autoclass:: NaiveVec
diff --git a/_sources/generated/coffeine.covariance_transformers.Riemann.rst.txt b/_sources/generated/coffeine.covariance_transformers.Riemann.rst.txt
@@ -0,0 +1,6 @@
+coffeine.covariance\_transformers.Riemann
+=========================================
+
+.. currentmodule:: coffeine.covariance_transformers
+
+.. autoclass:: Riemann
diff --git a/_sources/generated/coffeine.covariance_transformers.RiemannSnp.rst.txt b/_sources/generated/coffeine.covariance_transformers.RiemannSnp.rst.txt
@@ -0,0 +1,6 @@
+coffeine.covariance\_transformers.RiemannSnp
+============================================
+
+.. currentmodule:: coffeine.covariance_transformers
+
+.. autoclass:: RiemannSnp
diff --git a/_sources/generated/coffeine.covariance_transformers.Snp.rst.txt b/_sources/generated/coffeine.covariance_transformers.Snp.rst.txt
@@ -0,0 +1,6 @@
+coffeine.covariance\_transformers.Snp
+=====================================
+
+.. currentmodule:: coffeine.covariance_transformers
+
+.. autoclass:: Snp
diff --git a/_sources/generated/coffeine.pipelines.GaussianKernel.rst.txt b/_sources/generated/coffeine.pipelines.GaussianKernel.rst.txt
@@ -0,0 +1,6 @@
+coffeine.pipelines.GaussianKernel
+=================================
+
+.. currentmodule:: coffeine.pipelines
+
+.. autoclass:: GaussianKernel
diff --git a/_sources/generated/coffeine.pipelines.KernelSum.rst.txt b/_sources/generated/coffeine.pipelines.KernelSum.rst.txt
@@ -0,0 +1,6 @@
+coffeine.pipelines.KernelSum
+============================
+
+.. currentmodule:: coffeine.pipelines
+
+.. autoclass:: KernelSum
diff --git a/_sources/generated/coffeine.pipelines.make_filter_bank_classifier.rst.txt b/_sources/generated/coffeine.pipelines.make_filter_bank_classifier.rst.txt
@@ -0,0 +1,6 @@
+coffeine.pipelines.make\_filter\_bank\_classifier
+=================================================
+
+.. currentmodule:: coffeine.pipelines
+
+.. autofunction:: make_filter_bank_classifier
diff --git a/_sources/generated/coffeine.pipelines.make_filter_bank_regressor.rst.txt b/_sources/generated/coffeine.pipelines.make_filter_bank_regressor.rst.txt
@@ -0,0 +1,6 @@
+coffeine.pipelines.make\_filter\_bank\_regressor
+================================================
+
+.. currentmodule:: coffeine.pipelines
+
+.. autofunction:: make_filter_bank_regressor
diff --git a/_sources/generated/coffeine.pipelines.make_filter_bank_transformer.rst.txt b/_sources/generated/coffeine.pipelines.make_filter_bank_transformer.rst.txt
@@ -0,0 +1,6 @@
+coffeine.pipelines.make\_filter\_bank\_transformer
+==================================================
+
+.. currentmodule:: coffeine.pipelines
+
+.. autofunction:: make_filter_bank_transformer
diff --git a/_sources/generated/coffeine.power_features.compute_coffeine.rst.txt b/_sources/generated/coffeine.power_features.compute_coffeine.rst.txt
@@ -0,0 +1,6 @@
+coffeine.power\_features.compute\_coffeine
+==========================================
+
+.. currentmodule:: coffeine.power_features
+
+.. autofunction:: compute_coffeine
diff --git a/_sources/generated/coffeine.power_features.compute_features.rst.txt b/_sources/generated/coffeine.power_features.compute_features.rst.txt
@@ -0,0 +1,6 @@
+coffeine.power\_features.compute\_features
+==========================================
+
+.. currentmodule:: coffeine.power_features
+
+.. autofunction:: compute_features
diff --git a/_sources/generated/coffeine.power_features.get_frequency_bands.rst.txt b/_sources/generated/coffeine.power_features.get_frequency_bands.rst.txt
@@ -0,0 +1,6 @@
+coffeine.power\_features.get\_frequency\_bands
+==============================================
+
+.. currentmodule:: coffeine.power_features
+
+.. autofunction:: get_frequency_bands
diff --git a/_sources/generated/coffeine.power_features.make_coffeine_data_frame.rst.txt b/_sources/generated/coffeine.power_features.make_coffeine_data_frame.rst.txt
@@ -0,0 +1,6 @@
+coffeine.power\_features.make\_coffeine\_data\_frame
+====================================================
+
+.. currentmodule:: coffeine.power_features
+
+.. autofunction:: make_coffeine_data_frame
diff --git a/_sources/generated/coffeine.spatial_filters.ProjCommonSpace.rst.txt b/_sources/generated/coffeine.spatial_filters.ProjCommonSpace.rst.txt
@@ -0,0 +1,6 @@
+coffeine.spatial\_filters.ProjCommonSpace
+=========================================
+
+.. currentmodule:: coffeine.spatial_filters
+
+.. autoclass:: ProjCommonSpace
diff --git a/_sources/generated/coffeine.spatial_filters.ProjIdentitySpace.rst.txt b/_sources/generated/coffeine.spatial_filters.ProjIdentitySpace.rst.txt
@@ -0,0 +1,6 @@
+coffeine.spatial\_filters.ProjIdentitySpace
+===========================================
+
+.. currentmodule:: coffeine.spatial_filters
+
+.. autoclass:: ProjIdentitySpace
diff --git a/_sources/generated/coffeine.spatial_filters.ProjLWSpace.rst.txt b/_sources/generated/coffeine.spatial_filters.ProjLWSpace.rst.txt
@@ -0,0 +1,6 @@
+coffeine.spatial\_filters.ProjLWSpace
+=====================================
+
+.. currentmodule:: coffeine.spatial_filters
+
+.. autoclass:: ProjLWSpace
diff --git a/_sources/generated/coffeine.spatial_filters.ProjRandomSpace.rst.txt b/_sources/generated/coffeine.spatial_filters.ProjRandomSpace.rst.txt
@@ -0,0 +1,6 @@
+coffeine.spatial\_filters.ProjRandomSpace
+=========================================
+
+.. currentmodule:: coffeine.spatial_filters
+
+.. autoclass:: ProjRandomSpace
diff --git a/_sources/generated/coffeine.spatial_filters.ProjSPoCSpace.rst.txt b/_sources/generated/coffeine.spatial_filters.ProjSPoCSpace.rst.txt
@@ -0,0 +1,6 @@
+coffeine.spatial\_filters.ProjSPoCSpace
+=======================================
+
+.. currentmodule:: coffeine.spatial_filters
+
+.. autoclass:: ProjSPoCSpace
diff --git a/_sources/index.ipynb.txt b/_sources/index.ipynb.txt
diff --git a/_sources/tutorials.ipynb.txt b/_sources/tutorials.ipynb.txt
@@ -0,0 +1,44 @@
+{
+ "cells": [
+  {
+   "cell_type": "raw",
+   "id": "4cfc099f",
+   "metadata": {
+    "raw_mimetype": "text/restructuredtext"
+   },
+   "source": [
+    "Discover coffeine through examples and in-depth tutorials\n",
+    "=========================================================\n",
+    "\n",
+    ".. nblinkgallery::\n",
+    "    :caption: Notebooks showcasing usage of coffeine\n",
+    "    :name: Tutorials\n",
+    "    \n",
+    "    tutorials/filterbank_classification_bci\n",
+    "    tutorials/filterbank_kernel_classification_bci"
+   ]
+  }
+ ],
+ "metadata": {
+  "celltoolbar": "Raw Cell Format",
+  "kernelspec": {
+   "display_name": "coffeine",
+   "language": "python",
+   "name": "coffeine"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.16"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}