Skip to main content

ExBrainable: An Open-Source GUI for CNN-based EEG Decoding and Model Interpretation

Project description

ExBrainable

An Open-Source GUI for CNN-based EEG Decoding and Model Interpretation.

We developed a graphic user interface (GUI), ExBrainable, which is dedicated to modeling, decoding, and visualization of electroencephalographic (EEG) data based on explainable neural network models. Available functions include model training, evaluation, and parameter visualization. Demonstration on motor-imagery EEG data exhibits the spatial and temporal representations of EEG patterns associated with prior knowledge of neuroscience. As a growing open-source platform, ExBrainable offers fast, simplified, and user-friendly analysis of EEG data using cutting-edge computational approaches for brain/neuroscience research.

Installation

  1. Install Python >= 3.7
  2. Install Pytorch >= 1.0 from http://pytorch.org/
  3. Use the package manager pip to install ExBrainable
$ pip install ExBrainable
  1. Run ExBrainable
$ ExBrainable

To get the latest code using git and conda, open a terminal and type:

$ git clone https://github.com/CECNL/ExBrainable
$ cd ExBrainable
$ conda env create -f environment.yml 
$ conda activate ExBrainable 

Documentation

See our preprint on ArXiv: https://arxiv.org/abs/2201.04065

Demonstration

Here is a brief video demonstration of ExBrainable: https://youtu.be/m40z2klbmtg

Dataset

The BCI Competition IV 2a dataset used in our paper is available on: https://www.bbci.de/competition/iv/.
Example data used in the demo video can be downloaded here: https://drive.google.com/drive/folders/1-M-ZU1BbfwdiFP-jkPcCfu058fRzksSI?usp=sharing

Citing

If you use this our codes in your research, please cite our paper and the related references in your publication as:

@article{huang2022exbrainable,
  title={ExBrainable: An Open-Source GUI for CNN-based EEG Decoding and Model Interpretation},
  author={Huang, Ya-Lin and Hsieh, Chia-Ying and Huang, Jian-Xue and Wei, Chun-Shu},
  journal={arXiv preprint arXiv:2201.04065},
  year={2022}
}

MNE-Python software:

@article{10.3389/fnins.2013.00267,
author={Gramfort, Alexandre and Luessi, Martin and Larson, Eric and Engemann, Denis and Strohmeier, Daniel and Brodbeck, Christian and Goj, Roman and Jas, Mainak and Brooks, Teon and Parkkonen, Lauri and Hämäläinen, Matti},
title={{MEG and EEG data analysis with MNE-Python}},
journal={Frontiers in Neuroscience},
volume={7},
pages={267},
year={2013},
url={https://www.frontiersin.org/article/10.3389/fnins.2013.00267},
doi={10.3389/fnins.2013.00267},
issn={1662-453X},
}

If you use the EEGNet model, please cite the following:

@article{Lawhern2018,
  author={Vernon J Lawhern and Amelia J Solon and Nicholas R Waytowich and Stephen M Gordon and Chou P Hung and Brent J Lance},
  title={EEGNet: a compact convolutional neural network for EEG-based brain–computer interfaces},
  journal={Journal of Neural Engineering},
  volume={15},
  number={5},
  pages={056013},
  url={http://stacks.iop.org/1741-2552/15/i=5/a=056013},
  year={2018}
}

If you use the ShalowConvNet model, please cite the following:

@article{hbm23730,
author = {Schirrmeister Robin Tibor and 
          Springenberg Jost Tobias and 
          Fiederer Lukas Dominique Josef and 
          Glasstetter Martin and 
          Eggensperger Katharina and 
          Tangermann Michael and 
          Hutter Frank and 
          Burgard Wolfram and 
          Ball Tonio},
title = {Deep learning with convolutional neural networks for EEG decoding and visualization},
journal = {Human Brain Mapping},
volume = {38},
number = {11},
pages = {5391-5420},
keywords = {electroencephalography, EEG analysis, machine learning, end‐to‐end learning, brain–machine interface, brain–computer interface, model interpretability, brain mapping},
doi = {10.1002/hbm.23730},
url = {https://onlinelibrary.wiley.com/doi/abs/10.1002/hbm.23730}
}

If you use the SCCNet model, please cite the following:

@inproceedings{wei2019spatial,
  title={Spatial component-wise convolutional network (SCCNet) for motor-imagery EEG classification},
  author={Wei, Chun-Shu and Koike-Akino, Toshiaki and Wang, Ye},
  booktitle={2019 9th International IEEE/EMBS Conference on Neural Engineering (NER)},
  pages={328--331},
  year={2019},
  organization={IEEE}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ExBrainable-0.0.11.tar.gz (33.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ExBrainable-0.0.11-py3-none-any.whl (33.4 kB view details)

Uploaded Python 3

File details

Details for the file ExBrainable-0.0.11.tar.gz.

File metadata

  • Download URL: ExBrainable-0.0.11.tar.gz
  • Upload date:
  • Size: 33.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.7

File hashes

Hashes for ExBrainable-0.0.11.tar.gz
Algorithm Hash digest
SHA256 3f16f3cd8d918aeb46d7ada133bef5ee42a1e862d2988ec404b8052dbd816bde
MD5 3de69f8eb9bf0cea13babff7ccd6a2ef
BLAKE2b-256 f9f4f1a60c59bc17e8c275c8d252a09d96adf7e617827f00dc1fc8e7e5563736

See more details on using hashes here.

File details

Details for the file ExBrainable-0.0.11-py3-none-any.whl.

File metadata

  • Download URL: ExBrainable-0.0.11-py3-none-any.whl
  • Upload date:
  • Size: 33.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.7

File hashes

Hashes for ExBrainable-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 bd0858609c68b46a70b16309ee3530988a63610b13af72ed166043dc089e7b72
MD5 c64726d07078efafd29db9aefa974629
BLAKE2b-256 8e9cd00ca526c77828a391a56bcd4e6ba9918892bc96d4746fd6b84bcc28ca07

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page