Ramyashree commited on
Commit
e2d8ce4
1 Parent(s): 4f53c11

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
+ datasets:
9
+ - Ramyashree/Dataset-setfit-Trainer
10
+ metrics:
11
+ - accuracy
12
+ widget:
13
+ - text: I wanna obtain some invoices, can you tell me how to do it?
14
+ - text: where to close my user account
15
+ - text: I have a problem when trying to pay, help me report it
16
+ - text: the concert was cancelled and I want to obtain a reimbursement
17
+ - text: I got an error message when I tried to make a payment, but I was charged anyway,
18
+ can you help me?
19
+ pipeline_tag: text-classification
20
+ inference: true
21
+ base_model: sentence-transformers/paraphrase-mpnet-base-v2
22
+ ---
23
+
24
+ # SetFit with sentence-transformers/paraphrase-mpnet-base-v2
25
+
26
+ This is a [SetFit](https://github.com/huggingface/setfit) model trained on the [Ramyashree/Dataset-setfit-Trainer](https://huggingface.co/datasets/Ramyashree/Dataset-setfit-Trainer) dataset 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 [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance is used for classification.
27
+
28
+ The model has been trained using an efficient few-shot learning technique that involves:
29
+
30
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
31
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
32
+
33
+ ## Model Details
34
+
35
+ ### Model Description
36
+ - **Model Type:** SetFit
37
+ - **Sentence Transformer body:** [sentence-transformers/paraphrase-mpnet-base-v2](https://huggingface.co/sentence-transformers/paraphrase-mpnet-base-v2)
38
+ - **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
39
+ - **Maximum Sequence Length:** 512 tokens
40
+ - **Number of Classes:** 10 classes
41
+ - **Training Dataset:** [Ramyashree/Dataset-setfit-Trainer](https://huggingface.co/datasets/Ramyashree/Dataset-setfit-Trainer)
42
+ <!-- - **Language:** Unknown -->
43
+ <!-- - **License:** Unknown -->
44
+
45
+ ### Model Sources
46
+
47
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
48
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
49
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
50
+
51
+ ### Model Labels
52
+ | Label | Examples |
53
+ |:--------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
54
+ | create_account | <ul><li>"I don't have an online account, what do I have to do to register?"</li><li>'can you tell me if i can regisger two accounts with a single email address?'</li><li>'I have no online account, open one, please'</li></ul> |
55
+ | edit_account | <ul><li>'how can I modify the information on my profile?'</li><li>'can u ask an agent how to make changes to my profile?'</li><li>'I want to update the information on my profile'</li></ul> |
56
+ | delete_account | <ul><li>'can I close my account?'</li><li>"I don't want my account, can you delete it?"</li><li>'how do i close my online account?'</li></ul> |
57
+ | switch_account | <ul><li>'I would like to use my other online account , could you switch them, please?'</li><li>'i want to use my other online account, can u change them?'</li><li>'how do i change to another account?'</li></ul> |
58
+ | get_invoice | <ul><li>'what can you tell me about getting some bills?'</li><li>'tell me where I can request a bill'</li><li>'ask an agent if i can obtain some bills'</li></ul> |
59
+ | get_refund | <ul><li>'the game was postponed, help me obtain a reimbursement'</li><li>'the game was postponed, what should I do to obtain a reimbursement?'</li><li>'the concert was postponed, what should I do to request a reimbursement?'</li></ul> |
60
+ | payment_issue | <ul><li>'i have an issue making a payment with card and i want to inform of it, please'</li><li>'I got an error message when I attempted to pay, but my card was charged anyway and I want to notify it'</li><li>'I want to notify a problem making a payment, can you help me?'</li></ul> |
61
+ | check_refund_policy | <ul><li>"I'm interested in your reimbursement polivy"</li><li>'i wanna see your refund policy, can u help me?'</li><li>'where do I see your money back policy?'</li></ul> |
62
+ | recover_password | <ul><li>'my online account was hacked and I want tyo get it back'</li><li>"I lost my password and I'd like to retrieve it, please"</li><li>'could u ask an agent how i can reset my password?'</li></ul> |
63
+ | track_refund | <ul><li>'tell me if my refund was processed'</li><li>'I need help checking the status of my refund'</li><li>'I want to see the status of my refund, can you help me?'</li></ul> |
64
+
65
+ ## Uses
66
+
67
+ ### Direct Use for Inference
68
+
69
+ First install the SetFit library:
70
+
71
+ ```bash
72
+ pip install setfit
73
+ ```
74
+
75
+ Then you can load this model and run inference.
76
+
77
+ ```python
78
+ from setfit import SetFitModel
79
+
80
+ # Download from the 🤗 Hub
81
+ model = SetFitModel.from_pretrained("Ramyashree/setfit-trained-model-withlabel")
82
+ # Run inference
83
+ preds = model("where to close my user account")
84
+ ```
85
+
86
+ <!--
87
+ ### Downstream Use
88
+
89
+ *List how someone could finetune this model on their own dataset.*
90
+ -->
91
+
92
+ <!--
93
+ ### Out-of-Scope Use
94
+
95
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
96
+ -->
97
+
98
+ <!--
99
+ ## Bias, Risks and Limitations
100
+
101
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
102
+ -->
103
+
104
+ <!--
105
+ ### Recommendations
106
+
107
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
108
+ -->
109
+
110
+ ## Training Details
111
+
112
+ ### Training Set Metrics
113
+ | Training set | Min | Median | Max |
114
+ |:-------------|:----|:-------|:----|
115
+ | Word count | 3 | 10.258 | 24 |
116
+
117
+ | Label | Training Sample Count |
118
+ |:--------------------|:----------------------|
119
+ | check_refund_policy | 50 |
120
+ | create_account | 50 |
121
+ | delete_account | 50 |
122
+ | edit_account | 50 |
123
+ | get_invoice | 50 |
124
+ | get_refund | 50 |
125
+ | payment_issue | 50 |
126
+ | recover_password | 50 |
127
+ | switch_account | 50 |
128
+ | track_refund | 50 |
129
+
130
+ ### Training Hyperparameters
131
+ - batch_size: (16, 16)
132
+ - num_epochs: (1, 1)
133
+ - max_steps: -1
134
+ - sampling_strategy: oversampling
135
+ - num_iterations: 20
136
+ - body_learning_rate: (2e-05, 2e-05)
137
+ - head_learning_rate: 2e-05
138
+ - loss: CosineSimilarityLoss
139
+ - distance_metric: cosine_distance
140
+ - margin: 0.25
141
+ - end_to_end: False
142
+ - use_amp: False
143
+ - warmup_proportion: 0.1
144
+ - seed: 42
145
+ - eval_max_steps: -1
146
+ - load_best_model_at_end: False
147
+
148
+ ### Training Results
149
+ | Epoch | Step | Training Loss | Validation Loss |
150
+ |:------:|:----:|:-------------:|:---------------:|
151
+ | 0.0008 | 1 | 0.1175 | - |
152
+ | 0.04 | 50 | 0.091 | - |
153
+ | 0.08 | 100 | 0.0162 | - |
154
+ | 0.12 | 150 | 0.0101 | - |
155
+ | 0.16 | 200 | 0.0013 | - |
156
+ | 0.2 | 250 | 0.0007 | - |
157
+ | 0.24 | 300 | 0.0011 | - |
158
+ | 0.28 | 350 | 0.0009 | - |
159
+ | 0.32 | 400 | 0.0006 | - |
160
+ | 0.36 | 450 | 0.0007 | - |
161
+ | 0.4 | 500 | 0.0006 | - |
162
+ | 0.44 | 550 | 0.0006 | - |
163
+ | 0.48 | 600 | 0.0006 | - |
164
+ | 0.52 | 650 | 0.0006 | - |
165
+ | 0.56 | 700 | 0.0004 | - |
166
+ | 0.6 | 750 | 0.0004 | - |
167
+ | 0.64 | 800 | 0.0003 | - |
168
+ | 0.68 | 850 | 0.0004 | - |
169
+ | 0.72 | 900 | 0.0004 | - |
170
+ | 0.76 | 950 | 0.0004 | - |
171
+ | 0.8 | 1000 | 0.0003 | - |
172
+ | 0.84 | 1050 | 0.0003 | - |
173
+ | 0.88 | 1100 | 0.0004 | - |
174
+ | 0.92 | 1150 | 0.0003 | - |
175
+ | 0.96 | 1200 | 0.0005 | - |
176
+ | 1.0 | 1250 | 0.0002 | - |
177
+
178
+ ### Framework Versions
179
+ - Python: 3.10.12
180
+ - SetFit: 1.0.1
181
+ - Sentence Transformers: 2.2.2
182
+ - Transformers: 4.35.2
183
+ - PyTorch: 2.1.0+cu121
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": "/root/.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.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.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:b6efda46dce65b8ead061b22bb37a6809d6a951855ae0d43ff2445c650548bf1
3
+ size 437967672
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:72a56c029e9c705a6795917bf54ab1afe9c6c7fab4213159fea9342ea2f138c5
3
+ size 63111
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