PLB commited on
Commit
789c568
1 Parent(s): 994f524

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,195 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ library_name: setfit
3
+ tags:
4
+ - setfit
5
+ - sentence-transformers
6
+ - text-classification
7
+ - generated_from_setfit_trainer
8
+ base_model: sentence-transformers/paraphrase-mpnet-base-v2
9
+ metrics:
10
+ - accuracy
11
+ widget:
12
+ - text: What happens if I drive with low tire pressure?
13
+ - text: How often should I rotate my tires?
14
+ - text: How can I tell if my tire is properly balanced?
15
+ - text: How does tire pressure affect handling and braking?
16
+ pipeline_tag: text-classification
17
+ inference: true
18
+ model-index:
19
+ - name: SetFit with sentence-transformers/paraphrase-mpnet-base-v2
20
+ results:
21
+ - task:
22
+ type: text-classification
23
+ name: Text Classification
24
+ dataset:
25
+ name: Unknown
26
+ type: unknown
27
+ split: test
28
+ metrics:
29
+ - type: accuracy
30
+ value: 1.0
31
+ name: Accuracy
32
+ ---
33
+
34
+ # SetFit with sentence-transformers/paraphrase-mpnet-base-v2
35
+
36
+ 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.
37
+
38
+ The model has been trained using an efficient few-shot learning technique that involves:
39
+
40
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
41
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
42
+
43
+ ## Model Details
44
+
45
+ ### Model Description
46
+ - **Model Type:** SetFit
47
+ - **Sentence Transformer body:** [sentence-transformers/paraphrase-mpnet-base-v2](https://huggingface.co/sentence-transformers/paraphrase-mpnet-base-v2)
48
+ - **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
49
+ - **Maximum Sequence Length:** 512 tokens
50
+ - **Number of Classes:** 2 classes
51
+ <!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
52
+ <!-- - **Language:** Unknown -->
53
+ <!-- - **License:** Unknown -->
54
+
55
+ ### Model Sources
56
+
57
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
58
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
59
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
60
+
61
+ ### Model Labels
62
+ | Label | Examples |
63
+ |:------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
64
+ | True | <ul><li>'Can I use nitrogen instead of air to inflate my tires?'</li><li>'What should I do if my tire pressure warning light comes on?'</li><li>'Is it okay to slightly overinflate my tires?'</li></ul> |
65
+ | False | <ul><li>'Can I mix different brands of tires on my vehicle?'</li><li>'How do I know if my tire has a slow leak?'</li><li>'How can I extend the life of my tires?'</li></ul> |
66
+
67
+ ## Evaluation
68
+
69
+ ### Metrics
70
+ | Label | Accuracy |
71
+ |:--------|:---------|
72
+ | **all** | 1.0 |
73
+
74
+ ## Uses
75
+
76
+ ### Direct Use for Inference
77
+
78
+ First install the SetFit library:
79
+
80
+ ```bash
81
+ pip install setfit
82
+ ```
83
+
84
+ Then you can load this model and run inference.
85
+
86
+ ```python
87
+ from setfit import SetFitModel
88
+
89
+ # Download from the 🤗 Hub
90
+ model = SetFitModel.from_pretrained("phospho-app/phospho-small-bfbe72e")
91
+ # Run inference
92
+ preds = model("How often should I rotate my tires?")
93
+ ```
94
+
95
+ <!--
96
+ ### Downstream Use
97
+
98
+ *List how someone could finetune this model on their own dataset.*
99
+ -->
100
+
101
+ <!--
102
+ ### Out-of-Scope Use
103
+
104
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
105
+ -->
106
+
107
+ <!--
108
+ ## Bias, Risks and Limitations
109
+
110
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
111
+ -->
112
+
113
+ <!--
114
+ ### Recommendations
115
+
116
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
117
+ -->
118
+
119
+ ## Training Details
120
+
121
+ ### Training Set Metrics
122
+ | Training set | Min | Median | Max |
123
+ |:-------------|:----|:-------|:----|
124
+ | Word count | 7 | 10.25 | 13 |
125
+
126
+ | Label | Training Sample Count |
127
+ |:------|:----------------------|
128
+ | False | 7 |
129
+ | True | 9 |
130
+
131
+ ### Training Hyperparameters
132
+ - batch_size: (16, 16)
133
+ - num_epochs: (1, 1)
134
+ - max_steps: -1
135
+ - sampling_strategy: oversampling
136
+ - num_iterations: 20
137
+ - body_learning_rate: (2e-05, 2e-05)
138
+ - head_learning_rate: 2e-05
139
+ - loss: CosineSimilarityLoss
140
+ - distance_metric: cosine_distance
141
+ - margin: 0.25
142
+ - end_to_end: False
143
+ - use_amp: False
144
+ - warmup_proportion: 0.1
145
+ - seed: 42
146
+ - eval_max_steps: -1
147
+ - load_best_model_at_end: False
148
+
149
+ ### Training Results
150
+ | Epoch | Step | Training Loss | Validation Loss |
151
+ |:-----:|:----:|:-------------:|:---------------:|
152
+ | 0.025 | 1 | 0.1766 | - |
153
+
154
+ ### Framework Versions
155
+ - Python: 3.11.0
156
+ - SetFit: 1.0.3
157
+ - Sentence Transformers: 2.7.0
158
+ - Transformers: 4.40.1
159
+ - PyTorch: 2.3.0+cu121
160
+ - Datasets: 2.19.0
161
+ - Tokenizers: 0.19.1
162
+
163
+ ## Citation
164
+
165
+ ### BibTeX
166
+ ```bibtex
167
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
168
+ doi = {10.48550/ARXIV.2209.11055},
169
+ url = {https://arxiv.org/abs/2209.11055},
170
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
171
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
172
+ title = {Efficient Few-Shot Learning Without Prompts},
173
+ publisher = {arXiv},
174
+ year = {2022},
175
+ copyright = {Creative Commons Attribution 4.0 International}
176
+ }
177
+ ```
178
+
179
+ <!--
180
+ ## Glossary
181
+
182
+ *Clearly define terms in order to be accessible across audiences.*
183
+ -->
184
+
185
+ <!--
186
+ ## Model Card Authors
187
+
188
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
189
+ -->
190
+
191
+ <!--
192
+ ## Model Card Contact
193
+
194
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
195
+ -->
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.40.1",
23
+ "vocab_size": 30527
24
+ }
config_sentence_transformers.json ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "sentence_transformers": "2.0.0",
4
+ "transformers": "4.7.0",
5
+ "pytorch": "1.9.0+cu102"
6
+ },
7
+ "prompts": {},
8
+ "default_prompt_name": null
9
+ }
config_setfit.json ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ {
2
+ "labels": null,
3
+ "normalize_embeddings": false
4
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:e55d39c2804fbff2450d6f06b7e4ea31c04781c12a969dfaa4d2ff7e7b176f3d
3
+ size 437967672
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:333f676de96765408be72972071f46f241a4f2fa65c608fe8acd24ecdd8e876a
3
+ size 6991
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,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