Update README.md

README.md

@@ -3,16 +3,22 @@ license: apache-2.0
 tags:
 - generated_from_keras_callback
 model-index:
-- name: tmpnhxhsble
+- name: tmp3y468_8j
   results: []
+widget:
+- text: "Ich liebe dich!"
+  example_title: "Non-vulgar"
+- text: "Leck mich am arsch"
+  example_title: "Vulgar"
 ---
 
-<!-- This model card has been generated automatically according to the information Keras had access to. You should
-probably proofread and complete it, then remove this comment. -->
+# KIZervus
 
-# tmpnhxhsble
+This model is a fine-tuned version of [distilbert-base-german-cased](https://huggingface.co/distilbert-base-german-cased).
+It is trained to classify german text into the classes "vulgar" speech and "non-vulgar" speech. 
+The data set is a collection of other labeled sources in german. For an overview, see the github repository here: https://github.com/NKDataConv/KIZervus
+Both data and training procedure are documented in the GitHub repo. Your are welcome to contribute.
 
-This model is a fine-tuned version of [distilbert-base-german-cased](https://huggingface.co/distilbert-base-german-cased) on an unknown dataset.
 It achieves the following results on the evaluation set:
 - Train Loss: 0.4640
 - Train Accuracy: 0.7744
@@ -20,19 +26,8 @@ It achieves the following results on the evaluation set:
 - Validation Accuracy: 0.7937
 - Epoch: 1
 
-## Model description
-
-More information needed
-
-## Intended uses & limitations
-
-More information needed
-
-## Training and evaluation data
-
-More information needed
-
 ## Training procedure
+For details, see the repo and documentation here: https://github.com/NKDataConv/KIZervus
 
 ### Training hyperparameters
 
@@ -54,3 +49,7 @@ The following hyperparameters were used during training:
 - TensorFlow 2.8.2
 - Datasets 2.2.2
 - Tokenizers 0.12.1
+
+### Supporter
+
+![BMBF Logo](./BMBF_Logo.png)