Update README.md

README.md

@@ -18,9 +18,8 @@ license: apache-2.0
 # Model Card for sbb_ner
 
 <!-- Provide a quick summary of what the model is/does. [Optional] -->
-A BERT model trained on three German corpora containing contemporary and historical texts for named entity recognition tasks. It predicts the classes PER, LOC and ORG. 
-The model was developed by the Berlin State Library (SBB) in the [QURATOR](https://staatsbibliothek-berlin.de/die-staatsbibliothek/projekte/project-id-1060-2018) 
-and [Mensch.Maschine.Kultur]( https://mmk.sbb.berlin/?lang=en) projects. 
+A BERT model trained on three German corpora containing contemporary and historical texts for named entity recognition tasks. It predicts the classes `PER`, `LOC` and `ORG`. 
+The model was developed by the Berlin State Library (SBB) in the [QURATOR](https://staatsbibliothek-berlin.de/die-staatsbibliothek/projekte/project-id-1060-2018) project. 
 
 
 
@@ -68,9 +67,9 @@ and [Mensch.Maschine.Kultur]( https://mmk.sbb.berlin/?lang=en) projects.
 
 <!-- Provide a longer summary of what this model is/does. -->
 A BERT model trained on three German corpora containing contemporary and historical texts for named entity recognition tasks. 
-It predicts the classes PER, LOC and ORG. 
+It predicts the classes `PER`, `LOC` and `ORG`. 
 
-- **Developed by:** [Kai Labusch](kai.labusch@sbb.spk-berlin.de), [Clemens Neudecker](clemens.[email protected]), David Zellhöfer
+- **Developed by:** [Kai Labusch](https://huggingface.co/labusch), [Clemens Neudecker](https://huggingface.co/cneud), David Zellhöfer
 - **Shared by [Optional]:** [Staatsbibliothek zu Berlin / Berlin State Library](https://huggingface.co/SBB)
 - **Model type:** Language model
 - **Language(s) (NLP):** de
@@ -87,8 +86,8 @@ It predicts the classes PER, LOC and ORG.
 
 ## Direct Use
 
-The model can directly be used to perform NER on historical German texts obtained by OCR from digitized documents.
-Supported entity types are PER, LOC and ORG. 
+The model can directly be used to perform NER on historical German texts obtained by Optical Character Recognition (OCR) from digitized documents.
+Supported entity types are `PER`, `LOC` and `ORG`. 
 
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 <!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
@@ -98,7 +97,7 @@ Supported entity types are PER, LOC and ORG.
 <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 <!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
  
-The model has been pre-trained on 2.300.000 pages of OCR-text of the digitized collections of Berlin State Library.
+The model has been pre-trained on 2,333,647 pages of OCR-text of the digitized collections of Berlin State Library.
 Therefore it is adapted to OCR-error prone historical German texts and might be used for particular applications that involve such text material.
 
 
@@ -146,7 +145,7 @@ The BERT model is trained directly with respect to the NER by implementation of
 
 ### Preprocessing
 
-The model was pre-trained on 2.300.000 pages of German texts from the digitized collections of the Berlin State Library.
+The model was pre-trained on 2,333,647 pages of German texts from the digitized collections of the Berlin State Library.
 The texts have been obtained by OCR from the page scans of the documents.
 
 ### Speeds, Sizes, Times
@@ -221,7 +220,7 @@ See above.
 
 ### Software
 
-See published code on [GithHub]( https://github.com/qurator-spk/sbb_ner).
+See published code on [GithHub](https://github.com/qurator-spk/sbb_ner).
 
 # Citation
 
@@ -229,15 +228,15 @@ See published code on [GithHub]( https://github.com/qurator-spk/sbb_ner).
 
 **BibTeX:**
 
-@article{labusch_bert_2019,
-	title = {{BERT} for {Named} {Entity} {Recognition} in {Contemporary} and {Historical} {German}},
-	volume = {Conference on Natural Language Processing},
-	url = {https://konvens.org/proceedings/2019/papers/KONVENS2019_paper_4.pdf},
-	abstract = {We apply a pre-trained transformer based representational language model, i.e. BERT (Devlin et al., 2018), to named entity recognition (NER) in contemporary and historical German text and observe state of the art performance for both text categories. We further improve the recognition performance for historical German by unsupervised pre-training on a large corpus of historical German texts of the Berlin State Library and show that best performance for historical German is obtained by unsupervised pre-training on historical German plus supervised pre-training with contemporary NER ground-truth.},
-	language = {en},
-	author = {Labusch, Kai and Neudecker, Clemens and Zellhöfer, David},
-	year = {2019},
-	pages = {9},
+@article{labusch_bert_2019,  
+	title = {{BERT} for {Named} {Entity} {Recognition} in {Contemporary} and {Historical} {German}},  
+	volume = {Conference on Natural Language Processing},  
+	url = {https://konvens.org/proceedings/2019/papers/KONVENS2019_paper_4.pdf},  
+	abstract = {We apply a pre-trained transformer based representational language model, i.e. BERT (Devlin et al., 2018), to named entity recognition (NER) in contemporary and historical German text and observe state of the art performance for both text categories. We further improve the recognition performance for historical German by unsupervised pre-training on a large corpus of historical German texts of the Berlin State Library and show that best performance for historical German is obtained by unsupervised pre-training on historical German plus supervised pre-training with contemporary NER ground-truth.},  
+	language = {en},  
+	author = {Labusch, Kai and Neudecker, Clemens and Zellhöfer, David},  
+	year = {2019},  
+	pages = {9},  
 }
 
 **APA:**
@@ -254,13 +253,13 @@ More information needed.
 
 In addition to what has been documented above, it should be noted that there are two NER Ground Truth datasets available:
 
-1) [Data provided for the 2020 HIPE campaign on named entity processing]( https://impresso.github.io/CLEF-HIPE-2020/)
-2) [Data providided for the 2022 HIPE shared task on named entity processing]( https://hipe-eval.github.io/HIPE-2022/) 
+1) [Data provided for the 2020 HIPE campaign on named entity processing](https://impresso.github.io/CLEF-HIPE-2020/)
+2) [Data providided for the 2022 HIPE shared task on named entity processing](https://hipe-eval.github.io/HIPE-2022/) 
  
 Furthermore, two papers have been published on NER/NED, using BERT:
 
-1) [Entity Linking in Multilingual Newspapers and Classical Commentaries with BERT]( http://ceur-ws.org/Vol-3180/paper-85.pdf)
-2) [Named Entity Disambiguation and Linking Historic Newspaper OCR with BERT]( http://ceur-ws.org/Vol-2696/paper_163.pdf)
+1) [Entity Linking in Multilingual Newspapers and Classical Commentaries with BERT](http://ceur-ws.org/Vol-3180/paper-85.pdf)
+2) [Named Entity Disambiguation and Linking Historic Newspaper OCR with BERT](http://ceur-ws.org/Vol-2696/paper_163.pdf)
 
 
 # Model Card Authors [optional]