stefan-it commited on
Commit
a0986e6
1 Parent(s): b03033f

readme: add initial version of model card

Browse files

Hey,

this commit adds the initial version of model card.

Files changed (1) hide show
  1. README.md +74 -0
README.md ADDED
@@ -0,0 +1,74 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language: fi
3
+ license: mit
4
+ tags:
5
+ - flair
6
+ - token-classification
7
+ - sequence-tagger-model
8
+ base_model: dbmdz/bert-base-historic-multilingual-64k-td-cased
9
+ widget:
10
+ - text: Rooseveltin sihteeri ilmoittaa perättö - mäksi tiedon , että Rooseveltia olisi
11
+ kehotettu käymään Englannissa , Saksassa ja Venäjällä puhumassa San Franciscon
12
+ näyttelyn puolesta .
13
+ ---
14
+
15
+ # Fine-tuned Flair Model on Finnish NewsEye NER Dataset (HIPE-2022)
16
+
17
+ This Flair model was fine-tuned on the
18
+ [Finnish NewsEye](https://github.com/hipe-eval/HIPE-2022-data/blob/main/documentation/README-newseye.md)
19
+ NER Dataset using hmBERT 64k as backbone LM.
20
+
21
+ The NewsEye dataset is comprised of diachronic historical newspaper material published between 1850 and 1950
22
+ in French, German, Finnish, and Swedish.
23
+ More information can be found [here](https://dl.acm.org/doi/abs/10.1145/3404835.3463255).
24
+
25
+ The following NEs were annotated: `PER`, `LOC`, `ORG` and `HumanProd`.
26
+
27
+ # Results
28
+
29
+ We performed a hyper-parameter search over the following parameters with 5 different seeds per configuration:
30
+
31
+ * Batch Sizes: `[4, 8]`
32
+ * Learning Rates: `[3e-05, 5e-05]`
33
+
34
+ And report micro F1-score on development set:
35
+
36
+ | Configuration | Seed 1 | Seed 2 | Seed 3 | Seed 4 | Seed 5 | Average |
37
+ |-------------------|--------------|------------------|--------------|--------------|--------------|-----------------|
38
+ | `bs8-e10-lr3e-05` | [0.7527][1] | [0.7732][2] | [0.7849][3] | [0.7702][4] | [0.7702][5] | 0.7702 ± 0.0115 |
39
+ | `bs4-e10-lr5e-05` | [0.7522][6] | [0.7642][7] | [0.787][8] | [0.7532][9] | [0.7832][10] | 0.768 ± 0.0164 |
40
+ | `bs4-e10-lr3e-05` | [0.7716][11] | [**0.7419**][12] | [0.7716][13] | [0.7722][14] | [0.7638][15] | 0.7642 ± 0.013 |
41
+ | `bs8-e10-lr5e-05` | [0.7484][16] | [0.7811][17] | [0.7706][18] | [0.7516][19] | [0.7521][20] | 0.7608 ± 0.0143 |
42
+
43
+ [1]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-1
44
+ [2]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-2
45
+ [3]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-3
46
+ [4]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-4
47
+ [5]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs8-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-5
48
+ [6]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-1
49
+ [7]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-2
50
+ [8]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-3
51
+ [9]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-4
52
+ [10]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs4-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-5
53
+ [11]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-1
54
+ [12]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-2
55
+ [13]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-3
56
+ [14]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-4
57
+ [15]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs4-wsFalse-e10-lr3e-05-poolingfirst-layers-1-crfFalse-5
58
+ [16]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-1
59
+ [17]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-2
60
+ [18]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-3
61
+ [19]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-4
62
+ [20]: https://hf.co/stefan-it/hmbench-newseye-fi-hmbert_64k-bs8-wsFalse-e10-lr5e-05-poolingfirst-layers-1-crfFalse-5
63
+
64
+ The [training log](training.log) and TensorBoard logs (not available for hmBERT Base model) are also uploaded to the model hub.
65
+
66
+ More information about fine-tuning can be found [here](https://github.com/stefan-it/hmBench).
67
+
68
+ # Acknowledgements
69
+
70
+ We thank [Luisa März](https://github.com/LuisaMaerz), [Katharina Schmid](https://github.com/schmika) and
71
+ [Erion Çano](https://github.com/erionc) for their fruitful discussions about Historic Language Models.
72
+
73
+ Research supported with Cloud TPUs from Google's [TPU Research Cloud](https://sites.research.google/trc/about/) (TRC).
74
+ Many Thanks for providing access to the TPUs ❤️