hojzas commited on
Commit
489a8ff
1 Parent(s): e85ecb4

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,202 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ library_name: setfit
3
+ tags:
4
+ - setfit
5
+ - sentence-transformers
6
+ - text-classification
7
+ - generated_from_setfit_trainer
8
+ datasets:
9
+ - hojzas/proj4-uniq_srt-lab2
10
+ metrics:
11
+ - accuracy
12
+ widget:
13
+ - text: return sorted(list(dict.fromkeys(it).keys()))
14
+ - text: " uniq_list = list(set(it))\n uniq_list.sort()\n return uniq_list"
15
+ - text: "it=sorted(set(list(it)))\n return it"
16
+ - text: " sequence_list = list(it)\n unique_list = list(set(sequence_list))\n\
17
+ \ sorted_list = sorted(unique_list, reverse=False)\n return sorted_list"
18
+ - text: return list(dict.fromkeys(sorted(it)))
19
+ pipeline_tag: text-classification
20
+ inference: true
21
+ co2_eq_emissions:
22
+ emissions: 0.7119941051678922
23
+ source: codecarbon
24
+ training_type: fine-tuning
25
+ on_cloud: false
26
+ cpu_model: Intel(R) Xeon(R) Silver 4314 CPU @ 2.40GHz
27
+ ram_total_size: 251.49161911010742
28
+ hours_used: 0.003
29
+ hardware_used: 4 x NVIDIA RTX A5000
30
+ base_model: sentence-transformers/all-mpnet-base-v2
31
+ ---
32
+
33
+ # SetFit with sentence-transformers/all-mpnet-base-v2
34
+
35
+ This is a [SetFit](https://github.com/huggingface/setfit) model trained on the [hojzas/proj4-uniq_srt-lab2](https://huggingface.co/datasets/hojzas/proj4-uniq_srt-lab2) dataset that can be used for Text Classification. This SetFit model uses [sentence-transformers/all-mpnet-base-v2](https://huggingface.co/sentence-transformers/all-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.
36
+
37
+ The model has been trained using an efficient few-shot learning technique that involves:
38
+
39
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
40
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
41
+
42
+ ## Model Details
43
+
44
+ ### Model Description
45
+ - **Model Type:** SetFit
46
+ - **Sentence Transformer body:** [sentence-transformers/all-mpnet-base-v2](https://huggingface.co/sentence-transformers/all-mpnet-base-v2)
47
+ - **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
48
+ - **Maximum Sequence Length:** 384 tokens
49
+ - **Number of Classes:** 3 classes
50
+ - **Training Dataset:** [hojzas/proj4-uniq_srt-lab2](https://huggingface.co/datasets/hojzas/proj4-uniq_srt-lab2)
51
+ <!-- - **Language:** Unknown -->
52
+ <!-- - **License:** Unknown -->
53
+
54
+ ### Model Sources
55
+
56
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
57
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
58
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
59
+
60
+ ### Model Labels
61
+ | Label | Examples |
62
+ |:------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
63
+ | 0 | <ul><li>' it = list(dict.fromkeys(it))\n it.sort()\n return it'</li><li>' sequence = []\n for i in it:\n if i in sequence:\n pass\n else:\n sequence.append(i)\n sequence.sort()\n return sequence'</li><li>' unique = list(set(it))\n unique.sort()\n return unique'</li></ul> |
64
+ | 2 | <ul><li>'return sorted(list({word : it.count(word) for (word) in set(it)}.keys())) '</li><li>'return list(dict.fromkeys(sorted(it)))'</li><li>'return sorted((list(dict.fromkeys(it)))) '</li></ul> |
65
+ | 1 | <ul><li>' unique_items = set(it)\n return sorted(list(unique_items))'</li><li>' letters = set(it)\n sorted_letters = sorted(letters)\n return sorted_letters'</li><li>'return list(sorted(set(it)))'</li></ul> |
66
+
67
+ ## Uses
68
+
69
+ ### Direct Use for Inference
70
+
71
+ First install the SetFit library:
72
+
73
+ ```bash
74
+ pip install setfit
75
+ ```
76
+
77
+ Then you can load this model and run inference.
78
+
79
+ ```python
80
+ from setfit import SetFitModel
81
+
82
+ # Download from the 🤗 Hub
83
+ model = SetFitModel.from_pretrained("hojzas/proj4-uniq_srt-lab2")
84
+ # Run inference
85
+ preds = model("it=sorted(set(list(it)))
86
+ return it")
87
+ ```
88
+
89
+ <!--
90
+ ### Downstream Use
91
+
92
+ *List how someone could finetune this model on their own dataset.*
93
+ -->
94
+
95
+ <!--
96
+ ### Out-of-Scope Use
97
+
98
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
99
+ -->
100
+
101
+ <!--
102
+ ## Bias, Risks and Limitations
103
+
104
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
105
+ -->
106
+
107
+ <!--
108
+ ### Recommendations
109
+
110
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
111
+ -->
112
+
113
+ ## Training Details
114
+
115
+ ### Training Set Metrics
116
+ | Training set | Min | Median | Max |
117
+ |:-------------|:----|:--------|:----|
118
+ | Word count | 2 | 20.7778 | 117 |
119
+
120
+ | Label | Training Sample Count |
121
+ |:------|:----------------------|
122
+ | 0 | 10 |
123
+ | 1 | 9 |
124
+ | 2 | 8 |
125
+
126
+ ### Training Hyperparameters
127
+ - batch_size: (16, 16)
128
+ - num_epochs: (1, 1)
129
+ - max_steps: -1
130
+ - sampling_strategy: oversampling
131
+ - num_iterations: 20
132
+ - body_learning_rate: (2e-05, 2e-05)
133
+ - head_learning_rate: 2e-05
134
+ - loss: CosineSimilarityLoss
135
+ - distance_metric: cosine_distance
136
+ - margin: 0.25
137
+ - end_to_end: False
138
+ - use_amp: False
139
+ - warmup_proportion: 0.1
140
+ - seed: 42
141
+ - eval_max_steps: -1
142
+ - load_best_model_at_end: False
143
+
144
+ ### Training Results
145
+ | Epoch | Step | Training Loss | Validation Loss |
146
+ |:------:|:----:|:-------------:|:---------------:|
147
+ | 0.0147 | 1 | 0.2285 | - |
148
+ | 0.7353 | 50 | 0.0208 | - |
149
+
150
+ ### Environmental Impact
151
+ Carbon emissions were measured using [CodeCarbon](https://github.com/mlco2/codecarbon).
152
+ - **Carbon Emitted**: 0.001 kg of CO2
153
+ - **Hours Used**: 0.003 hours
154
+
155
+ ### Training Hardware
156
+ - **On Cloud**: No
157
+ - **GPU Model**: 4 x NVIDIA RTX A5000
158
+ - **CPU Model**: Intel(R) Xeon(R) Silver 4314 CPU @ 2.40GHz
159
+ - **RAM Size**: 251.49 GB
160
+
161
+ ### Framework Versions
162
+ - Python: 3.10.12
163
+ - SetFit: 1.0.3
164
+ - Sentence Transformers: 2.2.2
165
+ - Transformers: 4.36.1
166
+ - PyTorch: 2.1.2+cu121
167
+ - Datasets: 2.14.7
168
+ - Tokenizers: 0.15.1
169
+
170
+ ## Citation
171
+
172
+ ### BibTeX
173
+ ```bibtex
174
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
175
+ doi = {10.48550/ARXIV.2209.11055},
176
+ url = {https://arxiv.org/abs/2209.11055},
177
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
178
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
179
+ title = {Efficient Few-Shot Learning Without Prompts},
180
+ publisher = {arXiv},
181
+ year = {2022},
182
+ copyright = {Creative Commons Attribution 4.0 International}
183
+ }
184
+ ```
185
+
186
+ <!--
187
+ ## Glossary
188
+
189
+ *Clearly define terms in order to be accessible across audiences.*
190
+ -->
191
+
192
+ <!--
193
+ ## Model Card Authors
194
+
195
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
196
+ -->
197
+
198
+ <!--
199
+ ## Model Card Contact
200
+
201
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
202
+ -->
config.json ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "/home/xkrejc70/.cache/torch/sentence_transformers/sentence-transformers_all-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.36.1",
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.6.1",
5
+ "pytorch": "1.8.1"
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:f193600ce95571a145600a7ce34247daba7034d9939ecc2673bc47feefa073f5
3
+ size 437967672
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:583538ac416d5869f891e0003bc3fe5023d93efb7f55ac3f83312f44c6199876
3
+ size 19327
modules.json ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ {
15
+ "idx": 2,
16
+ "name": "2",
17
+ "path": "2_Normalize",
18
+ "type": "sentence_transformers.models.Normalize"
19
+ }
20
+ ]
sentence_bert_config.json ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ {
2
+ "max_seq_length": 384,
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,72 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ "3": {
28
+ "content": "<unk>",
29
+ "lstrip": false,
30
+ "normalized": true,
31
+ "rstrip": false,
32
+ "single_word": false,
33
+ "special": true
34
+ },
35
+ "104": {
36
+ "content": "[UNK]",
37
+ "lstrip": false,
38
+ "normalized": false,
39
+ "rstrip": false,
40
+ "single_word": false,
41
+ "special": true
42
+ },
43
+ "30526": {
44
+ "content": "<mask>",
45
+ "lstrip": true,
46
+ "normalized": false,
47
+ "rstrip": false,
48
+ "single_word": false,
49
+ "special": true
50
+ }
51
+ },
52
+ "bos_token": "<s>",
53
+ "clean_up_tokenization_spaces": true,
54
+ "cls_token": "<s>",
55
+ "do_lower_case": true,
56
+ "eos_token": "</s>",
57
+ "mask_token": "<mask>",
58
+ "max_length": 128,
59
+ "model_max_length": 512,
60
+ "pad_to_multiple_of": null,
61
+ "pad_token": "<pad>",
62
+ "pad_token_type_id": 0,
63
+ "padding_side": "right",
64
+ "sep_token": "</s>",
65
+ "stride": 0,
66
+ "strip_accents": null,
67
+ "tokenize_chinese_chars": true,
68
+ "tokenizer_class": "MPNetTokenizer",
69
+ "truncation_side": "right",
70
+ "truncation_strategy": "longest_first",
71
+ "unk_token": "[UNK]"
72
+ }
vocab.txt ADDED
The diff for this file is too large to render. See raw diff