kneau007 commited on
Commit
e26c616
·
verified ·
1 Parent(s): 0beaafc

Add SetFit model

Browse files
1_Pooling/config.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
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
+ "pooling_mode_weightedmean_tokens": false,
8
+ "pooling_mode_lasttoken": false,
9
+ "include_prompt": true
10
+ }
README.md ADDED
@@ -0,0 +1,221 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ tags:
3
+ - setfit
4
+ - sentence-transformers
5
+ - text-classification
6
+ - generated_from_setfit_trainer
7
+ widget:
8
+ - text: '"e-Allahabad Journey loan application workflow?"'
9
+ - text: '"Relief Bonds redemption during OD tenure?"'
10
+ - text: '"Chief General Managers'' discretionary powers?"'
11
+ - text: '"Digital Journey e-Allahabad nominee update steps?"'
12
+ - text: '"SGB partial withdrawal during loan period?"'
13
+ metrics:
14
+ - accuracy
15
+ pipeline_tag: text-classification
16
+ library_name: setfit
17
+ inference: true
18
+ base_model: sentence-transformers/paraphrase-mpnet-base-v2
19
+ model-index:
20
+ - name: SetFit with sentence-transformers/paraphrase-mpnet-base-v2
21
+ results:
22
+ - task:
23
+ type: text-classification
24
+ name: Text Classification
25
+ dataset:
26
+ name: Unknown
27
+ type: unknown
28
+ split: test
29
+ metrics:
30
+ - type: accuracy
31
+ value: 0.975
32
+ name: Accuracy
33
+ ---
34
+
35
+ # SetFit with sentence-transformers/paraphrase-mpnet-base-v2
36
+
37
+ 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 [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance is used for classification.
38
+
39
+ The model has been trained using an efficient few-shot learning technique that involves:
40
+
41
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
42
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
43
+
44
+ ## Model Details
45
+
46
+ ### Model Description
47
+ - **Model Type:** SetFit
48
+ - **Sentence Transformer body:** [sentence-transformers/paraphrase-mpnet-base-v2](https://huggingface.co/sentence-transformers/paraphrase-mpnet-base-v2)
49
+ - **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
50
+ - **Maximum Sequence Length:** 512 tokens
51
+ - **Number of Classes:** 10 classes
52
+ <!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
53
+ <!-- - **Language:** Unknown -->
54
+ <!-- - **License:** Unknown -->
55
+
56
+ ### Model Sources
57
+
58
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
59
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
60
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
61
+
62
+ ### Model Labels
63
+ | Label | Examples |
64
+ |:-----------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
65
+ | Disclaimer | <ul><li>'"Terms of Use API restrictions?"'</li><li>'"Terms of Use age restrictions?"'</li><li>'"Disclaimer update alerts?"'</li></ul> |
66
+ | IB Loan against Sovereign Gold Bond | <ul><li>'"Sovereign Jewel Bond loan margin requirements?"'</li><li>'"Sovereign Gold Bond joint holder rules?"'</li><li>'"Sovereign Jewel Bond nomination process?"'</li></ul> |
67
+ | Ind Advantage (Reward Program) | <ul><li>'"Advantage Rewards international redemption fees?"'</li><li>'"Blackout dates for reward travel bookings?"'</li><li>'"Advantage Program customer support channels?"'</li></ul> |
68
+ | Amalgamation | <ul><li>'"Merger documentation checklist for branches?"'</li><li>'"Banking Amalgamation customer notification process?"'</li><li>'"Amalgamation loan portfolio transfer details?"'</li></ul> |
69
+ | Loan / OD against NSC / KVP / Relief bonds of RBI / LIC policies | <ul><li>'"Relief Bonds OD interest payment frequency?"'</li><li>'"KVP valuation for overdraft approval criteria?"'</li><li>'"NSC loan documentation checklist?"'</li></ul> |
70
+ | Chief General Managers | <ul><li>'"Chief General Managers\' office working hours?"'</li><li>'"How to contact Chief General Managers for escalations?"'</li><li>'"Senior General Managers\' regional jurisdiction list?"'</li></ul> |
71
+ | Point of Sale (PoS) | <ul><li>'"Offline PoS transaction capabilities?"'</li><li>'"PoS transaction audit trails?"'</li><li>'"PoS batch settlement timing?"'</li></ul> |
72
+ | Featured Products / Services / Schemes | <ul><li>'"Highlighted Products insurance coverage details?"'</li><li>'"Highlighted Products loan-to-value ratio?"'</li><li>'"Featured schemes disbursement timeline?"'</li></ul> |
73
+ | e-Allahabad Bank Journey | <ul><li>'"e-Allahabad Experience customer support channels?"'</li><li>'"Allahabad Online Journey QR code payments?"'</li><li>'"Allahabad Online Journey statement download process?"'</li></ul> |
74
+ |  Centralized Pension Processing Centre | <ul><li>'"Processing time for pension applications?"'</li><li>'"QR code payments at Payment Office?"'</li><li>'"Central Pension Management Centre contact details?"'</li></ul> |
75
+
76
+ ## Evaluation
77
+
78
+ ### Metrics
79
+ | Label | Accuracy |
80
+ |:--------|:---------|
81
+ | **all** | 0.975 |
82
+
83
+ ## Uses
84
+
85
+ ### Direct Use for Inference
86
+
87
+ First install the SetFit library:
88
+
89
+ ```bash
90
+ pip install setfit
91
+ ```
92
+
93
+ Then you can load this model and run inference.
94
+
95
+ ```python
96
+ from setfit import SetFitModel
97
+
98
+ # Download from the 🤗 Hub
99
+ model = SetFitModel.from_pretrained("kneau007/my-classifier")
100
+ # Run inference
101
+ preds = model("\"Relief Bonds redemption during OD tenure?\"")
102
+ ```
103
+
104
+ <!--
105
+ ### Downstream Use
106
+
107
+ *List how someone could finetune this model on their own dataset.*
108
+ -->
109
+
110
+ <!--
111
+ ### Out-of-Scope Use
112
+
113
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
114
+ -->
115
+
116
+ <!--
117
+ ## Bias, Risks and Limitations
118
+
119
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
120
+ -->
121
+
122
+ <!--
123
+ ### Recommendations
124
+
125
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
126
+ -->
127
+
128
+ ## Training Details
129
+
130
+ ### Training Set Metrics
131
+ | Training set | Min | Median | Max |
132
+ |:-------------|:----|:-------|:----|
133
+ | Word count | 3 | 5.2062 | 8 |
134
+
135
+ | Label | Training Sample Count |
136
+ |:-----------------------------------------------------------------|:----------------------|
137
+ | Amalgamation | 14 |
138
+ | Chief General Managers | 16 |
139
+ | Disclaimer | 11 |
140
+ | Featured Products / Services / Schemes | 18 |
141
+ | IB Loan against Sovereign Gold Bond | 18 |
142
+ | Ind Advantage (Reward Program) | 19 |
143
+ | Loan / OD against NSC / KVP / Relief bonds of RBI / LIC policies | 16 |
144
+ | Point of Sale (PoS) | 16 |
145
+ | e-Allahabad Bank Journey | 15 |
146
+ |  Centralized Pension Processing Centre | 17 |
147
+
148
+ ### Training Hyperparameters
149
+ - batch_size: (16, 16)
150
+ - num_epochs: (1, 1)
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
+ - l2_weight: 0.01
163
+ - seed: 42
164
+ - eval_max_steps: -1
165
+ - load_best_model_at_end: False
166
+
167
+ ### Training Results
168
+ | Epoch | Step | Training Loss | Validation Loss |
169
+ |:------:|:----:|:-------------:|:---------------:|
170
+ | 0.0025 | 1 | 0.172 | - |
171
+ | 0.125 | 50 | 0.1198 | - |
172
+ | 0.25 | 100 | 0.0251 | - |
173
+ | 0.375 | 150 | 0.0068 | - |
174
+ | 0.5 | 200 | 0.003 | - |
175
+ | 0.625 | 250 | 0.0018 | - |
176
+ | 0.75 | 300 | 0.0015 | - |
177
+ | 0.875 | 350 | 0.0013 | - |
178
+ | 1.0 | 400 | 0.0013 | - |
179
+
180
+ ### Framework Versions
181
+ - Python: 3.11.11
182
+ - SetFit: 1.1.1
183
+ - Sentence Transformers: 3.4.1
184
+ - Transformers: 4.48.3
185
+ - PyTorch: 2.5.1+cu124
186
+ - Datasets: 3.3.2
187
+ - Tokenizers: 0.21.0
188
+
189
+ ## Citation
190
+
191
+ ### BibTeX
192
+ ```bibtex
193
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
194
+ doi = {10.48550/ARXIV.2209.11055},
195
+ url = {https://arxiv.org/abs/2209.11055},
196
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
197
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
198
+ title = {Efficient Few-Shot Learning Without Prompts},
199
+ publisher = {arXiv},
200
+ year = {2022},
201
+ copyright = {Creative Commons Attribution 4.0 International}
202
+ }
203
+ ```
204
+
205
+ <!--
206
+ ## Glossary
207
+
208
+ *Clearly define terms in order to be accessible across audiences.*
209
+ -->
210
+
211
+ <!--
212
+ ## Model Card Authors
213
+
214
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
215
+ -->
216
+
217
+ <!--
218
+ ## Model Card Contact
219
+
220
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
221
+ -->
config.json ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "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.48.3",
23
+ "vocab_size": 30527
24
+ }
config_sentence_transformers.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "sentence_transformers": "3.4.1",
4
+ "transformers": "4.48.3",
5
+ "pytorch": "2.5.1+cu124"
6
+ },
7
+ "prompts": {},
8
+ "default_prompt_name": null,
9
+ "similarity_fn_name": "cosine"
10
+ }
config_setfit.json ADDED
@@ -0,0 +1,15 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "normalize_embeddings": false,
3
+ "labels": [
4
+ "Amalgamation",
5
+ "Chief General Managers",
6
+ "Disclaimer",
7
+ "Featured Products / Services / Schemes",
8
+ "IB Loan against Sovereign Gold Bond",
9
+ "Ind Advantage (Reward Program)",
10
+ "Loan / OD against NSC / KVP / Relief bonds of RBI / LIC policies",
11
+ "Point of Sale (PoS)",
12
+ "e-Allahabad Bank Journey",
13
+ "\u00a0Centralized Pension Processing Centre"
14
+ ]
15
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:13a0675b2dce7ba6d013cd17d0953fd9bdb2b90a4dc886a780f611b15ba2b82f
3
+ size 437967672
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:da06733b12907c4bb5bc78dd0a319a0b3936228fc03354872731df911615f8ba
3
+ size 64919
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": 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,60 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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": false,
46
+ "cls_token": "<s>",
47
+ "do_basic_tokenize": true,
48
+ "do_lower_case": true,
49
+ "eos_token": "</s>",
50
+ "extra_special_tokens": {},
51
+ "mask_token": "<mask>",
52
+ "model_max_length": 512,
53
+ "never_split": null,
54
+ "pad_token": "<pad>",
55
+ "sep_token": "</s>",
56
+ "strip_accents": null,
57
+ "tokenize_chinese_chars": true,
58
+ "tokenizer_class": "MPNetTokenizer",
59
+ "unk_token": "[UNK]"
60
+ }
vocab.txt ADDED
The diff for this file is too large to render. See raw diff