larshubacher commited on
Commit
eceb6e5
1 Parent(s): 7ba7abb

Add SetFit model

Browse files
1_Pooling/config.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "word_embedding_dimension": 768,
3
+ "pooling_mode_cls_token": false,
4
+ "pooling_mode_mean_tokens": true,
5
+ "pooling_mode_max_tokens": false,
6
+ "pooling_mode_mean_sqrt_len_tokens": false,
7
+ "pooling_mode_weightedmean_tokens": false,
8
+ "pooling_mode_lasttoken": false,
9
+ "include_prompt": true
10
+ }
README.md ADDED
@@ -0,0 +1,198 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: sentence-transformers/paraphrase-mpnet-base-v2
3
+ library_name: setfit
4
+ metrics:
5
+ - accuracy
6
+ pipeline_tag: text-classification
7
+ tags:
8
+ - setfit
9
+ - sentence-transformers
10
+ - text-classification
11
+ - generated_from_setfit_trainer
12
+ widget:
13
+ - text: Immer alles super - top Preise & superschnelle Lieferung - bin schon seit
14
+ Jahren zufriedene Kundin von Digitec 😁👌🏼 …
15
+ - text: Ich bin bereits seit sehr vielen Jahren Kundin der UBS. Manchmal bin auch
16
+ ich mit der Geschäftspolitik der Bank nicht 100 % einverstanden. Absolut positiv
17
+ ist jedoch, dass man als Kunde ernst genommen und, wie ich meine, auch gut beraten
18
+ wird. Die Mitarbeitenden sind ausserordentlich freundlich und hilfsbereit, sowohl
19
+ vor Ort als auch bei allfälligen telefonischen Fragen.
20
+ - text: Gute Beratung, schnell und günstig.
21
+ - text: 'Toller Servis! 👌🏽
22
+
23
+ Ein paar bezahlbare Parkplätze gibts direkt vorne. …'
24
+ - text: Schnelle Abholung, schneller Service
25
+ inference: false
26
+ model-index:
27
+ - name: SetFit with sentence-transformers/paraphrase-mpnet-base-v2
28
+ results:
29
+ - task:
30
+ type: text-classification
31
+ name: Text Classification
32
+ dataset:
33
+ name: Unknown
34
+ type: unknown
35
+ split: test
36
+ metrics:
37
+ - type: accuracy
38
+ value: 0.06060606060606061
39
+ name: Accuracy
40
+ ---
41
+
42
+ # SetFit with sentence-transformers/paraphrase-mpnet-base-v2
43
+
44
+ This is a [SetFit](https://github.com/huggingface/setfit) model that can be used for Text Classification. This SetFit model uses [sentence-transformers/paraphrase-mpnet-base-v2](https://huggingface.co/sentence-transformers/paraphrase-mpnet-base-v2) as the Sentence Transformer embedding model. A OneVsRestClassifier instance is used for classification.
45
+
46
+ The model has been trained using an efficient few-shot learning technique that involves:
47
+
48
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
49
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
50
+
51
+ ## Model Details
52
+
53
+ ### Model Description
54
+ - **Model Type:** SetFit
55
+ - **Sentence Transformer body:** [sentence-transformers/paraphrase-mpnet-base-v2](https://huggingface.co/sentence-transformers/paraphrase-mpnet-base-v2)
56
+ - **Classification head:** a OneVsRestClassifier instance
57
+ - **Maximum Sequence Length:** 512 tokens
58
+ <!-- - **Number of Classes:** Unknown -->
59
+ <!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
60
+ <!-- - **Language:** Unknown -->
61
+ <!-- - **License:** Unknown -->
62
+
63
+ ### Model Sources
64
+
65
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
66
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
67
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
68
+
69
+ ## Evaluation
70
+
71
+ ### Metrics
72
+ | Label | Accuracy |
73
+ |:--------|:---------|
74
+ | **all** | 0.0606 |
75
+
76
+ ## Uses
77
+
78
+ ### Direct Use for Inference
79
+
80
+ First install the SetFit library:
81
+
82
+ ```bash
83
+ pip install setfit
84
+ ```
85
+
86
+ Then you can load this model and run inference.
87
+
88
+ ```python
89
+ from setfit import SetFitModel
90
+
91
+ # Download from the 🤗 Hub
92
+ model = SetFitModel.from_pretrained("larshubacher/setfit-paraphrase-mpnet-base-v2-ccbuzz")
93
+ # Run inference
94
+ preds = model("Gute Beratung, schnell und günstig.")
95
+ ```
96
+
97
+ <!--
98
+ ### Downstream Use
99
+
100
+ *List how someone could finetune this model on their own dataset.*
101
+ -->
102
+
103
+ <!--
104
+ ### Out-of-Scope Use
105
+
106
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
107
+ -->
108
+
109
+ <!--
110
+ ## Bias, Risks and Limitations
111
+
112
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
113
+ -->
114
+
115
+ <!--
116
+ ### Recommendations
117
+
118
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
119
+ -->
120
+
121
+ ## Training Details
122
+
123
+ ### Training Set Metrics
124
+ | Training set | Min | Median | Max |
125
+ |:-------------|:----|:--------|:----|
126
+ | Word count | 4 | 49.2344 | 266 |
127
+
128
+ ### Training Hyperparameters
129
+ - batch_size: (16, 16)
130
+ - num_epochs: (1, 1)
131
+ - max_steps: -1
132
+ - sampling_strategy: oversampling
133
+ - num_iterations: 20
134
+ - body_learning_rate: (2e-05, 2e-05)
135
+ - head_learning_rate: 2e-05
136
+ - loss: CosineSimilarityLoss
137
+ - distance_metric: cosine_distance
138
+ - margin: 0.25
139
+ - end_to_end: False
140
+ - use_amp: False
141
+ - warmup_proportion: 0.1
142
+ - seed: 42
143
+ - eval_max_steps: -1
144
+ - load_best_model_at_end: False
145
+
146
+ ### Training Results
147
+ | Epoch | Step | Training Loss | Validation Loss |
148
+ |:------:|:----:|:-------------:|:---------------:|
149
+ | 0.0031 | 1 | 0.2424 | - |
150
+ | 0.1562 | 50 | 0.2253 | - |
151
+ | 0.3125 | 100 | 0.1914 | - |
152
+ | 0.4688 | 150 | 0.0894 | - |
153
+ | 0.625 | 200 | 0.2011 | - |
154
+ | 0.7812 | 250 | 0.1924 | - |
155
+ | 0.9375 | 300 | 0.1516 | - |
156
+
157
+ ### Framework Versions
158
+ - Python: 3.10.12
159
+ - SetFit: 1.0.3
160
+ - Sentence Transformers: 3.0.1
161
+ - Transformers: 4.40.2
162
+ - PyTorch: 2.5.1+cu121
163
+ - Datasets: 2.21.0
164
+ - Tokenizers: 0.19.1
165
+
166
+ ## Citation
167
+
168
+ ### BibTeX
169
+ ```bibtex
170
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
171
+ doi = {10.48550/ARXIV.2209.11055},
172
+ url = {https://arxiv.org/abs/2209.11055},
173
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
174
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
175
+ title = {Efficient Few-Shot Learning Without Prompts},
176
+ publisher = {arXiv},
177
+ year = {2022},
178
+ copyright = {Creative Commons Attribution 4.0 International}
179
+ }
180
+ ```
181
+
182
+ <!--
183
+ ## Glossary
184
+
185
+ *Clearly define terms in order to be accessible across audiences.*
186
+ -->
187
+
188
+ <!--
189
+ ## Model Card Authors
190
+
191
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
192
+ -->
193
+
194
+ <!--
195
+ ## Model Card Contact
196
+
197
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
198
+ -->
config.json ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "sentence-transformers/paraphrase-mpnet-base-v2",
3
+ "architectures": [
4
+ "MPNetModel"
5
+ ],
6
+ "attention_probs_dropout_prob": 0.1,
7
+ "bos_token_id": 0,
8
+ "eos_token_id": 2,
9
+ "hidden_act": "gelu",
10
+ "hidden_dropout_prob": 0.1,
11
+ "hidden_size": 768,
12
+ "initializer_range": 0.02,
13
+ "intermediate_size": 3072,
14
+ "layer_norm_eps": 1e-05,
15
+ "max_position_embeddings": 514,
16
+ "model_type": "mpnet",
17
+ "num_attention_heads": 12,
18
+ "num_hidden_layers": 12,
19
+ "pad_token_id": 1,
20
+ "relative_attention_num_buckets": 32,
21
+ "torch_dtype": "float32",
22
+ "transformers_version": "4.40.2",
23
+ "vocab_size": 30527
24
+ }
config_sentence_transformers.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "sentence_transformers": "3.0.1",
4
+ "transformers": "4.40.2",
5
+ "pytorch": "2.5.1+cu121"
6
+ },
7
+ "prompts": {},
8
+ "default_prompt_name": null,
9
+ "similarity_fn_name": null
10
+ }
config_setfit.json ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ {
2
+ "labels": null,
3
+ "normalize_embeddings": false
4
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:8d1adcc3396329ff09ad1a6f4d318bd15476486b96a011afc26ec3877a0ffed4
3
+ size 437967672
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:512040fceec2d39e428505981349696b603f29a18f7fb35e1ff6753079c2a87f
3
+ size 104692
modules.json ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ [
2
+ {
3
+ "idx": 0,
4
+ "name": "0",
5
+ "path": "",
6
+ "type": "sentence_transformers.models.Transformer"
7
+ },
8
+ {
9
+ "idx": 1,
10
+ "name": "1",
11
+ "path": "1_Pooling",
12
+ "type": "sentence_transformers.models.Pooling"
13
+ }
14
+ ]
sentence_bert_config.json ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ {
2
+ "max_seq_length": 512,
3
+ "do_lower_case": false
4
+ }
special_tokens_map.json ADDED
@@ -0,0 +1,51 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "bos_token": {
3
+ "content": "<s>",
4
+ "lstrip": false,
5
+ "normalized": false,
6
+ "rstrip": false,
7
+ "single_word": false
8
+ },
9
+ "cls_token": {
10
+ "content": "<s>",
11
+ "lstrip": false,
12
+ "normalized": false,
13
+ "rstrip": false,
14
+ "single_word": false
15
+ },
16
+ "eos_token": {
17
+ "content": "</s>",
18
+ "lstrip": false,
19
+ "normalized": false,
20
+ "rstrip": false,
21
+ "single_word": false
22
+ },
23
+ "mask_token": {
24
+ "content": "<mask>",
25
+ "lstrip": true,
26
+ "normalized": false,
27
+ "rstrip": false,
28
+ "single_word": false
29
+ },
30
+ "pad_token": {
31
+ "content": "<pad>",
32
+ "lstrip": false,
33
+ "normalized": false,
34
+ "rstrip": false,
35
+ "single_word": false
36
+ },
37
+ "sep_token": {
38
+ "content": "</s>",
39
+ "lstrip": false,
40
+ "normalized": false,
41
+ "rstrip": false,
42
+ "single_word": false
43
+ },
44
+ "unk_token": {
45
+ "content": "[UNK]",
46
+ "lstrip": false,
47
+ "normalized": false,
48
+ "rstrip": false,
49
+ "single_word": false
50
+ }
51
+ }
tokenizer.json ADDED
The diff for this file is too large to render. See raw diff
 
