bruAristimunha commited on
Commit
7a266eb
·
verified ·
1 Parent(s): 5b1a9e4

Complete training-data provenance and Braindecode software citation

Browse files

README-only metadata audit, 2026-11-09. Braindecode Zenodo citation. No weights, config, license, or upstream paper citations changed.

Files changed (1) hide show
  1. README.md +35 -0
README.md CHANGED
@@ -32,3 +32,38 @@ accessions, Hub ids otherwise). `nm`/`on` ids are datasets on [NEMAR](https://ne
32
  - Supervised cropped-decoding ShallowFBCSPNet (dense prediction, 1000-sample windows), subject 3 only. Gradient updates on session '0train' (MOABB session name); session '1test' is the skorch validation set and EarlyStopping(load_best=True) restores the epoch with the best validation loss, so the evaluation session selected the saved epoch (no gradient updates on it). Up to 100 epochs, patience 10. Same preprocessing as the trialwise tutorial.
33
  - Sources: braindecode git 05e606dd^:scripts/train_and_push_tutorial_checkpoints.py (offline trainer that produced the tutorial checkpoints; removed from the repo in 05e606dd, 2026-04-19, and moved to https://gist.github.com/bru...; https://huggingface.co/braindecode/plot_bcic_iv_2a_moabb_cropped/resolve/main/metadata.json; W/bd/examples/model_building/plot_bcic_iv_2a_moabb_cropped.py (gallery example of the same name).
34
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
32
  - Supervised cropped-decoding ShallowFBCSPNet (dense prediction, 1000-sample windows), subject 3 only. Gradient updates on session '0train' (MOABB session name); session '1test' is the skorch validation set and EarlyStopping(load_best=True) restores the epoch with the best validation loss, so the evaluation session selected the saved epoch (no gradient updates on it). Up to 100 epochs, patience 10. Same preprocessing as the trialwise tutorial.
33
  - Sources: braindecode git 05e606dd^:scripts/train_and_push_tutorial_checkpoints.py (offline trainer that produced the tutorial checkpoints; removed from the repo in 05e606dd, 2026-04-19, and moved to https://gist.github.com/bru...; https://huggingface.co/braindecode/plot_bcic_iv_2a_moabb_cropped/resolve/main/metadata.json; W/bd/examples/model_building/plot_bcic_iv_2a_moabb_cropped.py (gallery example of the same name).
34
 
35
+
36
+
37
+ ## Cite Braindecode
38
+
39
+ If you use this braindecode port in scientific work, cite the software on Zenodo,
40
+ [doi:10.5281/zenodo.17699192](https://doi.org/10.5281/zenodo.17699192),
41
+ and the original model and datasets cited above.
42
+
43
+ ```bibtex
44
+ @software{braindecode,
45
+ author = {Aristimunha, Bruno and
46
+ Guetschel, Pierre and
47
+ Wimpff, Martin and
48
+ Gemein, Lukas and
49
+ Rommel, Cedric and
50
+ Banville, Hubert and
51
+ Sliwowski, Maciej and
52
+ Wilson, Daniel and
53
+ Brandt, Simon and
54
+ Gnassounou, Théo and
55
+ Paillard, Joseph and
56
+ {Junqueira Lopes}, Bruna and
57
+ Sedlar, Sara and
58
+ Moreau, Thomas and
59
+ Chevallier, Sylvain and
60
+ Gramfort, Alexandre and
61
+ Schirrmeister, Robin Tibor},
62
+ title = {Braindecode: toolbox for decoding raw electrophysiological brain data
63
+ with deep learning models},
64
+ url = {https://github.com/braindecode/braindecode},
65
+ doi = {10.5281/zenodo.17699192},
66
+ publisher = {Zenodo},
67
+ license = {BSD-3-Clause},
68
+ }
69
+ ```