model card updated

README.md

@@ -21,3 +21,38 @@ widget:
 metrics:
 - f1
 ---
+
+This model predicts the punctuation of plain text written in English, Italian, French and German. We developed it to restore the punctuation of transcribed spoken language. 
+
+This multilanguage model was trained on the [Europarl Dataset](https://huggingface.co/datasets/wmt/europarl) provided by the [SEPP-NLG Shared Task](https://sites.google.com/view/sentence-segmentation). *Please note that this dataset consists of political speeches. Therefore the model might perform differently on texts from other domains.*
+
+The model restores the following punctuation markers: **"." "," "?" "-" ":"**
+
+## Results 
+
+The model achieves the following F1 scores for the different languages. The performance differs for the single punctuation markers. Hyphens and colons, in many cases, are optional and can be substituted by either a comma or a full stop.
+
+| Label         | EN    | DE    | FR    | IT    |
+| ------------- | ----- | ----- | ----- | ----- |
+| 0             | 0.991 | 0.997 | 0.992 | 0.989 |
+| .             | 0.948 | 0.961 | 0.945 | 0.942 |
+| ?             | 0.890 | 0.893 | 0.871 | 0.832 |
+| ,             | 0.819 | 0.945 | 0.831 | 0.798 |
+| :             | 0.575 | 0.652 | 0.620 | 0.588 |
+| -             | 0.425 | 0.435 | 0.431 | 0.421 |
+| macro average | 0.775 | 0.814 | 0.782 | 0.762 |
+
+
+## References
+
+@article{guhr-EtAl:2021:fullstop,
+  title={FullStop: Multilingual Deep Models for Punctuation Prediction},
+  author    = {Guhr, Oliver  and  Schumann, Anne-Kathrin  and  Bahrmann, Frank  and  Böhme, Hans Joachim},
+  booktitle      = {Proceedings of the Swiss Text Analytics Conference 2021},
+  month          = {June},
+  year           = {2021},
+  address        = {Winterthur, Switzerland},
+  publisher      = {CEUR Workshop Proceedings},  
+  url       = {http://ceur-ws.org/Vol-2957/sepp_paper4.pdf}
+}
+