BDTCN / README.md
bruAristimunha's picture
Replace with clean markdown card
7e0acc1 verified
---
license: bsd-3-clause
library_name: braindecode
pipeline_tag: feature-extraction
tags:
- eeg
- biosignal
- pytorch
- neuroscience
- braindecode
- convolutional
---
# BDTCN
Braindecode TCN from Gemein, L et al (2020) [gemein2020].
> **Architecture-only repository.** Documents the
> `braindecode.models.BDTCN` class. **No pretrained weights are
> distributed here.** Instantiate the model and train it on your own
> data.
## Quick start
```bash
pip install braindecode
```
```python
from braindecode.models import BDTCN
model = BDTCN(
n_chans=22,
sfreq=250,
input_window_seconds=4.0,
n_outputs=4,
)
```
The signal-shape arguments above are illustrative defaults — adjust to
match your recording.
## Documentation
- Full API reference: <https://braindecode.org/stable/generated/braindecode.models.BDTCN.html>
- Interactive browser (live instantiation, parameter counts):
<https://huggingface.co/spaces/braindecode/model-explorer>
- Source on GitHub: <https://github.com/braindecode/braindecode/blob/master/braindecode/models/tcn.py#L14>
## Architecture
![BDTCN architecture](https://ars.els-cdn.com/content/image/1-s2.0-S1053811920305073-gr3_lrg.jpg)
## Parameters
| Parameter | Type | Description |
|---|---|---|
| `n_filters: int` | — | number of output filters of each convolution |
| `n_blocks: int` | — | number of temporal blocks in the network |
| `kernel_size: int` | — | kernel size of the convolutions |
| `drop_prob: float` | — | dropout probability |
| `activation: nn.Module, default=nn.ReLU` | — | Activation function class to apply. Should be a PyTorch activation module class like `nn.ReLU` or `nn.ELU`. Default is `nn.ReLU`. |
## References
1. Gemein, L. A., Schirrmeister, R. T., Chrabąszcz, P., Wilson, D., Boedecker, J., Schulze-Bonhage, A., ... & Ball, T. (2020). Machine-learning-based diagnostics of EEG pathology. NeuroImage, 220, 117021.
## Citation
Cite the original architecture paper (see *References* above) and braindecode:
```bibtex
@article{aristimunha2025braindecode,
title = {Braindecode: a deep learning library for raw electrophysiological data},
author = {Aristimunha, Bruno and others},
journal = {Zenodo},
year = {2025},
doi = {10.5281/zenodo.17699192},
}
```
## License
BSD-3-Clause for the model code (matching braindecode).
Pretraining-derived weights, if you fine-tune from a checkpoint,
inherit the licence of that checkpoint and its training corpus.