vipinbansal179 commited on
Commit
6b599de
1 Parent(s): 87964b7

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,232 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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: receive upi mandate collect request marg techno project private limit inr
12
+ 15000.00. log google pay app authorize - axis bank
13
+ - text: 'sep-23 statement credit card x6343 total due : inr 5575.55 min due : inr
14
+ 4811.55 due date : 08-oct-23 . pay www.kotak.com/rd/ccpymt - kotak bank'
15
+ - text: '< # > use otp : 8233 login turtlemintpro zck+rfoaqnm'
16
+ - text: 'arrive today : please use otp-550041 carefully read instructions secure amazon
17
+ package ( id : sptp719784310 )'
18
+ - text: a/c xxx51941 credit rs 132.00 12-08-2023 - fd1186130010001148int:132.00 tax:0.00.
19
+ a/c balance rs 67022.91 .please call 18002082121 query . ujjivan sfb
20
+ pipeline_tag: text-classification
21
+ inference: true
22
+ base_model: sentence-transformers/all-mpnet-base-v2
23
+ model-index:
24
+ - name: SetFit with sentence-transformers/all-mpnet-base-v2
25
+ results:
26
+ - task:
27
+ type: text-classification
28
+ name: Text Classification
29
+ dataset:
30
+ name: Unknown
31
+ type: unknown
32
+ split: test
33
+ metrics:
34
+ - type: accuracy
35
+ value: 0.9722222222222222
36
+ name: Accuracy
37
+ ---
38
+
39
+ # SetFit with sentence-transformers/all-mpnet-base-v2
40
+
41
+ This is a [SetFit](https://github.com/huggingface/setfit) model that can be used for Text Classification. This SetFit model uses [sentence-transformers/all-mpnet-base-v2](https://huggingface.co/sentence-transformers/all-mpnet-base-v2) as the Sentence Transformer embedding model. A [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance is used for classification.
42
+
43
+ The model has been trained using an efficient few-shot learning technique that involves:
44
+
45
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
46
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
47
+
48
+ ## Model Details
49
+
50
+ ### Model Description
51
+ - **Model Type:** SetFit
52
+ - **Sentence Transformer body:** [sentence-transformers/all-mpnet-base-v2](https://huggingface.co/sentence-transformers/all-mpnet-base-v2)
53
+ - **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
54
+ - **Maximum Sequence Length:** 384 tokens
55
+ - **Number of Classes:** 3 classes
56
+ <!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
57
+ <!-- - **Language:** Unknown -->
58
+ <!-- - **License:** Unknown -->
59
+
60
+ ### Model Sources
61
+
62
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
63
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
64
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
65
+
66
+ ### Model Labels
67
+ | Label | Examples |
68
+ |:------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
69
+ | 2 | <ul><li>'validity airtel xstream fiber id 20001896982 expire 04-sep-23 . please recharge rs 589 enjoy uninterrupted service . recharge , click www.airtel.in/5/c_summary ? n=021710937343_dsl . please ignore already pay .'</li><li>'initiate process add a/c . xxxx59 upi app - axis bank'</li><li>'google-pay registration initiate icici bank . do , report bank . card details/otp/cvv secret . disclose anyone .'</li></ul> |
70
+ | 0 | <ul><li>'rs 260.00 debit a/c xxxxxx7783 credit krjngm @ oksbi upi ref:325154274303. ? call 18005700 -bob'</li><li>'send rs.400.00 kotak bank ac x4524 7800600122 @ ybl 15-10-23.upi ref 328855774953. , kotak.com/fraud'</li><li>'send rs.400.00 kotak bank ac x4524 7800600122 @ ybl 15-10-23.upi ref 328855774953. , kotak.com/fraud'</li></ul> |
71
+ | 1 | <ul><li>'dear bob upi user , account credit inr 50.00 date 2023-08-27 11:41:09 upi ref 360562629741 - bob'</li><li>'receive rs.10000.00 kotak bank ac x4524 mahimagyamlani08 @ okaxis 21-08-23.bal:197,838.14.upi ref:323334598750'</li><li>'update ! inr5.66 credit federal bank account xxxx9374 jupiter app . happy bank !'</li></ul> |
72
+
73
+ ## Evaluation
74
+
75
+ ### Metrics
76
+ | Label | Accuracy |
77
+ |:--------|:---------|
78
+ | **all** | 0.9722 |
79
+
80
+ ## Uses
81
+
82
+ ### Direct Use for Inference
83
+
84
+ First install the SetFit library:
85
+
86
+ ```bash
87
+ pip install setfit
88
+ ```
89
+
90
+ Then you can load this model and run inference.
91
+
92
+ ```python
93
+ from setfit import SetFitModel
94
+
95
+ # Download from the 🤗 Hub
96
+ model = SetFitModel.from_pretrained("vipinbansal179/SetFit_sms_Analyzer5c95292")
97
+ # Run inference
98
+ preds = model("< # > use otp : 8233 login turtlemintpro zck+rfoaqnm")
99
+ ```
100
+
101
+ <!--
102
+ ### Downstream Use
103
+
104
+ *List how someone could finetune this model on their own dataset.*
105
+ -->
106
+
107
+ <!--
108
+ ### Out-of-Scope Use
109
+
110
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
111
+ -->
112
+
113
+ <!--
114
+ ## Bias, Risks and Limitations
115
+
116
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
117
+ -->
118
+
119
+ <!--
120
+ ### Recommendations
121
+
122
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
123
+ -->
124
+
125
+ ## Training Details
126
+
127
+ ### Training Set Metrics
128
+ | Training set | Min | Median | Max |
129
+ |:-------------|:----|:--------|:----|
130
+ | Word count | 5 | 20.5357 | 35 |
131
+
132
+ | Label | Training Sample Count |
133
+ |:------|:----------------------|
134
+ | 0 | 31 |
135
+ | 1 | 28 |
136
+ | 2 | 81 |
137
+
138
+ ### Training Hyperparameters
139
+ - batch_size: (16, 16)
140
+ - num_epochs: (2, 2)
141
+ - max_steps: -1
142
+ - sampling_strategy: oversampling
143
+ - body_learning_rate: (2e-05, 1e-05)
144
+ - head_learning_rate: 0.01
145
+ - loss: CosineSimilarityLoss
146
+ - distance_metric: cosine_distance
147
+ - margin: 0.25
148
+ - end_to_end: False
149
+ - use_amp: False
150
+ - warmup_proportion: 0.1
151
+ - seed: 42
152
+ - eval_max_steps: -1
153
+ - load_best_model_at_end: True
154
+
155
+ ### Training Results
156
+ | Epoch | Step | Training Loss | Validation Loss |
157
+ |:-------:|:-------:|:-------------:|:---------------:|
158
+ | 0.0014 | 1 | 0.2939 | - |
159
+ | 0.0708 | 50 | 0.1406 | - |
160
+ | 0.1416 | 100 | 0.0304 | - |
161
+ | 0.2125 | 150 | 0.0078 | - |
162
+ | 0.2833 | 200 | 0.0019 | - |
163
+ | 0.3541 | 250 | 0.0001 | - |
164
+ | 0.4249 | 300 | 0.0003 | - |
165
+ | 0.4958 | 350 | 0.0001 | - |
166
+ | 0.5666 | 400 | 0.0001 | - |
167
+ | 0.6374 | 450 | 0.0001 | - |
168
+ | 0.7082 | 500 | 0.0001 | - |
169
+ | 0.7790 | 550 | 0.0001 | - |
170
+ | 0.8499 | 600 | 0.0002 | - |
171
+ | 0.9207 | 650 | 0.0001 | - |
172
+ | 0.9915 | 700 | 0.0001 | - |
173
+ | **1.0** | **706** | **-** | **0.0168** |
174
+ | 1.0623 | 750 | 0.0 | - |
175
+ | 1.1331 | 800 | 0.0001 | - |
176
+ | 1.2040 | 850 | 0.0001 | - |
177
+ | 1.2748 | 900 | 0.0 | - |
178
+ | 1.3456 | 950 | 0.0001 | - |
179
+ | 1.4164 | 1000 | 0.0 | - |
180
+ | 1.4873 | 1050 | 0.0 | - |
181
+ | 1.5581 | 1100 | 0.0 | - |
182
+ | 1.6289 | 1150 | 0.0 | - |
183
+ | 1.6997 | 1200 | 0.0 | - |
184
+ | 1.7705 | 1250 | 0.0 | - |
185
+ | 1.8414 | 1300 | 0.0002 | - |
186
+ | 1.9122 | 1350 | 0.0 | - |
187
+ | 1.9830 | 1400 | 0.0 | - |
188
+ | 2.0 | 1412 | - | 0.0183 |
189
+
190
+ * The bold row denotes the saved checkpoint.
191
+ ### Framework Versions
192
+ - Python: 3.10.12
193
+ - SetFit: 1.0.1
194
+ - Sentence Transformers: 2.2.2
195
+ - Transformers: 4.35.2
196
+ - PyTorch: 2.1.0+cu121
197
+ - Datasets: 2.16.0
198
+ - Tokenizers: 0.15.0
199
+
200
+ ## Citation
201
+
202
+ ### BibTeX
203
+ ```bibtex
204
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
205
+ doi = {10.48550/ARXIV.2209.11055},
206
+ url = {https://arxiv.org/abs/2209.11055},
207
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
208
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
209
+ title = {Efficient Few-Shot Learning Without Prompts},
210
+ publisher = {arXiv},
211
+ year = {2022},
212
+ copyright = {Creative Commons Attribution 4.0 International}
213
+ }
214
+ ```
215
+
216
+ <!--
217
+ ## Glossary
218
+
219
+ *Clearly define terms in order to be accessible across audiences.*
220
+ -->
221
+
222
+ <!--
223
+ ## Model Card Authors
224
+
225
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
226
+ -->
227
+
228
+ <!--
229
+ ## Model Card Contact
230
+
231
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
232
+ -->
config.json ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "checkpoints/step_706/",
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.35.2",
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.6.1",
5
+ "pytorch": "1.8.1"
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:413446a1820462c7da2b156d339e1c8201a89373d3185937cf9e23c5453d757c
3
+ size 437967672
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:16e50a8f183198bf58f8007ad172622255f6cb74bc1ef89d842157a740f93833
3
+ size 19311
modules.json ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ {
15
+ "idx": 2,
16
+ "name": "2",
17
+ "path": "2_Normalize",
18
+ "type": "sentence_transformers.models.Normalize"
19
+ }
20
+ ]
sentence_bert_config.json ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ {
2
+ "max_seq_length": 384,
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,72 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ "3": {
28
+ "content": "<unk>",
29
+ "lstrip": false,
30
+ "normalized": true,
31
+ "rstrip": false,
32
+ "single_word": false,
33
+ "special": true
34
+ },
35
+ "104": {
36
+ "content": "[UNK]",
37
+ "lstrip": false,
38
+ "normalized": false,
39
+ "rstrip": false,
40
+ "single_word": false,
41
+ "special": true
42
+ },
43
+ "30526": {
44
+ "content": "<mask>",
45
+ "lstrip": true,
46
+ "normalized": false,
47
+ "rstrip": false,
48
+ "single_word": false,
49
+ "special": true
50
+ }
51
+ },
52
+ "bos_token": "<s>",
53
+ "clean_up_tokenization_spaces": true,
54
+ "cls_token": "<s>",
55
+ "do_lower_case": true,
56
+ "eos_token": "</s>",
57
+ "mask_token": "<mask>",
58
+ "max_length": 128,
59
+ "model_max_length": 512,
60
+ "pad_to_multiple_of": null,
61
+ "pad_token": "<pad>",
62
+ "pad_token_type_id": 0,
63
+ "padding_side": "right",
64
+ "sep_token": "</s>",
65
+ "stride": 0,
66
+ "strip_accents": null,
67
+ "tokenize_chinese_chars": true,
68
+ "tokenizer_class": "MPNetTokenizer",
69
+ "truncation_side": "right",
70
+ "truncation_strategy": "longest_first",
71
+ "unk_token": "[UNK]"
72
+ }
vocab.txt ADDED
The diff for this file is too large to render. See raw diff