reecursion commited on
Commit
6f71863
1 Parent(s): 7625dc2

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,211 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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: He is Male, his heart rate is 70, he walks 8700 steps daily, and is Normal
12
+ Weight. He slept at 23 hrs. Yesterday, he slept from 23hrs to 7 hrs, with a duration
13
+ of 580 minutes and 4 interruptions. The day before yesterday, he slept from 22
14
+ hrs to 6 hrs, with a duration of 490 minutes and 2 interruptions.
15
+ - text: She is Female, her heart rate is 87, she walks 5300 steps daily and is Overweight.
16
+ She slept at 22 hrs. Yesterday, she slept from 21 hrs to 6 hrs, with a duration
17
+ of 510 minutes and 5 interruptions. The day before yesterday, she slept from 21
18
+ hrs to 6 hrs, with a duration of 410 minutes and 3 interruptions.
19
+ - text: She is Female, her heart rate is 83, she walks 4700 steps daily and is Overweight.
20
+ She slept at 22 hrs. Yesterday, she slept from 21 hrs to 6 hrs, with a duration
21
+ of 490 minutes and 5 interruptions. The day before yesterday, she slept from 21
22
+ hrs to 5 hrs, with a duration of 390 minutes and 2 interruptions.
23
+ - text: She is Female, her heart rate is 87, she walks 5700 steps daily and is Overweight.
24
+ She slept at 22 hrs. Yesterday, she slept from 21 hrs to 6 hrs, with a duration
25
+ of 540 minutes and 5 interruptions. The day before yesterday, she slept from 21
26
+ hrs to 6 hrs, with a duration of 430 minutes and 3 interruptions.
27
+ - text: She is Female, her heart rate is 85, she walks 5400 steps daily and is Overweight.
28
+ She slept at 22 hrs. Yesterday, she slept from 21 hrs to 6 hrs, with a duration
29
+ of 530 minutes and 5 interruptions. The day before yesterday, she slept from 21
30
+ hrs to 5 hrs, with a duration of 400 minutes and 2 interruptions.
31
+ pipeline_tag: text-classification
32
+ inference: true
33
+ base_model: sentence-transformers/paraphrase-mpnet-base-v2
34
+ model-index:
35
+ - name: SetFit with sentence-transformers/paraphrase-mpnet-base-v2
36
+ results:
37
+ - task:
38
+ type: text-classification
39
+ name: Text Classification
40
+ dataset:
41
+ name: Unknown
42
+ type: unknown
43
+ split: test
44
+ metrics:
45
+ - type: accuracy
46
+ value: 0.8235294117647058
47
+ name: Accuracy
48
+ ---
49
+
50
+ # SetFit with sentence-transformers/paraphrase-mpnet-base-v2
51
+
52
+ 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.
53
+
54
+ The model has been trained using an efficient few-shot learning technique that involves:
55
+
56
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
57
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
58
+
59
+ ## Model Details
60
+
61
+ ### Model Description
62
+ - **Model Type:** SetFit
63
+ - **Sentence Transformer body:** [sentence-transformers/paraphrase-mpnet-base-v2](https://huggingface.co/sentence-transformers/paraphrase-mpnet-base-v2)
64
+ - **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
65
+ - **Maximum Sequence Length:** 512 tokens
66
+ - **Number of Classes:** 2 classes
67
+ <!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
68
+ <!-- - **Language:** Unknown -->
69
+ <!-- - **License:** Unknown -->
70
+
71
+ ### Model Sources
72
+
73
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
74
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
75
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
76
+
77
+ ### Model Labels
78
+ | Label | Examples |
79
+ |:------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
80
+ | 0 | <ul><li>'He is Male, his heart rate is 64, he walks 10000 steps daily, and is Normal Weight. He slept at 23 hrs. Yesterday, he slept from 2hrs to 10 hrs, with a duration of 480 minutes and 3 interruptions. The day before yesterday, he slept from 4 hrs to 6 hrs, with a duration of 120 minutes and 1 interruptions.'</li><li>'He is Male, his heart rate is 68, he walks 12000 steps daily, and is Normal Weight. He slept at 22 hrs. Yesterday, he slept from 22hrs to 6 hrs, with a duration of 510 minutes and 3 interruptions. The day before yesterday, he slept from 21 hrs to 6 hrs, with a duration of 420 minutes and 1 interruptions.'</li><li>'He is Male, his heart rate is 75, he walks 9000 steps daily, and is Normal Weight. He slept at 23 hrs. Yesterday, he slept from 23hrs to 7 hrs, with a duration of 510 minutes and 4 interruptions. The day before yesterday, he slept from 22 hrs to 6 hrs, with a duration of 420 minutes and 2 interruptions.'</li></ul> |
81
+ | 1 | <ul><li>'She is Female, her heart rate is 89, she walks 3873 steps daily and is Overweight. She slept at 23 hrs. Yesterday, she slept from 23 hrs to 7 hrs, with a duration of 472 minutes and 5 interruptions. The day before yesterday, she slept from 23 hrs to 5 hrs, with a duration of 344 minutes and 6 interruptions.'</li><li>'She is Female, her heart rate is 66, she walks 2413 steps daily and is Underweight. She slept at 2 hrs. Yesterday, she slept from 4 hrs to 6 hrs, with a duration of 120 minutes and 1 interruptions. The day before yesterday, she slept from 4 hrs to 9 hrs, with a duration of 300 minutes and 2 interruptions.'</li><li>'He is Male, his heart rate is 72, he walks 7500 steps daily, and is Normal Weight. He slept at 22 hrs. Yesterday, he slept from 22hrs to 6 hrs, with a duration of 450 minutes and 4 interruptions. The day before yesterday, he slept from 21 hrs to 6 hrs, with a duration of 390 minutes and 2 interruptions.'</li></ul> |
82
+
83
+ ## Evaluation
84
+
85
+ ### Metrics
86
+ | Label | Accuracy |
87
+ |:--------|:---------|
88
+ | **all** | 0.8235 |
89
+
90
+ ## Uses
91
+
92
+ ### Direct Use for Inference
93
+
94
+ First install the SetFit library:
95
+
96
+ ```bash
97
+ pip install setfit
98
+ ```
99
+
100
+ Then you can load this model and run inference.
101
+
102
+ ```python
103
+ from setfit import SetFitModel
104
+
105
+ # Download from the 🤗 Hub
106
+ model = SetFitModel.from_pretrained("reecursion/few-shot-stress-detection")
107
+ # Run inference
108
+ preds = model("He is Male, his heart rate is 70, he walks 8700 steps daily, and is Normal Weight. He slept at 23 hrs. Yesterday, he slept from 23hrs to 7 hrs, with a duration of 580 minutes and 4 interruptions. The day before yesterday, he slept from 22 hrs to 6 hrs, with a duration of 490 minutes and 2 interruptions.")
109
+ ```
110
+
111
+ <!--
112
+ ### Downstream Use
113
+
114
+ *List how someone could finetune this model on their own dataset.*
115
+ -->
116
+
117
+ <!--
118
+ ### Out-of-Scope Use
119
+
120
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
121
+ -->
122
+
123
+ <!--
124
+ ## Bias, Risks and Limitations
125
+
126
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
127
+ -->
128
+
129
+ <!--
130
+ ### Recommendations
131
+
132
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
133
+ -->
134
+
135
+ ## Training Details
136
+
137
+ ### Training Set Metrics
138
+ | Training set | Min | Median | Max |
139
+ |:-------------|:----|:-------|:----|
140
+ | Word count | 60 | 60.0 | 60 |
141
+
142
+ | Label | Training Sample Count |
143
+ |:------|:----------------------|
144
+ | 0 | 3 |
145
+ | 1 | 5 |
146
+
147
+ ### Training Hyperparameters
148
+ - batch_size: (16, 16)
149
+ - num_epochs: (1, 1)
150
+ - max_steps: -1
151
+ - sampling_strategy: oversampling
152
+ - num_iterations: 20
153
+ - body_learning_rate: (2e-05, 2e-05)
154
+ - head_learning_rate: 2e-05
155
+ - loss: CosineSimilarityLoss
156
+ - distance_metric: cosine_distance
157
+ - margin: 0.25
158
+ - end_to_end: False
159
+ - use_amp: False
160
+ - warmup_proportion: 0.1
161
+ - seed: 42
162
+ - eval_max_steps: -1
163
+ - load_best_model_at_end: False
164
+
165
+ ### Training Results
166
+ | Epoch | Step | Training Loss | Validation Loss |
167
+ |:-----:|:----:|:-------------:|:---------------:|
168
+ | 0.05 | 1 | 0.4058 | - |
169
+
170
+ ### Framework Versions
171
+ - Python: 3.10.12
172
+ - SetFit: 1.0.3
173
+ - Sentence Transformers: 2.5.1
174
+ - Transformers: 4.38.2
175
+ - PyTorch: 2.2.1+cu121
176
+ - Datasets: 2.18.0
177
+ - Tokenizers: 0.15.2
178
+
179
+ ## Citation
180
+
181
+ ### BibTeX
182
+ ```bibtex
183
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
184
+ doi = {10.48550/ARXIV.2209.11055},
185
+ url = {https://arxiv.org/abs/2209.11055},
186
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
187
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
188
+ title = {Efficient Few-Shot Learning Without Prompts},
189
+ publisher = {arXiv},
190
+ year = {2022},
191
+ copyright = {Creative Commons Attribution 4.0 International}
192
+ }
193
+ ```
194
+
195
+ <!--
196
+ ## Glossary
197
+
198
+ *Clearly define terms in order to be accessible across audiences.*
199
+ -->
200
+
201
+ <!--
202
+ ## Model Card Authors
203
+
204
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
205
+ -->
206
+
207
+ <!--
208
+ ## Model Card Contact
209
+
210
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
211
+ -->
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.38.2",
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:c28086f4c32e69f86f958c932a2ecf04e471002bf26d158d1c5dd7eba34843dc
3
+ size 437967672
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:52e7673808b78123771f30e8f5b89750df074cfccf591baa5f7b618ad2ed4398
3
+ size 7007
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