Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

DOI Docs Build Status Test Build Status Code Coverage PyPI Version Python versions Downloads

Braindecode

Braindecode is an open-source Python toolbox for decoding raw electrophysiological brain data with deep learning models. It includes dataset fetchers, data preprocessing and visualization tools, as well as implementations of several deep learning architectures and data augmentations for analysis of EEG, ECoG and MEG.

For neuroscientists who want to work with deep learning and deep learning researchers who want to work with neurophysiological data.

Installation Braindecode

  1. Install pytorch from http://pytorch.org/ (you don’t need to install torchvision).

  2. If you want to download EEG datasets from MOABB, install it:

pip install moabb
  1. Install latest release of braindecode via pip:

pip install braindecode

If you want to install the latest development version of braindecode, please refer to contributing page

Documentation

Documentation is online under https://braindecode.org, both in the stable and dev versions.

Contributing to Braindecode

Guidelines for contributing to the library can be found on the braindecode github:

https://github.com/braindecode/braindecode/blob/master/CONTRIBUTING.md

Citing

If you use Braindecode in scientific work, please cite the software using the global Zenodo DOI shown in the badge below:

DOI

You can use the following BibTeX entry:

@misc{braindecode,
  author = {Aristimunha, Bruno and
            Guetschel, Pierre and
            Wimpff, Martin and
            Gemein, Lukas and
            Rommel, Cedric and
            Banville, Hubert and
            Sliwowski, Maciej and
            Wilson, Daniel and
            Brandt, Simon and
            Gnassounou, Théo and
            Paillard, Joseph and
            Srivastava, Aman and
            {Junqueira Lopes}, Bruna and
            Sedlar, Sara and
            Tayal, Sarthak and
            Truong, Young and
            Gadonneix, Julien and
            Mounir, Adam and
            Zhang, Zhibo and
            Soloviev, Anton and
            Li, Qing and
            Rathi, Raghav and
            Shah, Vandit and
            Arthur and
            Jain, Mahir and
            Kowshik, Bhargav and
            Li, Yiheng and
            Siddique, Fashad Ahmed and
            Moreau, Thomas and
            Chevallier, Sylvain and
            Gramfort, Alexandre and
            Schirrmeister, Robin Tibor},
  title = {Braindecode: toolbox for decoding raw electrophysiological brain data
           with deep learning models},
  howpublished = {Zenodo},
  url = {https://github.com/braindecode/braindecode},
  doi = {10.5281/zenodo.8214376},
  license = {BSD-3-Clause},
}

Additionally, we highly encourage you to cite the article that originally introduced the Braindecode library and has served as a foundational reference for many works on deep learning with EEG recordings. Please use the following reference:

@article {HBM: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},
issn = {1097-0193},
url = {http://dx.doi.org/10.1002/hbm.23730},
doi = {10.1002/hbm.23730},
month = {aug},
year = {2017},
keywords = {electroencephalography, EEG analysis, machine learning, end-to-end learning, brain–machine interface,
  brain–computer interface, model interpretability, brain mapping},
}

as well as the MNE-Python software that is used by braindecode:

@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},
}

Licensing

This project is primarily licensed under the BSD-3-Clause License.

Additional Components

Some components within this repository are licensed under other licenses, including Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0), Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0), MIT and Apache-2.0.

Please refer to the LICENSE and NOTICE files for the per-file list and more detailed information.

Metadata

Release files for braindecode 2.1.0.dev170146742

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for braindecode 2.1.0.dev170146742
File Size Uploaded Provenance Actions
braindecode-2.1.0.dev170146742.tar.gz 1.1 MB Without provenance Details for braindecode-2.1.0.dev170146742.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for braindecode 2.1.0.dev170146742
File Interpreter ABI Platform Actions
braindecode-2.1.0.dev170146742-py3-none-any.whl Python 3 none any Details for braindecode-2.1.0.dev170146742-py3-none-any.whl

Total release size: 2.2 MB

Release files / braindecode-2.1.0.dev170146742.tar.gz

Download URL braindecode-2.1.0.dev170146742.tar.gz
Size 1.1 MB
Tags Source
SHA-256 checksum
How to use checksums
fb201e1d209fd5f74d3d7bc15280b883cba722a71788f08184d0735109fca420
BLAKE2b-256 checksum
How to use checksums
bf97afb576c642e9a430cdee2b485e0387252019f26611b54e2b01071ddb940e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / braindecode-2.1.0.dev170146742-py3-none-any.whl

Download URL braindecode-2.1.0.dev170146742-py3-none-any.whl
Size 1.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
6f0c2ce1617655da975226efb95e3a529f0fe0e707e0ea78fa56256a86a07b92
BLAKE2b-256 checksum
How to use checksums
3ea87ca33c9a760369eb1cb5d4a6b1e93ed7e2eb2dfb0613e33d97955f94e929
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for braindecode 2.1.0.dev170146742

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page