Update README.md

README.md

@@ -4,6 +4,7 @@ license: mit
 base_model: deepset/gbert-large
 tags:
 - generated_from_trainer
+- german
 metrics:
 - accuracy
 - f1
@@ -12,6 +13,11 @@ metrics:
 model-index:
 - name: german-zeroshot
   results: []
+datasets:
+- facebook/xnli
+language:
+- de
+pipeline_tag: zero-shot-classification
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -26,6 +32,50 @@ It achieves the following results on the evaluation set:
 - F1: 0.8487
 - Precision: 0.8505
 - Recall: 0.8486
+- 
+## Usage
+
+```python
+# Use a pipeline as a high-level helper
+
+pipe = pipeline(
+    "zero-shot-classification",
+    model="kaixkhazaki/german-zeroshot",
+    tokenizer="kaixkhazaki/german-zeroshot",
+    device=0 if torch.cuda.is_available() else -1  # Use GPU if available
+)
+
+#Enter your text and possible candidates of classification
+sequence = "Können Sie mir die Schritte zur Konfiguration eines VPN auf einem Linux-Server erklären?"
+candidate_labels = [
+    "Technische Dokumentation", 
+    "IT-Support", 
+    "Netzwerkadministration", 
+    "Linux-Konfiguration", 
+    "VPN-Setup"
+]
+pipe(sequence,candidate_labels)
+>>
+{'sequence': 'Können Sie mir die Schritte zur Konfiguration eines VPN auf einem Linux-Server erklären?',
+'labels': ['VPN-Setup', 'Linux-Konfiguration', 'Netzwerkadministration', 'IT-Support', 'Technische Dokumentation'],
+'scores': [0.3245040476322174, 0.32373329997062683, 0.16423103213310242, 0.09850211441516876, 0.08902951329946518]}
+
+#example 2
+sequence = "Können Sie mir die Schritte zur Konfiguration eines VPN auf einem Linux-Server erklären?"
+candidate_labels = [
+    "Technische Dokumentation", 
+    "IT-Support", 
+    "Netzwerkadministration", 
+    "Linux-Konfiguration", 
+    "VPN-Setup"
+]
+pipe(sequence,candidate_labels)
+>>
+{'sequence': 'Wie lautet die Garantiezeit für dieses Produkt?',
+'labels': ['Garantiebedingungen', 'Produktdetails', 'Reklamation', 'Kundendienst', 'Kaufberatung'],
+'scores': [0.4313304126262665, 0.2905466556549072, 0.10058070719242096, 0.09384352713823318, 0.08369863778352737]}
+
+```
 
 ## Model description
 
@@ -82,4 +132,4 @@ The following hyperparameters were used during training:
 - Transformers 4.48.0.dev0
 - Pytorch 2.4.1+cu121
 - Datasets 3.1.0
-- Tokenizers 0.21.0
+- Tokenizers 0.21.0