readme: add initial version of model card

Hey,

this commit adds the initial version of model card.

README.md

@@ -0,0 +1,74 @@
+---
+language: sv
+license: mit
+tags:
+- flair
+- token-classification
+- sequence-tagger-model
+base_model: dbmdz/bert-tiny-historic-multilingual-cased
+widget:
+- text: Värri , Teittinen , Forsman , Tensik - kala m . fl . anslöto sig till reservatio
+    - nen , hvaremot lm Fieandt , Huopo - nen , Koskelin , Leppänen , ( Li - belits
+    ) , Eklund m . fl . förordade ut - skottets formulering af § 11 .
+---
+
+# Fine-tuned Flair Model on Swedish NewsEye NER Dataset (HIPE-2022)
+
+This Flair model was fine-tuned on the
+[Swedish NewsEye](https://github.com/hipe-eval/HIPE-2022-data/blob/main/documentation/README-newseye.md)
+NER Dataset using hmBERT Tiny as backbone LM.
+
+The NewsEye dataset is comprised of diachronic historical newspaper material published between 1850 and 1950
+in French, German, Finnish, and Swedish.
+More information can be found [here](https://dl.acm.org/doi/abs/10.1145/3404835.3463255).
+
+The following NEs were annotated: `PER`, `LOC`, `ORG` and `HumanProd`.
+
+# Results
+
+We performed a hyper-parameter search over the following parameters with 5 different seeds per configuration:
+
+* Batch Sizes: `[4, 8]`
+* Learning Rates: `[5e-05, 3e-05]`
+
+And report micro F1-score on development set:
+
+| Configuration     | Seed 1       | Seed 2       | Seed 3          | Seed 4       | Seed 5       | Average         |
+|-------------------|--------------|--------------|-----------------|--------------|--------------|-----------------|
+| `bs4-e10-lr5e-05` | [0.4847][1]  | [0.481][2]   | [0.4674][3]     | [0.5085][4]  | [0.474][5]   | 0.4831 ± 0.0157 |
+| `bs8-e10-lr5e-05` | [0.3983][6]  | [0.4194][7]  | [**0.3856**][8] | [0.4435][9]  | [0.4053][10] | 0.4104 ± 0.0222 |
+| `bs4-e10-lr3e-05` | [0.3761][11] | [0.38][12]   | [0.3236][13]    | [0.3594][14] | [0.3567][15] | 0.3592 ± 0.0223 |
+| `bs8-e10-lr3e-05` | [0.1194][16] | [0.1521][17] | [0.104][18]     | [0.1294][19] | [0.1399][20] | 0.129 ± 0.0185  |
+
+[1]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-1
+[2]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-2
+[3]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-3
+[4]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-4
+[5]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-5
+[6]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-1
+[7]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-2
+[8]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-3
+[9]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-4
+[10]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-5
+[11]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-1
+[12]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-2
+[13]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-3
+[14]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-4
+[15]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-5
+[16]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-1
+[17]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-2
+[18]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-3
+[19]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-4
+[20]: https://hf.co/stefan-it/hmbench-newseye-sv-hmbert_tiny-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-5
+
+The [training log](training.log) and TensorBoard logs (not available for hmBERT Base model) are also uploaded to the model hub.
+
+More information about fine-tuning can be found [here](https://github.com/stefan-it/hmBench).
+
+# Acknowledgements
+
+We thank [Luisa März](https://github.com/LuisaMaerz), [Katharina Schmid](https://github.com/schmika) and
+[Erion Çano](https://github.com/erionc) for their fruitful discussions about Historic Language Models.
+
+Research supported with Cloud TPUs from Google's [TPU Research Cloud](https://sites.research.google/trc/about/) (TRC).
+Many Thanks for providing access to the TPUs ❤️