hojzas commited on
Commit
be7b558
1 Parent(s): aaed440

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,211 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ library_name: setfit
3
+ tags:
4
+ - setfit
5
+ - sentence-transformers
6
+ - text-classification
7
+ - generated_from_setfit_trainer
8
+ datasets:
9
+ - hojzas/proj8-lab2
10
+ metrics:
11
+ - accuracy
12
+ widget:
13
+ - text: 'def first_with_given_key(iterable, key=lambda x: x):\n keys_used = {}\n for
14
+ item in iterable:\n rp = repr(key(item))\n if rp not in keys_used.keys():\n keys_used[rp]
15
+ = repr(item)\n yield item'
16
+ - text: 'def first_with_given_key(iterable, key=lambda x: x):\n keys=[]\n for
17
+ i in iterable:\n if key(i) not in keys:\n yield i\n keys.append(key(i))'
18
+ - text: 'def first_with_given_key(lst, key = lambda x: x):\n res = set()\n for
19
+ i in lst:\n if repr(key(i)) not in res:\n res.add(repr(key(i)))\n yield
20
+ i'
21
+ - text: def first_with_given_key(iterable, key=repr):\n used_keys = dict()\n get_key
22
+ = return_key(key)\n for index in iterable:\n index_key = get_key(index)\n if
23
+ index_key in used_keys.keys():\n continue\n try:\n used_keys[hash(index_key)]
24
+ = repr(index)\n except TypeError:\n used_keys[repr(index_key)]
25
+ = repr(index)\n yield index
26
+ - text: 'def first_with_given_key(the_iterable, key=lambda x: x):\n temp_keys=[]\n for
27
+ i in range(len(the_iterable)):\n if (key(the_iterable[i]) not in temp_keys):\n temp_keys.append(key(the_iterable[i]))\n yield
28
+ the_iterable[i]\n del temp_keys'
29
+ pipeline_tag: text-classification
30
+ inference: true
31
+ co2_eq_emissions:
32
+ emissions: 2.099245090500422
33
+ source: codecarbon
34
+ training_type: fine-tuning
35
+ on_cloud: false
36
+ cpu_model: Intel(R) Xeon(R) Silver 4314 CPU @ 2.40GHz
37
+ ram_total_size: 251.49161911010742
38
+ hours_used: 0.006
39
+ hardware_used: 4 x NVIDIA RTX A5000
40
+ base_model: sentence-transformers/all-mpnet-base-v2
41
+ ---
42
+
43
+ # SetFit with sentence-transformers/all-mpnet-base-v2
44
+
45
+ This is a [SetFit](https://github.com/huggingface/setfit) model trained on the [hojzas/proj8-lab2](https://huggingface.co/datasets/hojzas/proj8-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.
46
+
47
+ The model has been trained using an efficient few-shot learning technique that involves:
48
+
49
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
50
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
51
+
52
+ ## Model Details
53
+
54
+ ### Model Description
55
+ - **Model Type:** SetFit
56
+ - **Sentence Transformer body:** [sentence-transformers/all-mpnet-base-v2](https://huggingface.co/sentence-transformers/all-mpnet-base-v2)
57
+ - **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
58
+ - **Maximum Sequence Length:** 384 tokens
59
+ - **Number of Classes:** 3 classes
60
+ - **Training Dataset:** [hojzas/proj8-lab2](https://huggingface.co/datasets/hojzas/proj8-lab2)
61
+ <!-- - **Language:** Unknown -->
62
+ <!-- - **License:** Unknown -->
63
+
64
+ ### Model Sources
65
+
66
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
67
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
68
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
69
+
70
+ ### Model Labels
71
+ | Label | Examples |
72
+ |:------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
73
+ | 0 | <ul><li>'def first_with_given_key(iterable, key=lambda x: x):\\n keys_in_list = []\\n for it in iterable:\\n if key(it) not in keys_in_list:\\n keys_in_list.append(key(it))\\n yield it'</li><li>'def first_with_given_key(iterable, key=lambda value: value):\\n it = iter(iterable)\\n saved_keys = []\\n while True:\\n try:\\n value = next(it)\\n if key(value) not in saved_keys:\\n saved_keys.append(key(value))\\n yield value\\n except StopIteration:\\n break'</li><li>'def first_with_given_key(iterable, key=None):\\n if key is None:\\n key = lambda x: x\\n item_list = []\\n key_set = set()\\n for item in iterable:\\n generated_item = key(item)\\n if generated_item not in item_list:\\n item_list.append(generated_item)\\n yield item'</li></ul> |
74
+ | 2 | <ul><li>'def first_with_given_key(iterable, key=repr):\\n prev_keys = {}\\n lamb_key = lambda item: key(item)\\n for obj in iterable:\\n obj_key = lamb_key(obj)\\n if(obj_key) in prev_keys.keys():\\n continue\\n try:\\n prev_keys[hash(obj_key)] = repr(obj)\\n except TypeError:\\n prev_keys[repr(obj_key)] = repr(obj)\\n yield obj'</li><li>'def first_with_given_key(iterable, key=repr):\\n used_keys = dict()\\n get_key = lambda index: key(index)\\n for index in iterable:\\n index_key = get_key(index)\\n if index_key in used_keys.keys():\\n continue\\n try:\\n used_keys[hash(index_key)] = repr(index)\\n except TypeError:\\n used_keys[repr(index_key)] = repr(index)\\n yield index'</li><li>'def first_with_given_key(iterable, key=lambda x: x):\\n keys_used = {}\\n for item in iterable:\\n rp = repr(key(item))\\n if rp not in keys_used.keys():\\n keys_used[rp] = repr(item)\\n yield item'</li></ul> |
75
+ | 1 | <ul><li>'def first_with_given_key(lst, key = lambda x: x):\\n res = set()\\n for i in lst:\\n if repr(key(i)) not in res:\\n res.add(repr(key(i)))\\n yield i'</li><li>'def first_with_given_key(iterable, key=repr):\\n set_of_keys = set()\\n lambda_key = (lambda x: key(x))\\n for item in iterable:\\n key = lambda_key(item)\\n try:\\n key_for_set = hash(key)\\n except TypeError:\\n key_for_set = repr(key)\\n if key_for_set in set_of_keys:\\n continue\\n set_of_keys.add(key_for_set)\\n yield item'</li><li>'def first_with_given_key(iterable, key=None):\\n if key is None:\\n key = identity\\n appeared_keys = set()\\n for item in iterable:\\n generated_key = key(item)\\n if not generated_key.__hash__:\\n generated_key = repr(generated_key)\\n if generated_key not in appeared_keys:\\n appeared_keys.add(generated_key)\\n yield item'</li></ul> |
76
+
77
+ ## Uses
78
+
79
+ ### Direct Use for Inference
80
+
81
+ First install the SetFit library:
82
+
83
+ ```bash
84
+ pip install setfit
85
+ ```
86
+
87
+ Then you can load this model and run inference.
88
+
89
+ ```python
90
+ from setfit import SetFitModel
91
+
92
+ # Download from the 🤗 Hub
93
+ model = SetFitModel.from_pretrained("hojzas/proj8-lab2")
94
+ # Run inference
95
+ preds = model("def first_with_given_key(iterable, key=lambda x: x):\n keys=[]\n for i in iterable:\n if key(i) not in keys:\n yield i\n keys.append(key(i))")
96
+ ```
97
+
98
+ <!--
99
+ ### Downstream Use
100
+
101
+ *List how someone could finetune this model on their own dataset.*
102
+ -->
103
+
104
+ <!--
105
+ ### Out-of-Scope Use
106
+
107
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
108
+ -->
109
+
110
+ <!--
111
+ ## Bias, Risks and Limitations
112
+
113
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
114
+ -->
115
+
116
+ <!--
117
+ ### Recommendations
118
+
119
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
120
+ -->
121
+
122
+ ## Training Details
123
+
124
+ ### Training Set Metrics
125
+ | Training set | Min | Median | Max |
126
+ |:-------------|:----|:--------|:----|
127
+ | Word count | 43 | 92.2069 | 125 |
128
+
129
+ | Label | Training Sample Count |
130
+ |:------|:----------------------|
131
+ | 0 | 13 |
132
+ | 1 | 8 |
133
+ | 2 | 8 |
134
+
135
+ ### Training Hyperparameters
136
+ - batch_size: (16, 16)
137
+ - num_epochs: (1, 1)
138
+ - max_steps: -1
139
+ - sampling_strategy: oversampling
140
+ - num_iterations: 20
141
+ - body_learning_rate: (2e-05, 2e-05)
142
+ - head_learning_rate: 2e-05
143
+ - loss: CosineSimilarityLoss
144
+ - distance_metric: cosine_distance
145
+ - margin: 0.25
146
+ - end_to_end: False
147
+ - use_amp: False
148
+ - warmup_proportion: 0.1
149
+ - seed: 42
150
+ - eval_max_steps: -1
151
+ - load_best_model_at_end: False
152
+
153
+ ### Training Results
154
+ | Epoch | Step | Training Loss | Validation Loss |
155
+ |:------:|:----:|:-------------:|:---------------:|
156
+ | 0.0137 | 1 | 0.4142 | - |
157
+ | 0.6849 | 50 | 0.0024 | - |
158
+
159
+ ### Environmental Impact
160
+ Carbon emissions were measured using [CodeCarbon](https://github.com/mlco2/codecarbon).
161
+ - **Carbon Emitted**: 0.002 kg of CO2
162
+ - **Hours Used**: 0.006 hours
163
+
164
+ ### Training Hardware
165
+ - **On Cloud**: No
166
+ - **GPU Model**: 4 x NVIDIA RTX A5000
167
+ - **CPU Model**: Intel(R) Xeon(R) Silver 4314 CPU @ 2.40GHz
168
+ - **RAM Size**: 251.49 GB
169
+
170
+ ### Framework Versions
171
+ - Python: 3.10.12
172
+ - SetFit: 1.0.3
173
+ - Sentence Transformers: 2.2.2
174
+ - Transformers: 4.36.1
175
+ - PyTorch: 2.1.2+cu121
176
+ - Datasets: 2.14.7
177
+ - Tokenizers: 0.15.1
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": "/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
+ "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:3900270cbef096a79eb75e1e03078fd4cf7c9c5378731a9ce192cc0ba458a1fb
3
+ size 437967672
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:6084e1ff38ffc5d2bcac6ad62745bb038d150b5c31d2da97291f1eb623f07e04
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