Update README.md

README.md

@@ -1,3 +1,44 @@
+---
+tags:
+- spacy
+- token-classification
+language:
+- de
+model-index:
+- name: de_pipeline
+  results:
+  - task:
+      name: TAG
+      type: token-classification
+    metrics:
+    - name: TAG (XPOS) Accuracy
+      type: accuracy
+      value: 0.9191333537
+license: cc-by-4.0
+library_name: spacy
+---
+## de_STTS2_folk tagger
+
+This is a spaCy language model trained to use the Stuttgart-Tübingen Tagset version 2.0, which was designed to tag transcripts of conversational speech in German. 
+The model may be useful for tagging ASR transcripts such as those collected in the [CoGS](https://cc.oulu.fi/~scoats/CoGS.html) corpus.
+
+The model was trained using the tag annotations from the FOLK corpus at https://agd.ids-mannheim.de/folk-gold.shtml. Tokens in the training data for the model were converted to lower case prior to traning to match the format used for automatic speech recognition transcripts on YouTube, as of early 2023.
+
+Usage example:
+```python
+!pip install https://huggingface.co/stcoats/de_pipeline/resolve/main/de_pipeline-any-py3-none-any.whl
+import de_pipeline
+nlp = de_pipeline.load()
+doc = nlp("ach so meinst du wir sollen es jetzt tun")
+for token in doc:
+    print(token.text, token.tag_)
+```
+### References
+
+Coats, Steven. (In review). 
+
+Westpfahl, Swantje and Thomas Schmidt. (2016): [FOLK-Gold – A GOLD standard for Part-of-Speech-Tagging of Spoken German](https://aclanthology.org/L16-1237). In: Proceedings of the Tenth International Conference on Language Resources and Evaluation (LREC’16), Portorož, Slovenia. Paris: European Language Resources Association (ELRA), pp. 1493-1499. 
+
 ---
 tags:
 - spacy
@@ -23,9 +64,9 @@ model-index:
 | **Default Pipeline** | `tok2vec`, `tagger` |
 | **Components** | `tok2vec`, `tagger` |
 | **Vectors** | 0 keys, 0 unique vectors (0 dimensions) |
-| **Sources** | n/a |
-| **License** | n/a |
-| **Author** | [n/a]() |
+| **Sources** | Swantje Westpfahl and Thomas Schmidt, FOLK-Gold, https://agd.ids-mannheim.de/folk-gold.shtml |
+| **License** | CC-BY 4.0 |
+| **Author** | Steven Coats |
 
 ### Label Scheme