stefan-it commited on
Commit
c539667
1 Parent(s): 74c6741

readme: add initial version of model card

Browse files

Hey,

this PR adds the initial version of model card.

Files changed (1) hide show
  1. README.md +75 -0
README.md ADDED
@@ -0,0 +1,75 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language: fr
3
+ license: mit
4
+ tags:
5
+ - flair
6
+ - token-classification
7
+ - sequence-tagger-model
8
+ base_model: dbmdz/bert-tiny-historic-multilingual-cased
9
+ widget:
10
+ - text: Nous recevons le premier numéro d ' un nouveau journal , le Radical - Libéral
11
+ , qui paraîtra à Genève deux fois la semaine . Son but est de représenter l '
12
+ élément national du radicalisme genevois , en d ' autres termes , de défendre
13
+ la politique intransigeante do M . Carteret , en opposition aux tendances du groupe
14
+ _ > dont le Genevois est l ' organe . Bétail .
15
+ ---
16
+
17
+ # Fine-tuned Flair Model on French HIPE-2020 Dataset (HIPE-2022)
18
+
19
+ This Flair model was fine-tuned on the
20
+ [French HIPE-2020](https://github.com/hipe-eval/HIPE-2022-data/blob/main/documentation/README-hipe2020.md)
21
+ NER Dataset using hmBERT Tiny as backbone LM.
22
+
23
+ The HIPE-2020 dataset is comprised of newspapers from mid 19C to mid 20C. For information can be found
24
+ [here](https://dl.acm.org/doi/abs/10.1007/978-3-030-58219-7_21).
25
+
26
+ The following NEs were annotated: `loc`, `org`, `pers`, `prod`, `time` and `comp`.
27
+
28
+ # Results
29
+
30
+ We performed a hyper-parameter search over the following parameters with 5 different seeds per configuration:
31
+
32
+ * Batch Sizes: `[4, 8]`
33
+ * Learning Rates: `[5e-05, 3e-05]`
34
+
35
+ And report micro F1-score on development set:
36
+
37
+ | Configuration | Seed 1 | Seed 2 | Seed 3 | Seed 4 | Seed 5 | Average |
38
+ |-------------------|------------------|--------------|--------------|--------------|--------------|-----------------|
39
+ | `bs4-e10-lr5e-05` | [0.5204][1] | [0.5597][2] | [0.5669][3] | [0.5394][4] | [0.5182][5] | 0.5409 ± 0.0222 |
40
+ | `bs8-e10-lr5e-05` | [0.4945][6] | [0.5457][7] | [0.5225][8] | [0.5068][9] | [0.493][10] | 0.5125 ± 0.022 |
41
+ | `bs4-e10-lr3e-05` | [0.4774][11] | [0.5395][12] | [0.5184][13] | [0.4849][14] | [0.4722][15] | 0.4985 ± 0.0291 |
42
+ | `bs8-e10-lr3e-05` | [**0.4335**][16] | [0.4814][17] | [0.4744][18] | [0.4443][19] | [0.456][20] | 0.4579 ± 0.0201 |
43
+
44
+ [1]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-1
45
+ [2]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-2
46
+ [3]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-3
47
+ [4]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-4
48
+ [5]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-5
49
+ [6]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-1
50
+ [7]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-2
51
+ [8]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-3
52
+ [9]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-4
53
+ [10]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-5
54
+ [11]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-1
55
+ [12]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-2
56
+ [13]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-3
57
+ [14]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-4
58
+ [15]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-5
59
+ [16]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-1
60
+ [17]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-2
61
+ [18]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-3
62
+ [19]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-4
63
+ [20]: https://hf.co/stefan-it/hmbench-hipe2020-fr-hmbert_tiny-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-5
64
+
65
+ The [training log](training.log) and TensorBoard logs (not available for hmBERT Base model) are also uploaded to the model hub.
66
+
67
+ More information about fine-tuning can be found [here](https://github.com/stefan-it/hmBench).
68
+
69
+ # Acknowledgements
70
+
71
+ We thank [Luisa März](https://github.com/LuisaMaerz), [Katharina Schmid](https://github.com/schmika) and
72
+ [Erion Çano](https://github.com/erionc) for their fruitful discussions about Historic Language Models.
73
+
74
+ Research supported with Cloud TPUs from Google's [TPU Research Cloud](https://sites.research.google/trc/about/) (TRC).
75
+ Many Thanks for providing access to the TPUs ❤️