nikcheerla commited on
Commit
cd377d3
1 Parent(s): a258608

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,181 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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: 'Your call has been forwarded to an automated voice messaging system. 9 '
12
+ - text: 'Your call has been forwarded to an automatic voice message system. 7133 '
13
+ - text: 'Triage Tronic Industries is not available. Record your message at the tone. '
14
+ - text: 'Hi. This is Sid. I''m sorry I missed your call. Please leave me your name
15
+ and number, and I will get back to you as soon as I can. Thank you, and have '
16
+ - text: 'The Google subscriber you have called is not available. Please leave a message
17
+ after the tone. '
18
+ pipeline_tag: text-classification
19
+ inference: true
20
+ base_model: sentence-transformers/paraphrase-mpnet-base-v2
21
+ ---
22
+
23
+ # SetFit with sentence-transformers/paraphrase-mpnet-base-v2
24
+
25
+ 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.
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:** [sentence-transformers/paraphrase-mpnet-base-v2](https://huggingface.co/sentence-transformers/paraphrase-mpnet-base-v2)
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:** 2 classes
40
+ <!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
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
+ | machine | <ul><li>'Sorry. David Hello. Is not avail '</li><li>'To Mozaz. Please wait as we try to connect you. '</li><li>'Your call has been forwarded to an automated voice messaging system. 2 0 '</li></ul> |
54
+ | human | <ul><li>'Good afternoon. Sesame Workshop. How can I help you today? '</li><li>'This is Kenny. '</li><li>'Hello? '</li></ul> |
55
+
56
+ ## Uses
57
+
58
+ ### Direct Use for Inference
59
+
60
+ First install the SetFit library:
61
+
62
+ ```bash
63
+ pip install setfit
64
+ ```
65
+
66
+ Then you can load this model and run inference.
67
+
68
+ ```python
69
+ from setfit import SetFitModel
70
+
71
+ # Download from the 🤗 Hub
72
+ model = SetFitModel.from_pretrained("nikcheerla/amd-full-v1")
73
+ # Run inference
74
+ preds = model("Your call has been forwarded to an automated voice messaging system. 9 ")
75
+ ```
76
+
77
+ <!--
78
+ ### Downstream Use
79
+
80
+ *List how someone could finetune this model on their own dataset.*
81
+ -->
82
+
83
+ <!--
84
+ ### Out-of-Scope Use
85
+
86
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
87
+ -->
88
+
89
+ <!--
90
+ ## Bias, Risks and Limitations
91
+
92
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
93
+ -->
94
+
95
+ <!--
96
+ ### Recommendations
97
+
98
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
99
+ -->
100
+
101
+ ## Training Details
102
+
103
+ ### Training Set Metrics
104
+ | Training set | Min | Median | Max |
105
+ |:-------------|:----|:--------|:----|
106
+ | Word count | 1 | 14.6725 | 207 |
107
+
108
+ | Label | Training Sample Count |
109
+ |:--------|:----------------------|
110
+ | human | 1495 |
111
+ | machine | 6401 |
112
+
113
+ ### Training Hyperparameters
114
+ - batch_size: (32, 32)
115
+ - num_epochs: (3, 3)
116
+ - max_steps: -1
117
+ - sampling_strategy: oversampling
118
+ - num_iterations: 20
119
+ - body_learning_rate: (2e-05, 1e-05)
120
+ - head_learning_rate: 0.01
121
+ - loss: CosineSimilarityLoss
122
+ - distance_metric: cosine_distance
123
+ - margin: 0.25
124
+ - end_to_end: False
125
+ - use_amp: True
126
+ - warmup_proportion: 0.1
127
+ - seed: 42
128
+ - eval_max_steps: -1
129
+ - load_best_model_at_end: True
130
+
131
+ ### Training Results
132
+ | Epoch | Step | Training Loss | Validation Loss |
133
+ |:-------:|:---------:|:-------------:|:---------------:|
134
+ | 0.0001 | 1 | 0.197 | - |
135
+ | 1.0 | 9870 | 0.0001 | 0.0271 |
136
+ | 2.0 | 19740 | 0.0 | 0.0272 |
137
+ | **3.0** | **29610** | **0.0** | **0.0264** |
138
+
139
+ * The bold row denotes the saved checkpoint.
140
+ ### Framework Versions
141
+ - Python: 3.10.12
142
+ - SetFit: 1.0.1
143
+ - Sentence Transformers: 2.2.2
144
+ - Transformers: 4.35.2
145
+ - PyTorch: 2.0.1+cu118
146
+ - Datasets: 2.16.1
147
+ - Tokenizers: 0.15.0
148
+
149
+ ## Citation
150
+
151
+ ### BibTeX
152
+ ```bibtex
153
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
154
+ doi = {10.48550/ARXIV.2209.11055},
155
+ url = {https://arxiv.org/abs/2209.11055},
156
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
157
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
158
+ title = {Efficient Few-Shot Learning Without Prompts},
159
+ publisher = {arXiv},
160
+ year = {2022},
161
+ copyright = {Creative Commons Attribution 4.0 International}
162
+ }
163
+ ```
164
+
165
+ <!--
166
+ ## Glossary
167
+
168
+ *Clearly define terms in order to be accessible across audiences.*
169
+ -->
170
+
171
+ <!--
172
+ ## Model Card Authors
173
+
174
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
175
+ -->
176
+
177
+ <!--
178
+ ## Model Card Contact
179
+
180
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
181
+ -->
config.json ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "checkpoints/step_29610/",
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:e2e9d8db03a8afdab7dea11cb065ffa93e7ac1801abb9e4dbff0f444e7a6912a
3
+ size 437967672
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:2e769a14669d20afaea7262579ae1eab6db1d01f37765938278e19a2e8483423
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