nikcheerla commited on
Commit
4b604c3
1 Parent(s): 88ce3a8

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,200 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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: Hello?
12
+ - text: Hello. And thank you for calling Global Services.
13
+ - text: Hi. This Joshua Poland. This is Nicole. But I can't
14
+ - text: This is Matt. Please leave a message sense?
15
+ - text: Good afternoon. Ztech's customer
16
+ pipeline_tag: text-classification
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.9675785207700102
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:** 2 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
+ | machine | <ul><li>'Your call has been forwarded to an automated voice message'</li><li>'Neil Capel. Raju is currently unavailable.'</li><li>'Hi.'</li></ul> |
66
+ | human | <ul><li>'This is Tom. Hello?'</li><li>'Cry like Columbia. This is Sarah. Sarah.'</li><li>'Hello?'</li></ul> |
67
+
68
+ ## Evaluation
69
+
70
+ ### Metrics
71
+ | Label | Accuracy |
72
+ |:--------|:---------|
73
+ | **all** | 0.9676 |
74
+
75
+ ## Uses
76
+
77
+ ### Direct Use for Inference
78
+
79
+ First install the SetFit library:
80
+
81
+ ```bash
82
+ pip install setfit
83
+ ```
84
+
85
+ Then you can load this model and run inference.
86
+
87
+ ```python
88
+ from setfit import SetFitModel
89
+
90
+ # Download from the 🤗 Hub
91
+ model = SetFitModel.from_pretrained("nikcheerla/amd-partial-v1")
92
+ # Run inference
93
+ preds = model("Hello?")
94
+ ```
95
+
96
+ <!--
97
+ ### Downstream Use
98
+
99
+ *List how someone could finetune this model on their own dataset.*
100
+ -->
101
+
102
+ <!--
103
+ ### Out-of-Scope Use
104
+
105
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
106
+ -->
107
+
108
+ <!--
109
+ ## Bias, Risks and Limitations
110
+
111
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
112
+ -->
113
+
114
+ <!--
115
+ ### Recommendations
116
+
117
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
118
+ -->
119
+
120
+ ## Training Details
121
+
122
+ ### Training Set Metrics
123
+ | Training set | Min | Median | Max |
124
+ |:-------------|:----|:-------|:----|
125
+ | Word count | 1 | 7.6844 | 18 |
126
+
127
+ | Label | Training Sample Count |
128
+ |:--------|:----------------------|
129
+ | human | 1489 |
130
+ | machine | 6405 |
131
+
132
+ ### Training Hyperparameters
133
+ - batch_size: (64, 64)
134
+ - num_epochs: (3, 3)
135
+ - max_steps: -1
136
+ - sampling_strategy: oversampling
137
+ - num_iterations: 20
138
+ - body_learning_rate: (2e-05, 1e-05)
139
+ - head_learning_rate: 0.01
140
+ - loss: CosineSimilarityLoss
141
+ - distance_metric: cosine_distance
142
+ - margin: 0.25
143
+ - end_to_end: False
144
+ - use_amp: True
145
+ - warmup_proportion: 0.1
146
+ - seed: 42
147
+ - eval_max_steps: -1
148
+ - load_best_model_at_end: True
149
+
150
+ ### Training Results
151
+ | Epoch | Step | Training Loss | Validation Loss |
152
+ |:-------:|:--------:|:-------------:|:---------------:|
153
+ | 0.0002 | 1 | 0.274 | - |
154
+ | **1.0** | **4934** | **0.0021** | **0.0615** |
155
+ | 2.0 | 9868 | 0.0126 | 0.065 |
156
+ | 3.0 | 14802 | 0.0206 | 0.065 |
157
+
158
+ * The bold row denotes the saved checkpoint.
159
+ ### Framework Versions
160
+ - Python: 3.10.12
161
+ - SetFit: 1.0.1
162
+ - Sentence Transformers: 2.2.2
163
+ - Transformers: 4.35.2
164
+ - PyTorch: 2.0.1+cu118
165
+ - Datasets: 2.16.1
166
+ - Tokenizers: 0.15.0
167
+
168
+ ## Citation
169
+
170
+ ### BibTeX
171
+ ```bibtex
172
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
173
+ doi = {10.48550/ARXIV.2209.11055},
174
+ url = {https://arxiv.org/abs/2209.11055},
175
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
176
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
177
+ title = {Efficient Few-Shot Learning Without Prompts},
178
+ publisher = {arXiv},
179
+ year = {2022},
180
+ copyright = {Creative Commons Attribution 4.0 International}
181
+ }
182
+ ```
183
+
184
+ <!--
185
+ ## Glossary
186
+
187
+ *Clearly define terms in order to be accessible across audiences.*
188
+ -->
189
+
190
+ <!--
191
+ ## Model Card Authors
192
+
193
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
194
+ -->
195
+
196
+ <!--
197
+ ## Model Card Contact
198
+
199
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
200
+ -->
config.json ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "checkpoints/step_4934/",
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:6c6ae2581fbfe3a10d5a1426f4ed9c9947b4dd01c8302a447e08984979338bba
3
+ size 437967672
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:cab39690c338caa74f693e42b111a6af7413067688b140400506cbf11fcb38b7
3
+ size 7039
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,66 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ "max_length": 512,
52
+ "model_max_length": 512,
53
+ "never_split": null,
54
+ "pad_to_multiple_of": null,
55
+ "pad_token": "<pad>",
56
+ "pad_token_type_id": 0,
57
+ "padding_side": "right",
58
+ "sep_token": "</s>",
59
+ "stride": 0,
60
+ "strip_accents": null,
61
+ "tokenize_chinese_chars": true,
62
+ "tokenizer_class": "MPNetTokenizer",
63
+ "truncation_side": "right",
64
+ "truncation_strategy": "longest_first",
65
+ "unk_token": "[UNK]"
66
+ }
vocab.txt ADDED
The diff for this file is too large to render. See raw diff