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

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

README.md

@@ -0,0 +1,74 @@
+---
+language: de
+license: mit
+tags:
+- flair
+- token-classification
+- sequence-tagger-model
+base_model: hmteams/teams-base-historic-multilingual-discriminator
+widget:
+- text: — Dramatiſch war der Stoff vor Sophokles von Äſchylos behandelt worden in
+    den Θροῇσσαι , denen vielleicht in der Trilogie das Stüc>"OnJw» κοίσις vorherging
+    , das Stück Σαλαμίνιαι folgte .
+---
+
+# Fine-tuned Flair Model on AjMC German NER Dataset (HIPE-2022)
+
+This Flair model was fine-tuned on the
+[AjMC German](https://github.com/hipe-eval/HIPE-2022-data/blob/main/documentation/README-ajmc.md)
+NER Dataset using hmTEAMS as backbone LM.
+
+The AjMC dataset consists of NE-annotated historical commentaries in the field of Classics,
+and was created in the context of the [Ajax MultiCommentary](https://mromanello.github.io/ajax-multi-commentary/)
+project.
+
+The following NEs were annotated: `pers`, `work`, `loc`, `object`, `date` and `scope`.
+
+# 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.         |
+|-----------------|--------------|--------------|--------------|--------------|--------------|--------------|
+| bs4-e10-lr3e-05 | [0.8798][1]  | [0.8771][2]  | [0.8841][3]  | [0.8905][4]  | [0.8825][5]  | 88.28 ± 0.45 |
+| bs4-e10-lr5e-05 | [0.8856][6]  | [0.8699][7]  | [0.8819][8]  | [0.8854][9]  | [0.8786][10] | 88.03 ± 0.58 |
+| bs8-e10-lr5e-05 | [0.8948][11] | [0.8685][12] | [0.8766][13] | [0.8726][14] | [0.8791][15] | 87.83 ± 0.9  |
+| bs8-e10-lr3e-05 | [0.873][16]  | [0.8851][17] | [0.8746][18] | [0.8785][19] | [0.8647][20] | 87.52 ± 0.67 |
+
+[1]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-1
+[2]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-2
+[3]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-3
+[4]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-4
+[5]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-5
+[6]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-1
+[7]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-2
+[8]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-3
+[9]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-4
+[10]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-5
+[11]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-1
+[12]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-2
+[13]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-3
+[14]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-4
+[15]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-5
+[16]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-1
+[17]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-2
+[18]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-3
+[19]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-4
+[20]: https://hf.co/stefan-it/hmbench-ajmc-de-hmteams-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-5
+
+The [training log](training.log) and TensorBoard logs (only for hmByT5 and hmTEAMS based models) 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 ❤️