Update README.md

README.md

@@ -6,46 +6,63 @@ tags:
 - generated_from_setfit_trainer
 widget:
 - text: 03771 290230 oder 03771 2534030
-- text: Seit Jahresbeginn konnten wieder etliche Praxisbeispiele aus den hessischen
-    Regionen für die OloV - Website aufbereitet oder mit aktuellen Entwicklungen ergänzt
-    werden.
+- text: >-
+    Seit Jahresbeginn konnten wieder etliche Praxisbeispiele aus den hessischen
+    Regionen für die OloV - Website aufbereitet oder mit aktuellen Entwicklungen
+    ergänzt werden.
 - text: 在 Greding 出 口 离 开 A9 高 速 公 路 。
 - text: 'Vortrag : SIMCP WORKSHOP, online ( eingeladen ) ; 16. 11.'
-- text: Nicht nur bei Fragen zur von Smart CROSSBLADE Dachboxen hilft unser neu gestalteter
-    weiter.
-metrics:
-- accuracy
+- text: >-
+    Nicht nur bei Fragen zur von Smart CROSSBLADE Dachboxen hilft unser neu
+    gestalteter weiter.
 pipeline_tag: text-classification
 library_name: setfit
 inference: false
+license: mit
+datasets:
+- mbley/german-webtext-quality-classification-dataset
+language:
+- de
+base_model:
+- distilbert/distilbert-base-multilingual-cased
 ---
 
-# SetFit
+# Bootstrapping a Sentence-Level Corpus Quality Classifier for Web Text using Active Learning (RANLP25)
 
-This is a [SetFit](https://github.com/huggingface/setfit) model that can be used for Text Classification. A [SetFitHead](huggingface.co/docs/setfit/reference/main#setfit.SetFitHead) instance is used for classification.
+A multi-label sentence classifier trained with Active Learning for predicting high- or low-qality labels of german webtext. 
+Training and evaluation code: <https://github.com/maximilian-bley/german-webtext-quality-classification>
 
-The model has been trained using an efficient few-shot learning technique that involves:
+## Model Details
 
-1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
-2. Training a classification head with features from the fine-tuned Sentence Transformer.
+- **Labels**
 
-## Model Details
+- **0=Sentence Boundary:** Sentence boundary errors occur if the start or ending of a sentence is malformed. This is the case if it begins with a lower case letter or an atypical character, or lacks a proper terminal punctuation mark (e.g., period, exclamation mark, or question mark).
+
+- **1=Grammar Mistake:** Grammar mistakes are any grammatical errors such as incorrect articles, cases, word order and incorrect use or absence of words. Moreover, random-looking sequences of words, usually series of nouns, should be tagged. In most cases where this label is applicable, the sentence' comprehensibility or message is impaired.
+
+- **2=Spelling Anomaly:** A spelling anomaly is tagged when a word does not correspond to German spelling. This includes typos and incorrect capitalization (e.g. “all caps” or lower-case nouns). Spelling anomalies are irregularities that occur within the word boundary, meaning here text between two whitespaces. In particular, individual letters or nonsensical word fragments are also tagged.
+
+- **3=Punctuation Error:** Punctuation errors are tagged if a punctuation symbol has been placed incorrectly or is missing in the intended place. This includes comma errors, missing quotation marks or parentheses, periods instead of question marks or incorrect or missing dashes or hyphens.
+
+- **4=Non-linguistic Content:** Non-linguistic content includes all types of encoding errors, language-atypical occurrences of numbers and characters (e.g. random sequences of characters or letters), code (remnants), URLs, hashtags and emoticons.
+
+- **5=Letter Spacing:** Letter spacings are deliberately inserted spaces between the characters of a word.
+
+- **6=Clean:** Assigned if none of the other labels apply.
 
 ### Model Description
 - **Model Type:** SetFit
 <!-- - **Sentence Transformer:** [Unknown](https://huggingface.co/unknown) -->
 - **Classification head:** a [SetFitHead](huggingface.co/docs/setfit/reference/main#setfit.SetFitHead) instance
 - **Maximum Sequence Length:** 512 tokens
-<!-- - **Number of Classes:** Unknown -->
-<!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
-<!-- - **Language:** Unknown -->
-<!-- - **License:** Unknown -->
+**Number of Classes:** 6
+**Language:** German
+
 
 ### Model Sources
 
-- **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
-- **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
-- **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
+- **Repository:**
+- **Paper:**
 
 ## Uses
 
@@ -94,10 +111,6 @@ preds = model("在 Greding 出 口 离 开 A9 高 速 公 路 。")
 
 ## Training Details
 
-### Training Set Metrics
-| Training set | Min | Median  | Max |
-|:-------------|:----|:--------|:----|
-| Word count   | 1   | 20.4578 | 319 |
 
 ### Training Hyperparameters
 - batch_size: (8, 8)