HelgeKn commited on
Commit
ddd3d2f
1 Parent(s): 8302ffd

Add SetFit model

Browse files
1_Pooling/config.json ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
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
+ }
README.md ADDED
@@ -0,0 +1,219 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ library_name: setfit
3
+ tags:
4
+ - setfit
5
+ - sentence-transformers
6
+ - text-classification
7
+ - generated_from_setfit_trainer
8
+ metrics:
9
+ - accuracy
10
+ widget:
11
+ - text: Someone comes out of the shack and shoves one of the kids to the ground. He
12
+ - text: He approaches the object and reads a plaque on its side. Someone
13
+ - text: Later at someone's family farm, someone sees the lights on in the hangar.
14
+ Someone
15
+ - text: Someone stands looking over some of the old photographs as someone goes through
16
+ the mess on the desk. Someone
17
+ - text: Snow blows around a city of towering crystalline structures. A warrior
18
+ pipeline_tag: text-classification
19
+ inference: true
20
+ base_model: sentence-transformers/paraphrase-mpnet-base-v2
21
+ model-index:
22
+ - name: SetFit with sentence-transformers/paraphrase-mpnet-base-v2
23
+ results:
24
+ - task:
25
+ type: text-classification
26
+ name: Text Classification
27
+ dataset:
28
+ name: Unknown
29
+ type: unknown
30
+ split: test
31
+ metrics:
32
+ - type: accuracy
33
+ value: 0.16557377049180327
34
+ name: Accuracy
35
+ ---
36
+
37
+ # SetFit with sentence-transformers/paraphrase-mpnet-base-v2
38
+
39
+ 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 [SetFitHead](huggingface.co/docs/setfit/reference/main#setfit.SetFitHead) instance is used for classification.
40
+
41
+ The model has been trained using an efficient few-shot learning technique that involves:
42
+
43
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
44
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
45
+
46
+ ## Model Details
47
+
48
+ ### Model Description
49
+ - **Model Type:** SetFit
50
+ - **Sentence Transformer body:** [sentence-transformers/paraphrase-mpnet-base-v2](https://huggingface.co/sentence-transformers/paraphrase-mpnet-base-v2)
51
+ - **Classification head:** a [SetFitHead](huggingface.co/docs/setfit/reference/main#setfit.SetFitHead) instance
52
+ - **Maximum Sequence Length:** 512 tokens
53
+ - **Number of Classes:** 9 classes
54
+ <!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
55
+ <!-- - **Language:** Unknown -->
56
+ <!-- - **License:** Unknown -->
57
+
58
+ ### Model Sources
59
+
60
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
61
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
62
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
63
+
64
+ ### Model Labels
65
+ | Label | Examples |
66
+ |:------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
67
+ | 6 | <ul><li>'The man claps his hands together. The man'</li><li>'Emerging in open water, he does a breaststroke toward the murky. He'</li><li>'The girl does 2 perfect flips. The girls'</li></ul> |
68
+ | 3 | <ul><li>'The younger insurance rep solemnly faces his partner. The older man'</li><li>'He grabs her hair and pulls her head back. She'</li><li>'A kid in blue shorts is vacuuming the floor. A kid in a red shirt'</li></ul> |
69
+ | 2 | <ul><li>'In slow motion, both the Russians and Americans celebrate. Someone'</li><li>'Through a window, we watch someone raise his teacup to his companions. At home, someone'</li><li>'As our view retracts through the star map a holographic line sets out from the gunner chair and targets hologram of the planet earth. She'</li></ul> |
70
+ | 4 | <ul><li>"The waiter refills someone's glass. Someone"</li><li>"He finds someone's records in a box. Someone"</li><li>"Bloodstains spread over someone's white shirt. Someone"</li></ul> |
71
+ | 7 | <ul><li>'Now, someone stands below an overcast sky. Strands of his greasy black hair'</li><li>'Someone turns at the sound of the distant horns. 6000 horsemen, lead by people,'</li><li>'Someone points his wand upwards. High above, red sparks'</li></ul> |
72
+ | 5 | <ul><li>'Now in the eating quarters, someone faces a husky, larged - nosed cook. The cook'</li><li>'A logo for a sports even is shown. There'</li><li>'Someone stirs the cookie dough in a bowl. The dough'</li></ul> |
73
+ | 0 | <ul><li>'He shows a water bottle he has along with a brush, and uses the brush to remove snow from the dash window of a car and the water to remove any excess snow left on the windshield. Once finished, he'</li><li>"Someone and someone step into a tent. Someone's mouth"</li><li>'Someone steps outside and opens an umbrella. Someone halts,'</li></ul> |
74
+ | 8 | <ul><li>'Someone peers out from the cabin. As she emerges, someone'</li><li>'He gently tries to pull up and then reel the fishing line out of the hole. He'</li><li>'A woman smiles at the camera. The woman'</li></ul> |
75
+ | 1 | <ul><li>'We see a title screen. We'</li><li>'A lot of people are sitting on terraces in a big field and people is walking in the entrance of a big stadium. men'</li><li>'We see the finished painting and a line of paints. We then'</li></ul> |
76
+
77
+ ## Evaluation
78
+
79
+ ### Metrics
80
+ | Label | Accuracy |
81
+ |:--------|:---------|
82
+ | **all** | 0.1656 |
83
+
84
+ ## Uses
85
+
86
+ ### Direct Use for Inference
87
+
88
+ First install the SetFit library:
89
+
90
+ ```bash
91
+ pip install setfit
92
+ ```
93
+
94
+ Then you can load this model and run inference.
95
+
96
+ ```python
97
+ from setfit import SetFitModel
98
+
99
+ # Download from the 🤗 Hub
100
+ model = SetFitModel.from_pretrained("HelgeKn/Swag-multi-class-8")
101
+ # Run inference
102
+ preds = model("He approaches the object and reads a plaque on its side. Someone")
103
+ ```
104
+
105
+ <!--
106
+ ### Downstream Use
107
+
108
+ *List how someone could finetune this model on their own dataset.*
109
+ -->
110
+
111
+ <!--
112
+ ### Out-of-Scope Use
113
+
114
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
115
+ -->
116
+
117
+ <!--
118
+ ## Bias, Risks and Limitations
119
+
120
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
121
+ -->
122
+
123
+ <!--
124
+ ### Recommendations
125
+
126
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
127
+ -->
128
+
129
+ ## Training Details
130
+
131
+ ### Training Set Metrics
132
+ | Training set | Min | Median | Max |
133
+ |:-------------|:----|:--------|:----|
134
+ | Word count | 6 | 14.0833 | 40 |
135
+
136
+ | Label | Training Sample Count |
137
+ |:------|:----------------------|
138
+ | 0 | 8 |
139
+ | 1 | 8 |
140
+ | 2 | 8 |
141
+ | 3 | 8 |
142
+ | 4 | 8 |
143
+ | 5 | 8 |
144
+ | 6 | 8 |
145
+ | 7 | 8 |
146
+ | 8 | 8 |
147
+
148
+ ### Training Hyperparameters
149
+ - batch_size: (16, 16)
150
+ - num_epochs: (2, 2)
151
+ - max_steps: -1
152
+ - sampling_strategy: oversampling
153
+ - num_iterations: 20
154
+ - body_learning_rate: (2e-05, 2e-05)
155
+ - head_learning_rate: 2e-05
156
+ - loss: CosineSimilarityLoss
157
+ - distance_metric: cosine_distance
158
+ - margin: 0.25
159
+ - end_to_end: False
160
+ - use_amp: False
161
+ - warmup_proportion: 0.1
162
+ - seed: 42
163
+ - eval_max_steps: -1
164
+ - load_best_model_at_end: False
165
+
166
+ ### Training Results
167
+ | Epoch | Step | Training Loss | Validation Loss |
168
+ |:------:|:----:|:-------------:|:---------------:|
169
+ | 0.0056 | 1 | 0.2013 | - |
170
+ | 0.2778 | 50 | 0.1955 | - |
171
+ | 0.5556 | 100 | 0.0693 | - |
172
+ | 0.8333 | 150 | 0.0166 | - |
173
+ | 1.1111 | 200 | 0.0369 | - |
174
+ | 1.3889 | 250 | 0.0149 | - |
175
+ | 1.6667 | 300 | 0.0095 | - |
176
+ | 1.9444 | 350 | 0.0238 | - |
177
+
178
+ ### Framework Versions
179
+ - Python: 3.9.13
180
+ - SetFit: 1.0.1
181
+ - Sentence Transformers: 2.2.2
182
+ - Transformers: 4.36.0
183
+ - PyTorch: 2.1.1+cpu
184
+ - Datasets: 2.15.0
185
+ - Tokenizers: 0.15.0
186
+
187
+ ## Citation
188
+
189
+ ### BibTeX
190
+ ```bibtex
191
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
192
+ doi = {10.48550/ARXIV.2209.11055},
193
+ url = {https://arxiv.org/abs/2209.11055},
194
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
195
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
196
+ title = {Efficient Few-Shot Learning Without Prompts},
197
+ publisher = {arXiv},
198
+ year = {2022},
199
+ copyright = {Creative Commons Attribution 4.0 International}
200
+ }
201
+ ```
202
+
203
+ <!--
204
+ ## Glossary
205
+
206
+ *Clearly define terms in order to be accessible across audiences.*
207
+ -->
208
+
209
+ <!--
210
+ ## Model Card Authors
211
+
212
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
213
+ -->
214
+
215
+ <!--
216
+ ## Model Card Contact
217
+
218
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
219
+ -->
config.json ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "C:\\Users\\Man_f/.cache\\torch\\sentence_transformers\\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.36.0",
23
+ "vocab_size": 30527
24
+ }
config_sentence_transformers.json ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "sentence_transformers": "2.0.0",
4
+ "transformers": "4.7.0",
5
+ "pytorch": "1.9.0+cu102"
6
+ }
7
+ }
config_setfit.json ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ {
2
+ "normalize_embeddings": false,
3
+ "labels": null
4
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:cc7287d62faf553bdf8bedf59124354ea8328bfbcc40968cc297c32f465c672a
3
+ size 437967672
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:757e52ac05fdad93cc9a4a0103ddb315a6fa5d2c70972beafd82e56cb2b847bf
3
+ size 29204
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": true,
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": true,
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