amitprgx commited on
Commit
df091ab
1 Parent(s): e75612f

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 CHANGED
@@ -1,3 +1,192 @@
1
  ---
2
- license: apache-2.0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ datasets:
10
+ - ethos
11
+ metrics:
12
+ - accuracy
13
+ widget:
14
+ - text: Waitresses are cunts
15
+ - text: Why are we not allowed to kill christians?
16
+ - text: LMAO while watching this church burn
17
+ - text: Islam is a religion of peace.........and we will kill anyone that says otherwise..........in
18
+ the name of Allah of course!
19
+ - text: If only there was a way to get children without having to get women pregnant
20
+ we had them all ready killed
21
+ pipeline_tag: text-classification
22
+ inference: false
23
+ model-index:
24
+ - name: SetFit with sentence-transformers/paraphrase-mpnet-base-v2
25
+ results:
26
+ - task:
27
+ type: text-classification
28
+ name: Text Classification
29
+ dataset:
30
+ name: ethos
31
+ type: ethos
32
+ split: test
33
+ metrics:
34
+ - type: accuracy
35
+ value: 0.4343163538873995
36
+ name: Accuracy
37
  ---
38
+
39
+ # SetFit with sentence-transformers/paraphrase-mpnet-base-v2
40
+
41
+ This is a [SetFit](https://github.com/huggingface/setfit) model trained on the [ethos](https://huggingface.co/datasets/ethos) dataset 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 OneVsRestClassifier instance is used for classification.
42
+
43
+ The model has been trained using an efficient few-shot learning technique that involves:
44
+
45
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
46
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
47
+
48
+ ## Model Details
49
+
50
+ ### Model Description
51
+ - **Model Type:** SetFit
52
+ - **Sentence Transformer body:** [sentence-transformers/paraphrase-mpnet-base-v2](https://huggingface.co/sentence-transformers/paraphrase-mpnet-base-v2)
53
+ - **Classification head:** a OneVsRestClassifier instance
54
+ - **Maximum Sequence Length:** 512 tokens
55
+ <!-- - **Number of Classes:** Unknown -->
56
+ - **Training Dataset:** [ethos](https://huggingface.co/datasets/ethos)
57
+ <!-- - **Language:** Unknown -->
58
+ <!-- - **License:** Unknown -->
59
+
60
+ ### Model Sources
61
+
62
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
63
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
64
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
65
+
66
+ ## Evaluation
67
+
68
+ ### Metrics
69
+ | Label | Accuracy |
70
+ |:--------|:---------|
71
+ | **all** | 0.4343 |
72
+
73
+ ## Uses
74
+
75
+ ### Direct Use for Inference
76
+
77
+ First install the SetFit library:
78
+
79
+ ```bash
80
+ pip install setfit
81
+ ```
82
+
83
+ Then you can load this model and run inference.
84
+
85
+ ```python
86
+ from setfit import SetFitModel
87
+
88
+ # Download from the 🤗 Hub
89
+ model = SetFitModel.from_pretrained("amitprgx/setfit-ethos-multilabel-example")
90
+ # Run inference
91
+ preds = model("Waitresses are cunts")
92
+ ```
93
+
94
+ <!--
95
+ ### Downstream Use
96
+
97
+ *List how someone could finetune this model on their own dataset.*
98
+ -->
99
+
100
+ <!--
101
+ ### Out-of-Scope Use
102
+
103
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
104
+ -->
105
+
106
+ <!--
107
+ ## Bias, Risks and Limitations
108
+
109
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
110
+ -->
111
+
112
+ <!--
113
+ ### Recommendations
114
+
115
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
116
+ -->
117
+
118
+ ## Training Details
119
+
120
+ ### Training Set Metrics
121
+ | Training set | Min | Median | Max |
122
+ |:-------------|:----|:--------|:----|
123
+ | Word count | 4 | 18.0312 | 182 |
124
+
125
+ ### Training Hyperparameters
126
+ - batch_size: (16, 16)
127
+ - num_epochs: (1, 1)
128
+ - max_steps: -1
129
+ - sampling_strategy: oversampling
130
+ - num_iterations: 20
131
+ - body_learning_rate: (2e-05, 2e-05)
132
+ - head_learning_rate: 2e-05
133
+ - loss: CosineSimilarityLoss
134
+ - distance_metric: cosine_distance
135
+ - margin: 0.25
136
+ - end_to_end: False
137
+ - use_amp: False
138
+ - warmup_proportion: 0.1
139
+ - seed: 42
140
+ - eval_max_steps: -1
141
+ - load_best_model_at_end: False
142
+
143
+ ### Training Results
144
+ | Epoch | Step | Training Loss | Validation Loss |
145
+ |:------:|:----:|:-------------:|:---------------:|
146
+ | 0.0063 | 1 | 0.3271 | - |
147
+ | 0.3125 | 50 | 0.0719 | - |
148
+ | 0.625 | 100 | 0.0874 | - |
149
+ | 0.9375 | 150 | 0.1192 | - |
150
+
151
+ ### Framework Versions
152
+ - Python: 3.10.12
153
+ - SetFit: 1.0.3
154
+ - Sentence Transformers: 2.7.0
155
+ - Transformers: 4.40.0
156
+ - PyTorch: 2.2.1+cu121
157
+ - Datasets: 2.19.0
158
+ - Tokenizers: 0.19.1
159
+
160
+ ## Citation
161
+
162
+ ### BibTeX
163
+ ```bibtex
164
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
165
+ doi = {10.48550/ARXIV.2209.11055},
166
+ url = {https://arxiv.org/abs/2209.11055},
167
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
168
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
169
+ title = {Efficient Few-Shot Learning Without Prompts},
170
+ publisher = {arXiv},
171
+ year = {2022},
172
+ copyright = {Creative Commons Attribution 4.0 International}
173
+ }
174
+ ```
175
+
176
+ <!--
177
+ ## Glossary
178
+
179
+ *Clearly define terms in order to be accessible across audiences.*
180
+ -->
181
+
182
+ <!--
183
+ ## Model Card Authors
184
+
185
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
186
+ -->
187
+
188
+ <!--
189
+ ## Model Card Contact
190
+
191
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
192
+ -->
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.0",
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
+ "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:1326f573ef15a054d8ed308bb12084ced58d2dc3e2bac846b221a7bb1dc23396
3
+ size 437967672
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:b10f4d7b327d09515d7f71e3cdf0050e55ba674233be2923b871a0f88739413a
3
+ size 52836
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