tokenizer_config.json ADDED
@@ -0,0 +1,59 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "added_tokens_decoder": {
3
+ "0": {
4
+ "content": "<s>",
5
+ "lstrip": false,
6
+ "normalized": false,
7
+ "rstrip": false,
8
+ "single_word": false,
9
+ "special": true
10
+ },
11
+ "1": {
12
+ "content": "<pad>",
13
+ "lstrip": false,
14
+ "normalized": false,
15
+ "rstrip": false,
16
+ "single_word": false,
17
+ "special": true
18
+ },
19
+ "2": {
20
+ "content": "</s>",
21
+ "lstrip": false,
22
+ "normalized": false,
23
+ "rstrip": false,
24
+ "single_word": false,
25
+ "special": true
26
+ },
27
+ "104": {
28
+ "content": "[UNK]",
29
+ "lstrip": false,
30
+ "normalized": false,
31
+ "rstrip": false,
32
+ "single_word": false,
33
+ "special": true
34
+ },
35
+ "30526": {
36
+ "content": "<mask>",
37
+ "lstrip": true,
38
+ "normalized": false,
39
+ "rstrip": false,
40
+ "single_word": false,
41
+ "special": true
42
+ }
43
+ },
44
+ "bos_token": "<s>",
45
+ "clean_up_tokenization_spaces": true,
46
+ "cls_token": "<s>",
47
+ "do_basic_tokenize": true,
48
+ "do_lower_case": true,
49
+ "eos_token": "</s>",
50
+ "mask_token": "<mask>",
51
+ "model_max_length": 512,
52
+ "never_split": null,
53
+ "pad_token": "<pad>",
54
+ "sep_token": "</s>",
55
+ "strip_accents": null,
56
+ "tokenize_chinese_chars": true,
57
+ "tokenizer_class": "MPNetTokenizer",
58
+ "unk_token": "[UNK]"
59
+ }
vocab.txt ADDED
The diff for this file is too large to render. See raw diff