Upload README.md with huggingface_hub

README.md

@@ -1,14 +1,43 @@
 ---
+license: apache-2.0
+tags: [braindecode, eeg, ieeg, mvpformer, seizure-detection]
 library_name: braindecode
-license: bsd-3-clause
-tags:
-- MVPFormer
-- braindecode
-- model_hub_mixin
-- pytorch_model_hub_mixin
 ---
 
-This model has been pushed to the Hub using the [PytorchModelHubMixin](https://huggingface.co/docs/huggingface_hub/package_reference/mixins#huggingface_hub.PyTorchModelHubMixin) integration:
-- Code: https://braindecode.org
-- Paper: [More Information Needed]
-- Docs: https://braindecode.org/stable/generated/braindecode.models.MVPFormer.html
+# MVPFormer-S seizure detector (SWEC)
+
+MVPFormer-S with its SWEC LoRA adapters merged in and the seizure classification head attached. Ready for inference.
+
+```python
+from braindecode.models import MVPFormer
+
+model = MVPFormer.from_pretrained("braindecode/mvpformer-s-swec")
+```
+
+Outputs 2 classes (non-seizure, seizure).
+
+## Licence and intended use
+
+Weights © IBM Corp. 2024-2025, released under Apache-2.0 (`SPDX-License-Identifier: Apache-2.0`)
+by <https://github.com/IBM/multi-variate-parallel-transformer>. Redistributed here unmodified in
+substance; only the parameter names were remapped onto braindecode's `MVPFormer`.
+
+The authors attach the following restriction, reproduced verbatim from the upstream README:
+
+> This software may only be used for research. For other applications any liability is denied.
+> In particular, the software must not be used for diagnostic purposes.
+
+The paper's broader-impact statement adds: "both our model and our dataset are developed purely
+for research, and may not be used for any other purpose, especially diagnostic."
+
+## Citation
+
+```bibtex
+@article{carzaniga2025foundation,
+  title={A foundation model with multi-variate parallel attention to generate neuronal activity},
+  author={Carzaniga, Francesco and Hersche, Michael and Sebastian, Abu and Schindler, Kaspar and Rahimi, Abbas},
+  journal={arXiv preprint arXiv:2506.20354},
+  year={2025}
+}
+```
+