readme: add initial version of model card (#1)

- readme: add initial version of model card (a86859e91f2232ab44f2dc4f1dba2225a4f74f01)

README.md

@@ -0,0 +1,73 @@
+---
+language: de
+license: mit
+tags:
+- flair
+- token-classification
+- sequence-tagger-model
+base_model: dbmdz/bert-base-historic-multilingual-cased
+widget:
+- text: In Teltsch und Jarmeritz wurden die abgegebenen Stimmen für Genossen Krapka
+    ungiltig erklärt , weil sie keinen Wohnort aufwiesen .
+---
+
+# Fine-tuned Flair Model on German NewsEye NER Dataset (HIPE-2022)
+
+This Flair model was fine-tuned on the
+[German NewsEye](https://github.com/hipe-eval/HIPE-2022-data/blob/main/documentation/README-newseye.md)
+NER Dataset using hmBERT 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: `[8, 4]`
+* Learning Rates: `[3e-05, 5e-05]`
+
+And report micro F1-score on development set:
+
+| Configuration   | Run 1        | Run 2        | Run 3        | Run 4        | Run 5        | Avg.         |
+|-----------------|--------------|--------------|--------------|--------------|--------------|--------------|
+| bs8-e10-lr5e-05 | [0.3974][1]  | [0.3847][2]  | [0.3941][3]  | [0.4084][4]  | [0.3881][5]  | 39.45 ± 0.82 |
+| bs8-e10-lr3e-05 | [0.3759][6]  | [0.39][7]    | [0.4087][8]  | [0.3916][9]  | [0.3884][10] | 39.09 ± 1.05 |
+| bs4-e10-lr3e-05 | [0.3732][11] | [0.4014][12] | [0.3915][13] | [0.3741][14] | [0.3805][15] | 38.41 ± 1.08 |
+| bs4-e10-lr5e-05 | [0.3654][16] | [0.3756][17] | [0.3845][18] | [0.3947][19] | [0.3933][20] | 38.27 ± 1.1  |
+
+[1]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-1
+[2]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-2
+[3]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-3
+[4]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-4
+[5]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-5
+[6]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-1
+[7]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-2
+[8]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-3
+[9]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-4
+[10]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-5
+[11]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-1
+[12]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-2
+[13]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-3
+[14]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-4
+[15]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-5
+[16]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-1
+[17]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-2
+[18]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-3
+[19]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-4
+[20]: https://hf.co/hmbench/hmbench-newseye-de-hmbert-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-5
+
+The [training log](training.log) and TensorBoard logs 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 ❤️