Model card in English; add widget examples, link to EN counterpart

README.md

@@ -8,54 +8,78 @@ tags:
   - literature
   - digital-humanities
   - narratology
+widget:
+  - text: "Er trat durch die Tür und schloss sie hinter sich."
+    example_title: action_space
+  - text: "Vom Hügel aus konnte sie das ganze Tal unter sich liegen sehen."
+    example_title: visual_space
+  - text: "Das Zimmer wirkte schwer und bedrückend, als rückten die Wände näher."
+    example_title: perceived_space
+  - text: "In der Ecke stand ein Tisch, bedeckt mit staubigen Büchern."
+    example_title: descriptive_space
+  - text: "Sie fragte sich, ob er ihr jemals zurückschreiben würde."
+    example_title: no_space
 ---
 
 # de-setting-classifier
 
-Satzweiser Klassifikator für die räumliche Darstellung in deutschsprachiger Prosa.
-Feinabgestimmt auf [`lkonle/fiction-gbert-large`](https://huggingface.co/lkonle/fiction-gbert-large)
-(BERT-large, für deutschsprachige erzählende Prosa vortrainiert).
+Sentence-level classifier for the representation of space in German narrative prose.
+Fine-tuned from [`lkonle/fiction-gbert-large`](https://huggingface.co/lkonle/fiction-gbert-large)
+(BERT-large, pre-trained on German fiction).
 
-## Kategorien
+German counterpart to
+[`katrohrb/narrative-space-classifier`](https://huggingface.co/katrohrb/narrative-space-classifier);
+both models use the same five categories and the same label encoding.
 
-| Label               | Deutsche Bezeichnung | Beschreibung                                                          |
-|---------------------|-----------------------|------------------------------------------------------------------------|
-| `action_space`       | Aktionsraum           | Raum, der durch Bewegung und direkten Kontakt einer Figur erfasst wird |
-| `visual_space`        | Anschauungsraum       | Raum, wie er von einer Figur aus der Distanz wahrgenommen wird        |
-| `perceived_space`     | gestimmter Raum       | Raum, wie er Stimmung und Atmosphäre widerspiegelt                    |
-| `descriptive_space`   | Raumbeschreibung      | Dinge/Objekte im Raum, ohne Bezug zu einer Figur                      |
-| `no_space`            | kein Raum             | kein Raumbezug                                                        |
+## Categories
+
+| Label               | German term        | Description                                                                 |
+|---------------------|--------------------|-----------------------------------------------------------------------------|
+| `action_space`      | Aktionsraum        | Space registered through a character's movement and direct physical contact |
+| `visual_space`      | Anschauungsraum    | Space as perceived by a character from a distance                           |
+| `perceived_space`   | gestimmter Raum    | Space as it carries mood and atmosphere                                     |
+| `descriptive_space` | Raumbeschreibung   | Things and objects in space, without reference to a character               |
+| `no_space`          | kein Raum          | No spatial reference                                                        |
+
+Label ids: `0 perceived_space`, `1 action_space`, `2 visual_space`, `3 descriptive_space`,
+`4 no_space` (stored in `config.json` as `id2label`).
 
 ## Training
 
-⟨Trainingskorpus (Umfang, Herkunft, Zeitraum), Annotationsverfahren, Anzahl Annotator:innen
-und Inter-Annotator-Übereinstimmung ergänzen.⟩
+⟨Training corpus (size, source, period), annotation procedure, number of annotators and
+inter-annotator agreement to be added.⟩
 
 ## Evaluation
 
-⟨Gütemaß (z. B. F1 pro Klasse und makro-gemittelt) auf zurückgehaltenem Testset ergänzen.⟩
-
-## Verwendung
+⟨Per-class and macro-averaged F1 on a held-out test set to be added.⟩
 
-Über das begleitende Python-Paket [`de-setting-classifier`](⟨GitHub-URL ergänzen⟩):
+## Usage
 
 ```python
-from de_setting_classifier import SpaceClassifier
+from transformers import AutoTokenizer, AutoModelForSequenceClassification
+import torch
+
+name = "katrohrb/de-setting-classifier"
+tok = AutoTokenizer.from_pretrained(name)
+model = AutoModelForSequenceClassification.from_pretrained(name).eval()
 
-clf = SpaceClassifier.from_pretrained("katrohrb/de-setting-classifier")
-clf.predict("Er trat durch die Tür und schloss sie hinter sich.")
-# → "action_space"
+sentence = "Er trat durch die Tür und schloss sie hinter sich."
+with torch.no_grad():
+    probs = model(**tok(sentence, return_tensors="pt")).logits.softmax(-1)[0]
+print(model.config.id2label[int(probs.argmax())])
+# → action_space
 ```
 
-Oder direkt über `transformers`:
+Or with a pipeline:
 
 ```python
-from transformers import AutoTokenizer, AutoModelForSequenceClassification
+from transformers import pipeline
 
-tok = AutoTokenizer.from_pretrained("katrohrb/de-setting-classifier")
-model = AutoModelForSequenceClassification.from_pretrained("katrohrb/de-setting-classifier")
+clf = pipeline("text-classification", model="katrohrb/de-setting-classifier")
+clf("Vom Hügel aus konnte sie das ganze Tal unter sich liegen sehen.")
+# → [{'label': 'visual_space', 'score': 0.93}]
 ```
 
-## Zitation
+## Citation
 
-⟨Bibliographische Angabe der zugrundeliegenden Studie ergänzen.⟩
+⟨Bibliographic reference for the underlying study to be added.⟩