HelgeKn commited on
Commit
72ee7c2
1 Parent(s): 5a3062b

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,207 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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: 'The Vitorian team knew to make up for the significant absences of Herrmann
12
+ , Oleson , Huertas and Micov with a big dose of involvement and teamwork , even
13
+ though it had to hold out until the end to take the victory . '
14
+ - text: '`` But why pay her bills ? '
15
+ - text: 'In the body , pemetrexed is converted into an active form that blocks the
16
+ activity of the enzymes that are involved in producing nucleotides ( the building
17
+ blocks of DNA and RNA , the genetic material of cells ) . '
18
+ - text: '`` The daily crush of media tweets , cameras and reporters outside the courthouse
19
+ , '''' the lawyers wrote , `` was unlike anything ever seen here in New Haven
20
+ and maybe statewide . '''' '
21
+ - text: 'However , in both studies , patients whose cancer was not affecting squamous
22
+ cells had longer survival times if they received Alimta than if they received
23
+ the comparator . '
24
+ pipeline_tag: text-classification
25
+ inference: true
26
+ base_model: sentence-transformers/paraphrase-mpnet-base-v2
27
+ ---
28
+
29
+ # SetFit with sentence-transformers/paraphrase-mpnet-base-v2
30
+
31
+ 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.
32
+
33
+ The model has been trained using an efficient few-shot learning technique that involves:
34
+
35
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
36
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
37
+
38
+ ## Model Details
39
+
40
+ ### Model Description
41
+ - **Model Type:** SetFit
42
+ - **Sentence Transformer body:** [sentence-transformers/paraphrase-mpnet-base-v2](https://huggingface.co/sentence-transformers/paraphrase-mpnet-base-v2)
43
+ - **Classification head:** a [SetFitHead](huggingface.co/docs/setfit/reference/main#setfit.SetFitHead) instance
44
+ - **Maximum Sequence Length:** 512 tokens
45
+ - **Number of Classes:** 7 classes
46
+ <!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
47
+ <!-- - **Language:** Unknown -->
48
+ <!-- - **License:** Unknown -->
49
+
50
+ ### Model Sources
51
+
52
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
53
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
54
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
55
+
56
+ ### Model Labels
57
+ | Label | Examples |
58
+ |:------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
59
+ | 6 | <ul><li>'If you were especially helpful in a corrupt scheme you received not just cash in a bag , but equity . '</li><li>'Two American companies reached deals for fields auctioned in June . '</li><li>'Let me prove it , Phil . '</li></ul> |
60
+ | 2 | <ul><li>'This building shook like hell and it kept getting stronger . '</li><li>'Now you could ask me , why should the user mind about MathML ? '</li><li>'The report and a casebook of initiatives will be published in 1996 and provide the backdrop for a conference to be staged in Autumn , 1996 . '</li></ul> |
61
+ | 3 | <ul><li>'The tumor , he suggested , developed when the second , normal copy also was damaged . '</li><li>'Proper English bells are started off in `` rounds , `` from the highest-pitched bell to the lowest -- a simple descending scale using , in larger churches , as many as 12 bells . '</li><li>'Treatment should be delayed or discontinued , or the dose reduced , in patients whose blood counts are abnormal or who have certain other side effects . '</li></ul> |
62
+ | 5 | <ul><li>'Schools that are structured in this way produce students with higher morale and superior academic performance . '</li><li>'I got home , let the dogs into the house and noticed some sounds above my head , as if someone were walking on the roof , or upstairs . '</li><li>'Give me your address . '</li></ul> |
63
+ | 0 | <ul><li>'-- Most important of all , schools should have principals with a large measure of authority over the faculty , the curriculum , and all matters of student discipline . '</li><li>'For months the Johns Hopkins researchers , using gene probes , experimentally crawled down the length of chromosome 17 , looking for the smallest common bit of genetic material lost in all tumor cells . '</li><li>'It explains how the Committee for Medicinal Products for Human Use ( CHMP ) assessed the studies performed , to reach their recommendations on how to use the medicine . '</li></ul> |
64
+ | 4 | <ul><li>'In 2005 , the fear of invasion of the national territory by hordes of Polish plumbers was felt both on the Left and on the Right . '</li><li>'Cerenia contains the active substance maropitant and is available as tablet or as solution for injection . '</li><li>'The second quarter was more of the same , but the Alavan team opted for the inside game of Barac and the work of Eliyahu , who was greeted with whistles and applause at his return home , to continue increasing their lead by half-time ( 34-43 ) . '</li></ul> |
65
+ | 1 | <ul><li>'`` The sound of bells is a net to draw people into the church , `` he says . '</li><li>'`` Progressive education `` ( as it was once called ) is far more interesting and agreeable to teachers than is disciplined instruction . '</li><li>"The defense lawyers also claim , for example , that Mr. Hayes may have been prejudiced when Judge Blue declined to allow them to test potential jurors ' reactions by showing them grisly crime-scene photographs during jury selection . "</li></ul> |
66
+
67
+ ## Uses
68
+
69
+ ### Direct Use for Inference
70
+
71
+ First install the SetFit library:
72
+
73
+ ```bash
74
+ pip install setfit
75
+ ```
76
+
77
+ Then you can load this model and run inference.
78
+
79
+ ```python
80
+ from setfit import SetFitModel
81
+
82
+ # Download from the 🤗 Hub
83
+ model = SetFitModel.from_pretrained("HelgeKn/SemEval-multi-class-v1-10")
84
+ # Run inference
85
+ preds = model("`` But why pay her bills ? ")
86
+ ```
87
+
88
+ <!--
89
+ ### Downstream Use
90
+
91
+ *List how someone could finetune this model on their own dataset.*
92
+ -->
93
+
94
+ <!--
95
+ ### Out-of-Scope Use
96
+
97
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
98
+ -->
99
+
100
+ <!--
101
+ ## Bias, Risks and Limitations
102
+
103
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
104
+ -->
105
+
106
+ <!--
107
+ ### Recommendations
108
+
109
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
110
+ -->
111
+
112
+ ## Training Details
113
+
114
+ ### Training Set Metrics
115
+ | Training set | Min | Median | Max |
116
+ |:-------------|:----|:--------|:----|
117
+ | Word count | 5 | 25.8286 | 75 |
118
+
119
+ | Label | Training Sample Count |
120
+ |:------|:----------------------|
121
+ | 0 | 10 |
122
+ | 1 | 10 |
123
+ | 2 | 10 |
124
+ | 3 | 10 |
125
+ | 4 | 10 |
126
+ | 5 | 10 |
127
+ | 6 | 10 |
128
+
129
+ ### Training Hyperparameters
130
+ - batch_size: (16, 16)
131
+ - num_epochs: (4, 4)
132
+ - max_steps: -1
133
+ - sampling_strategy: oversampling
134
+ - num_iterations: 20
135
+ - body_learning_rate: (2e-05, 2e-05)
136
+ - head_learning_rate: 2e-05
137
+ - loss: CosineSimilarityLoss
138
+ - distance_metric: cosine_distance
139
+ - margin: 0.25
140
+ - end_to_end: False
141
+ - use_amp: False
142
+ - warmup_proportion: 0.1
143
+ - seed: 42
144
+ - eval_max_steps: -1
145
+ - load_best_model_at_end: False
146
+
147
+ ### Training Results
148
+ | Epoch | Step | Training Loss | Validation Loss |
149
+ |:------:|:----:|:-------------:|:---------------:|
150
+ | 0.0057 | 1 | 0.2314 | - |
151
+ | 0.2857 | 50 | 0.218 | - |
152
+ | 0.5714 | 100 | 0.1161 | - |
153
+ | 0.8571 | 150 | 0.0559 | - |
154
+ | 1.1429 | 200 | 0.0087 | - |
155
+ | 1.4286 | 250 | 0.0029 | - |
156
+ | 1.7143 | 300 | 0.001 | - |
157
+ | 2.0 | 350 | 0.0006 | - |
158
+ | 2.2857 | 400 | 0.0011 | - |
159
+ | 2.5714 | 450 | 0.0009 | - |
160
+ | 2.8571 | 500 | 0.0005 | - |
161
+ | 3.1429 | 550 | 0.0006 | - |
162
+ | 3.4286 | 600 | 0.0004 | - |
163
+ | 3.7143 | 650 | 0.0003 | - |
164
+ | 4.0 | 700 | 0.0005 | - |
165
+
166
+ ### Framework Versions
167
+ - Python: 3.9.13
168
+ - SetFit: 1.0.1
169
+ - Sentence Transformers: 2.2.2
170
+ - Transformers: 4.36.0
171
+ - PyTorch: 2.1.1+cpu
172
+ - Datasets: 2.15.0
173
+ - Tokenizers: 0.15.0
174
+
175
+ ## Citation
176
+
177
+ ### BibTeX
178
+ ```bibtex
179
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
180
+ doi = {10.48550/ARXIV.2209.11055},
181
+ url = {https://arxiv.org/abs/2209.11055},
182
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
183
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
184
+ title = {Efficient Few-Shot Learning Without Prompts},
185
+ publisher = {arXiv},
186
+ year = {2022},
187
+ copyright = {Creative Commons Attribution 4.0 International}
188
+ }
189
+ ```
190
+
191
+ <!--
192
+ ## Glossary
193
+
194
+ *Clearly define terms in order to be accessible across audiences.*
195
+ -->
196
+
197
+ <!--
198
+ ## Model Card Authors
199
+
200
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
201
+ -->
202
+
203
+ <!--
204
+ ## Model Card Contact
205
+
206
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
207
+ -->
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
+ "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:bc239324b6cf90cf851faf956fb02120b3397dfe974e2970f4143cfcfb0ad235
3
+ size 437967672
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:7f52ac70f7477c9d5e66f726f925ea9be069de744c08c3e661eda1b631abb1dd
3
+ size 23052
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