Ramyashree commited on
Commit
53d4d28
·
1 Parent(s): c64af1b

Add SetFit model

Browse files
1_Pooling/config.json ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ {
2
+ "word_embedding_dimension": 1024,
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,197 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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-80records
10
+ metrics:
11
+ - accuracy
12
+ widget:
13
+ - text: I want to check your money back policy, what can I do?
14
+ - text: ask an agent if i can obtain some bills
15
+ - text: my account's been hacked, what do I have to do?
16
+ - text: the event was postponed, what do i have to do to request a reimbursement?
17
+ - text: how do i close my online account?
18
+ pipeline_tag: text-classification
19
+ inference: true
20
+ base_model: thenlper/gte-large
21
+ ---
22
+
23
+ # SetFit with thenlper/gte-large
24
+
25
+ This is a [SetFit](https://github.com/huggingface/setfit) model trained on the [Ramyashree/Dataset-setfit-Trainer-80records](https://huggingface.co/datasets/Ramyashree/Dataset-setfit-Trainer-80records) dataset that can be used for Text Classification. This SetFit model uses [thenlper/gte-large](https://huggingface.co/thenlper/gte-large) 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.
26
+
27
+ The model has been trained using an efficient few-shot learning technique that involves:
28
+
29
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
30
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
31
+
32
+ ## Model Details
33
+
34
+ ### Model Description
35
+ - **Model Type:** SetFit
36
+ - **Sentence Transformer body:** [thenlper/gte-large](https://huggingface.co/thenlper/gte-large)
37
+ - **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
38
+ - **Maximum Sequence Length:** 512 tokens
39
+ - **Number of Classes:** 10 classes
40
+ - **Training Dataset:** [Ramyashree/Dataset-setfit-Trainer-80records](https://huggingface.co/datasets/Ramyashree/Dataset-setfit-Trainer-80records)
41
+ <!-- - **Language:** Unknown -->
42
+ <!-- - **License:** Unknown -->
43
+
44
+ ### Model Sources
45
+
46
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
47
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
48
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
49
+
50
+ ### Model Labels
51
+ | Label | Examples |
52
+ |:--------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
53
+ | 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> |
54
+ | 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> |
55
+ | 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> |
56
+ | 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> |
57
+ | 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> |
58
+ | 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> |
59
+ | 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> |
60
+ | 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> |
61
+ | 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> |
62
+ | 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> |
63
+
64
+ ## Uses
65
+
66
+ ### Direct Use for Inference
67
+
68
+ First install the SetFit library:
69
+
70
+ ```bash
71
+ pip install setfit
72
+ ```
73
+
74
+ Then you can load this model and run inference.
75
+
76
+ ```python
77
+ from setfit import SetFitModel
78
+
79
+ # Download from the 🤗 Hub
80
+ model = SetFitModel.from_pretrained("Ramyashree/gte-large-with80records")
81
+ # Run inference
82
+ preds = model("how do i close my online account?")
83
+ ```
84
+
85
+ <!--
86
+ ### Downstream Use
87
+
88
+ *List how someone could finetune this model on their own dataset.*
89
+ -->
90
+
91
+ <!--
92
+ ### Out-of-Scope Use
93
+
94
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
95
+ -->
96
+
97
+ <!--
98
+ ## Bias, Risks and Limitations
99
+
100
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
101
+ -->
102
+
103
+ <!--
104
+ ### Recommendations
105
+
106
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
107
+ -->
108
+
109
+ ## Training Details
110
+
111
+ ### Training Set Metrics
112
+ | Training set | Min | Median | Max |
113
+ |:-------------|:----|:-------|:----|
114
+ | Word count | 4 | 10.325 | 22 |
115
+
116
+ | Label | Training Sample Count |
117
+ |:--------------------|:----------------------|
118
+ | check_refund_policy | 8 |
119
+ | create_account | 8 |
120
+ | delete_account | 8 |
121
+ | edit_account | 8 |
122
+ | get_invoice | 8 |
123
+ | get_refund | 8 |
124
+ | payment_issue | 8 |
125
+ | recover_password | 8 |
126
+ | switch_account | 8 |
127
+ | track_refund | 8 |
128
+
129
+ ### Training Hyperparameters
130
+ - batch_size: (16, 16)
131
+ - num_epochs: (1, 1)
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.005 | 1 | 0.3449 | - |
151
+ | 0.25 | 50 | 0.022 | - |
152
+ | 0.5 | 100 | 0.0039 | - |
153
+ | 0.75 | 150 | 0.0012 | - |
154
+ | 1.0 | 200 | 0.0012 | - |
155
+
156
+ ### Framework Versions
157
+ - Python: 3.10.12
158
+ - SetFit: 1.0.1
159
+ - Sentence Transformers: 2.2.2
160
+ - Transformers: 4.35.2
161
+ - PyTorch: 2.1.0+cu121
162
+ - Datasets: 2.15.0
163
+ - Tokenizers: 0.15.0
164
+
165
+ ## Citation
166
+
167
+ ### BibTeX
168
+ ```bibtex
169
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
170
+ doi = {10.48550/ARXIV.2209.11055},
171
+ url = {https://arxiv.org/abs/2209.11055},
172
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
173
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
174
+ title = {Efficient Few-Shot Learning Without Prompts},
175
+ publisher = {arXiv},
176
+ year = {2022},
177
+ copyright = {Creative Commons Attribution 4.0 International}
178
+ }
179
+ ```
180
+
181
+ <!--
182
+ ## Glossary
183
+
184
+ *Clearly define terms in order to be accessible across audiences.*
185
+ -->
186
+
187
+ <!--
188
+ ## Model Card Authors
189
+
190
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
191
+ -->
192
+
193
+ <!--
194
+ ## Model Card Contact
195
+
196
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
197
+ -->
config.json ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "/root/.cache/torch/sentence_transformers/thenlper_gte-large/",
3
+ "architectures": [
4
+ "BertModel"
5
+ ],
6
+ "attention_probs_dropout_prob": 0.1,
7
+ "classifier_dropout": null,
8
+ "gradient_checkpointing": false,
9
+ "hidden_act": "gelu",
10
+ "hidden_dropout_prob": 0.1,
11
+ "hidden_size": 1024,
12
+ "initializer_range": 0.02,
13
+ "intermediate_size": 4096,
14
+ "layer_norm_eps": 1e-12,
15
+ "max_position_embeddings": 512,
16
+ "model_type": "bert",
17
+ "num_attention_heads": 16,
18
+ "num_hidden_layers": 24,
19
+ "pad_token_id": 0,
20
+ "position_embedding_type": "absolute",
21
+ "torch_dtype": "float32",
22
+ "transformers_version": "4.35.2",
23
+ "type_vocab_size": 2,
24
+ "use_cache": true,
25
+ "vocab_size": 30522
26
+ }
config_sentence_transformers.json ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "sentence_transformers": "2.2.2",
4
+ "transformers": "4.35.2",
5
+ "pytorch": "2.1.0+cu121"
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:a1fa28f1f5afe54f352993e06fe4721f9381ff3de08bbd660db2798e13ff3f52
3
+ size 1340612432
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:31a68b28865ab9738e967bdc22ab4360cbce857cf33c38540578c435791c4b8f
3
+ size 83591
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": 512,
3
+ "do_lower_case": false
4
+ }
special_tokens_map.json ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ {
2
+ "cls_token": "[CLS]",
3
+ "mask_token": "[MASK]",
4
+ "pad_token": "[PAD]",
5
+ "sep_token": "[SEP]",
6
+ "unk_token": "[UNK]"
7
+ }
tokenizer.json ADDED
The diff for this file is too large to render. See raw diff
 
tokenizer_config.json ADDED
@@ -0,0 +1,62 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "added_tokens_decoder": {
3
+ "0": {
4
+ "content": "[PAD]",
5
+ "lstrip": false,
6
+ "normalized": false,
7
+ "rstrip": false,
8
+ "single_word": false,
9
+ "special": true
10
+ },
11
+ "100": {
12
+ "content": "[UNK]",
13
+ "lstrip": false,
14
+ "normalized": false,
15
+ "rstrip": false,
16
+ "single_word": false,
17
+ "special": true
18
+ },
19
+ "101": {
20
+ "content": "[CLS]",
21
+ "lstrip": false,
22
+ "normalized": false,
23
+ "rstrip": false,
24
+ "single_word": false,
25
+ "special": true
26
+ },
27
+ "102": {
28
+ "content": "[SEP]",
29
+ "lstrip": false,
30
+ "normalized": false,
31
+ "rstrip": false,
32
+ "single_word": false,
33
+ "special": true
34
+ },
35
+ "103": {
36
+ "content": "[MASK]",
37
+ "lstrip": false,
38
+ "normalized": false,
39
+ "rstrip": false,
40
+ "single_word": false,
41
+ "special": true
42
+ }
43
+ },
44
+ "clean_up_tokenization_spaces": true,
45
+ "cls_token": "[CLS]",
46
+ "do_lower_case": true,
47
+ "mask_token": "[MASK]",
48
+ "max_length": 128,
49
+ "model_max_length": 1000000000000000019884624838656,
50
+ "pad_to_multiple_of": null,
51
+ "pad_token": "[PAD]",
52
+ "pad_token_type_id": 0,
53
+ "padding_side": "right",
54
+ "sep_token": "[SEP]",
55
+ "stride": 0,
56
+ "strip_accents": null,
57
+ "tokenize_chinese_chars": true,
58
+ "tokenizer_class": "BertTokenizer",
59
+ "truncation_side": "right",
60
+ "truncation_strategy": "longest_first",
61
+ "unk_token": "[UNK]"
62
+ }
vocab.txt ADDED
The diff for this file is too large to render. See raw diff