Dehnes commited on
Commit
86e8164
1 Parent(s): 898c4a2

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +12 -4
README.md CHANGED
@@ -25,6 +25,7 @@ widget:
25
 
26
  ---
27
 
 
28
  # SVALabs - Gbert Large Zeroshot Nli
29
 
30
  In this repository, we present our german zeroshot model.
@@ -50,7 +51,7 @@ We evaluated our model for the nli task using the TEST set of the German part of
50
  XNLI TEST-Set Accuracy: 86%
51
 
52
 
53
- ## Zeroshot Text Classification Task Benchmark
54
 
55
  We further tested our model for a zeroshot text classification task using a part of the [10kGNAD Dataset](https://tblock.github.io/10kGNAD/).
56
  Specifically, we used all articles that were labeled "Kultur", "Sport", "Web", "Wirtschaft" und "Wissenschaft".
@@ -65,10 +66,17 @@ The next table shows the results as well as a comparison with other German langu
65
  | deepset/gbert-base | 0.65 |
66
 
67
 
68
- ## How to use
 
 
 
 
69
 
70
- The simplest way to use the model is the hugging-face transformers pipeline tool.
71
- Just initialize the pipeline specifying the task as "zero-shot-classification"
 
 
 
72
 
73
  ```python
74
 
 
25
 
26
  ---
27
 
28
+
29
  # SVALabs - Gbert Large Zeroshot Nli
30
 
31
  In this repository, we present our german zeroshot model.
 
51
  XNLI TEST-Set Accuracy: 86%
52
 
53
 
54
+ ### Zeroshot Text Classification Task Benchmark
55
 
56
  We further tested our model for a zeroshot text classification task using a part of the [10kGNAD Dataset](https://tblock.github.io/10kGNAD/).
57
  Specifically, we used all articles that were labeled "Kultur", "Sport", "Web", "Wirtschaft" und "Wissenschaft".
 
66
  | deepset/gbert-base | 0.65 |
67
 
68
 
69
+ ### How to use
70
+
71
+ The simplest way to use the model is the huggingface transformers pipeline tool.
72
+ Just initialize the pipeline specifying the task as "zero-shot-classification",
73
+ and select "svalabs/gbert-large-zeroshot-nli" as model.
74
 
75
+ The model requires you to specify labels (ideally labels suited to your task),
76
+ a sequence (or list of sequences) to classify and a hypothesis template.
77
+ In our tests, if the labels comprise only single words,
78
+ "In diesem Satz geht es um das Thema {}" performed the best.
79
+
80
 
81
  ```python
82