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

- readme: add initial version of model card (22641dc24dee92d893e5cd2e56e54cf63bb4bbdb)

README.md

@@ -0,0 +1,75 @@
+---
+language: fr
+license: mit
+tags:
+- flair
+- token-classification
+- sequence-tagger-model
+base_model: hmteams/teams-base-historic-multilingual-discriminator
+widget:
+- text: Nous recevons le premier numéro d ' un nouveau journal , le Radical - Libéral
+    , qui paraîtra à Genève deux fois la semaine . Son but est de représenter l '
+    élément national du radicalisme genevois , en d ' autres termes , de défendre
+    la politique intransigeante do M . Carteret , en opposition aux tendances du groupe
+    _ > dont le Genevois est l ' organe . Bétail .
+---
+
+# Fine-tuned Flair Model on French HIPE-2020 Dataset (HIPE-2022)
+
+This Flair model was fine-tuned on the
+[French HIPE-2020](https://github.com/hipe-eval/HIPE-2022-data/blob/main/documentation/README-hipe2020.md)
+NER Dataset using hmTEAMS as backbone LM.
+
+The HIPE-2020 dataset is comprised of newspapers from mid 19C to mid 20C. For information can be found
+[here](https://dl.acm.org/doi/abs/10.1007/978-3-030-58219-7_21).
+
+The following NEs were annotated: `loc`, `org`, `pers`, `prod`, `time` and `comp`.
+
+# 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-lr3e-05 | [0.8652][1] | [0.8552][2]  | [0.8526][3]  | [0.8585][4]  | [0.8615][5]  | 85.86 ± 0.45 |
+| bs4-e10-lr3e-05 | [0.8602][6] | [0.8556][7]  | [0.8512][8]  | [0.8511][9]  | [0.8595][10] | 85.55 ± 0.39 |
+| bs8-e10-lr5e-05 | [0.85][11]  | [0.8592][12] | [0.8534][13] | [0.8473][14] | [0.8505][15] | 85.21 ± 0.41 |
+| bs4-e10-lr5e-05 | [0.839][16] | [0.8473][17] | [0.8385][18] | [0.839][19]  | [0.8488][20] | 84.25 ± 0.45 |
+
+[1]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-1
+[2]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-2
+[3]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-3
+[4]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-4
+[5]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-5
+[6]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-1
+[7]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-2
+[8]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-3
+[9]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-4
+[10]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-5
+[11]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-1
+[12]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-2
+[13]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-3
+[14]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-4
+[15]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-5
+[16]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-1
+[17]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-2
+[18]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-3
+[19]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-4
+[20]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmteams-bs4-wsFalse-e10-lr5e-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 ❤️