Update README.md

README.md

@@ -1,3 +1,42 @@
 ---
 license: cc-by-nc-nd-4.0
+pipeline_tag: tabular-classification
 ---
+# Flowformer
+
+Automatic detection of blast cells in ALL data using transformers. 
+
+Official implementation of our work: *"Automated Identification of Cell Populations in Flow Cytometry Data with Transformers"*
+by Matthias Wödlinger, Michael Reiter, Lisa Weijler, Margarita Maurer-Granofszky, Angela Schumich, Elisa O Sajaroff, Stefanie Groeneveld-Krentz, Jorge G Rossi, Leonid Karawajew, Richard Ratei and Michael Dworzak
+
+## Usage
+
+Load the pretrained model from huggingface
+
+```
+from transformers import AutoModel
+flowformer = AutoModel.from_pretrained("matth/flowformer", trust_remote_code=True)
+```
+
+`trust_remote_code=True` is necessary because the model code uses a custom architecture. 
+
+## Citation
+
+If you use this project please consider citing our work
+
+```
+@article{wodlinger2022automated,
+  title={Automated identification of cell populations in flow cytometry data with transformers},
+  author={Wödlinger, Matthias and Reiter, Michael and Weijler, Lisa and Maurer-Granofszky, Margarita and Schumich, Angela and Sajaroff, Elisa O and Groeneveld-Krentz, Stefanie and Rossi, Jorge G and Karawajew, Leonid and Ratei, Richard and others},
+  journal={Computers in Biology and Medicine},
+  volume={144},
+  pages={105314},
+  year={2022},
+  publisher={Elsevier}
+}
+```
+
+
+---
+license: cc-by-nc-nd-4.0
+---