bruAristimunha commited on
Commit
225546f
·
verified ·
1 Parent(s): 15dd343

Replace with clean markdown card

Browse files
Files changed (1) hide show
  1. README.md +15 -36
README.md CHANGED
@@ -15,11 +15,10 @@ tags:
15
 
16
  Deprecated alias for EEGNet.
17
 
18
- > **Architecture-only repository.** This repo documents the
19
  > `braindecode.models.EEGNetv4` class. **No pretrained weights are
20
- > distributed here** instantiate the model and train it on your own
21
- > data, or fine-tune from a published foundation-model checkpoint
22
- > separately.
23
 
24
  ## Quick start
25
 
@@ -38,46 +37,26 @@ model = EEGNetv4(
38
  )
39
  ```
40
 
41
- The signal-shape arguments above are example defaults — adjust them
42
- to match your recording.
43
 
44
  ## Documentation
45
-
46
- - Full API reference (parameters, references, architecture figure):
47
- <https://braindecode.org/stable/generated/braindecode.models.EEGNetv4.html>
48
- - Interactive browser with live instantiation:
49
  <https://huggingface.co/spaces/braindecode/model-explorer>
50
  - Source on GitHub: <https://github.com/braindecode/braindecode/blob/master/braindecode/models/eegnet.py#L353>
51
 
52
- ## Architecture description
53
-
54
- The block below is the rendered class docstring (parameters,
55
- references, architecture figure where available).
56
-
57
- <div class='bd-doc'><main>
58
- <p>Deprecated alias for EEGNet.</p>
59
- <blockquote>
60
- <p class="rubric">Hugging Face Hub integration</p>
61
- <p>When the optional <span class="docutils literal">huggingface_hub</span> package is installed, all models
62
- automatically gain the ability to be pushed to and loaded from the
63
- Hugging Face Hub. Install with:</p>
64
- <pre class="literal-block">pip install braindecode[hub]</pre>
65
- <p><strong>Pushing a model to the Hub:</strong></p>
66
- <p><strong>Loading a model from the Hub:</strong></p>
67
- <p><strong>Extracting features and replacing the head:</strong></p>
68
- <p><strong>Saving and restoring full configuration:</strong></p>
69
- <p>All model parameters (both EEG-specific and model-specific such as
70
- dropout rates, activation functions, number of filters) are automatically
71
- saved to the Hub and restored when loading.</p>
72
- <p>See :ref:`load-pretrained-models` for a complete tutorial.</p>
73
- </blockquote>
74
- </main>
75
- </div>
76
 
77
  ## Citation
78
 
79
- Please cite both the original paper for this architecture (see the
80
- *References* section above) and braindecode:
81
 
82
  ```bibtex
83
  @article{aristimunha2025braindecode,
 
15
 
16
  Deprecated alias for EEGNet.
17
 
18
+ > **Architecture-only repository.** Documents the
19
  > `braindecode.models.EEGNetv4` class. **No pretrained weights are
20
+ > distributed here.** Instantiate the model and train it on your own
21
+ > data.
 
22
 
23
  ## Quick start
24
 
 
37
  )
38
  ```
39
 
40
+ The signal-shape arguments above are illustrative defaults — adjust to
41
+ match your recording.
42
 
43
  ## Documentation
44
+ - Full API reference: <https://braindecode.org/stable/generated/braindecode.models.EEGNetv4.html>
45
+ - Interactive browser (live instantiation, parameter counts):
 
 
46
  <https://huggingface.co/spaces/braindecode/model-explorer>
47
  - Source on GitHub: <https://github.com/braindecode/braindecode/blob/master/braindecode/models/eegnet.py#L353>
48
 
49
+
50
+
51
+ ## Parameters
52
+
53
+ _(see source for parameter list)_
54
+
55
+
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
56
 
57
  ## Citation
58
 
59
+ Cite the original architecture paper (see *References* above) and braindecode:
 
60
 
61
  ```bibtex
62
  @article{aristimunha2025braindecode,