readme: first draft
Browse files
README.md
CHANGED
@@ -6,3 +6,81 @@ language:
|
|
6 |
# HisGermaNER: NER Datasets for Historical German
|
7 |
|
8 |
In this repository we release another NER dataset from historical German newspapers.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
6 |
# HisGermaNER: NER Datasets for Historical German
|
7 |
|
8 |
In this repository we release another NER dataset from historical German newspapers.
|
9 |
+
|
10 |
+
## Newspaper corpus
|
11 |
+
|
12 |
+
In the first release of our dataset, we select 11 newspapers from 1710 to 1840 from the Austrian National Library (ONB), resulting in 100 pages:
|
13 |
+
|
14 |
+
| Year | ONB ID | Newspaper | URL | Pages |
|
15 |
+
| ---- | ------------------ | -------------------------------- | ------------------------------------------------------------------------ | ----- |
|
16 |
+
| 1720 | `ONB_wrz_17200511` | Wiener Zeitung | [Viewer](https://anno.onb.ac.at/cgi-content/anno?aid=wrz&datum=17200511) | 10 |
|
17 |
+
| 1730 | `ONB_wrz_17300603` | Wiener Zeitung | [Viewer](https://anno.onb.ac.at/cgi-content/anno?aid=wrz&datum=17300603) | 14 |
|
18 |
+
| 1740 | `ONB_wrz_17401109` | Wiener Zeitung | [Viewer](https://anno.onb.ac.at/cgi-content/anno?aid=wrz&datum=17401109) | 12 |
|
19 |
+
| 1770 | `ONB_rpr_17700517` | Reichspostreuter | [Viewer](https://anno.onb.ac.at/cgi-content/anno?aid=rpr&datum=17700517) | 4 |
|
20 |
+
| 1780 | `ONB_wrz_17800701` | Wiener Zeitung | [Viewer](https://anno.onb.ac.at/cgi-content/anno?aid=wrz&datum=17800701) | 24 |
|
21 |
+
| 1790 | `ONB_pre_17901030` | Preßburger Zeitung | [Viewer](https://anno.onb.ac.at/cgi-content/anno?aid=pre&datum=17901030) | 12 |
|
22 |
+
| 1800 | `ONB_ibs_18000322` | Intelligenzblatt von Salzburg | [Viewer](https://anno.onb.ac.at/cgi-content/anno?aid=ibs&datum=18000322) | 8 |
|
23 |
+
| 1810 | `ONB_mgs_18100508` | Morgenblatt für gebildete Stände | [Viewer](https://anno.onb.ac.at/cgi-content/anno?aid=mgs&datum=18100508) | 4 |
|
24 |
+
| 1820 | `ONB_wan_18200824` | Der Wanderer | [Viewer](https://anno.onb.ac.at/cgi-content/anno?aid=wan&datum=18200824) | 4 |
|
25 |
+
| 1830 | `ONB_ild_18300713` | Das Inland | [Viewer](https://anno.onb.ac.at/cgi-content/anno?aid=ild&datum=18300713) | 4 |
|
26 |
+
| 1840 | `ONB_hum_18400625` | Der Humorist | [Viewer](https://anno.onb.ac.at/cgi-content/anno?aid=hum&datum=18400625) | 4 |
|
27 |
+
|
28 |
+
## Data Workflow
|
29 |
+
|
30 |
+
In the first step, we obtain original scans from ONB for our selected newspapers. In the second step, we perform OCR using [Transkribus](https://readcoop.eu/de/transkribus/).
|
31 |
+
|
32 |
+
We use the [Transkribus print M1](https://readcoop.eu/model/transkribus-print-multi-language-dutch-german-english-finnish-french-swedish-etc/) model for performing OCR.
|
33 |
+
Note: we experimented with an existing NewsEye model, but the print M1 model is newer and led to better performance in our preliminary experiments.
|
34 |
+
|
35 |
+
Only layout hints/fixes were made in Transkribus. So no OCR corrections or normalizations were performed.
|
36 |
+
|
37 |
+
We export plain text of all newspaper pages into plain text format and perform normalization of hyphenation and the `=` character.
|
38 |
+
After normalization we tokenize the plain text newspaper pages using the `PreTokenizer` of the [hmBERT](https://huggingface.co/hmbert) model.
|
39 |
+
|
40 |
+
After pre-tokenization we import the corpus into Argilla to start the annotation of named entities.
|
41 |
+
Note: We perform annotation at page/document-level. Thus, no sentence segmentation is needed and performed.
|
42 |
+
In the annotation process we also manually annotate sentence boundaries using a special `EOS` tag.
|
43 |
+
|
44 |
+
The dataset is exported into an CoNLL-like format after the annotation process.
|
45 |
+
The `EOS` tag is removed and the information of an potential end of sentence is stored in a special column.
|
46 |
+
|
47 |
+
## Annotation Guidelines
|
48 |
+
|
49 |
+
We use the same NE's (`PER`, `LOC` and `ORG`) and annotation guideline as used in the awesome [Europeana NER Corpora](https://github.com/cneud/ner-corpora).
|
50 |
+
|
51 |
+
Furthermore, we introduced some specific rules for annotations:
|
52 |
+
|
53 |
+
* `PER`: We include e.g. `Kaiser`, `Lord`, `Cardinal` or `Graf` in the NE, but not `Herr`, `Fräulein`, `General` or rank/grades.
|
54 |
+
* `LOC`: We excluded `Königreich` from the NE.
|
55 |
+
|
56 |
+
## Dataset Format
|
57 |
+
|
58 |
+
Our dataset format is inspired by the [HIPE-2022 Shared Task](https://github.com/hipe-eval/HIPE-2022-data?tab=readme-ov-file#hipe-format-and-tagging-scheme).
|
59 |
+
Here's an example of an annotated document:
|
60 |
+
|
61 |
+
```txt
|
62 |
+
TOKEN NE-COARSE-LIT MISC
|
63 |
+
|
64 |
+
-DOCSTART- O
|
65 |
+
|
66 |
+
# onb:id = ONB_wrz_17800701
|
67 |
+
# onb:image_link = https://anno.onb.ac.at/cgi-content/anno?aid=wrz&datum=17800701&seite=12
|
68 |
+
# onb:page_nr = 12
|
69 |
+
# onb:publication_year_str = 17800701
|
70 |
+
den O _
|
71 |
+
Pöbel O _
|
72 |
+
noch O _
|
73 |
+
mehr O _
|
74 |
+
in O _
|
75 |
+
Harnisch O _
|
76 |
+
. O EndOfSentence
|
77 |
+
Sie O _
|
78 |
+
legten O _
|
79 |
+
sogleich O _
|
80 |
+
```
|
81 |
+
|
82 |
+
Note: we include a `-DOCSTART-` information to e.g. allow document-level features for NER as proposed in the [FLERT](https://arxiv.org/abs/2011.06993) paper.
|
83 |
+
|
84 |
+
## Dataset Splits
|
85 |
+
|
86 |
+
For training powerful NER models on the dataset, we manually splitted the dataset into training, development and test splits.
|