johnpaulbin commited on
Commit
8ccb323
·
verified ·
1 Parent(s): 0500c7f

Add SetFit model

Browse files
.gitattributes CHANGED
@@ -33,3 +33,5 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
33
  *.zip filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
 
 
 
33
  *.zip filter=lfs diff=lfs merge=lfs -text
34
  *.zst filter=lfs diff=lfs merge=lfs -text
35
  *tfevents* filter=lfs diff=lfs merge=lfs -text
36
+ tokenizer.json filter=lfs diff=lfs merge=lfs -text
37
+ unigram.json filter=lfs diff=lfs merge=lfs -text
1_Pooling/config.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "word_embedding_dimension": 384,
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,225 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ tags:
3
+ - setfit
4
+ - sentence-transformers
5
+ - text-classification
6
+ - generated_from_setfit_trainer
7
+ widget:
8
+ - text: '
9
+
10
+ Ex-Labour Bennite in X detox. Pro-planet, anti-capitalist.'
11
+ - text: jan o lukin ala e pilin sina.
12
+ - text: Nothing…I’m just loudly complaining, I’ll get over it tomorrow.
13
+ - text: IDIOT
14
+ - text: Pizza cutter 2
15
+ metrics:
16
+ - accuracy
17
+ pipeline_tag: text-classification
18
+ library_name: setfit
19
+ inference: true
20
+ base_model: sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2
21
+ model-index:
22
+ - name: SetFit with sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2
23
+ results:
24
+ - task:
25
+ type: text-classification
26
+ name: Text Classification
27
+ dataset:
28
+ name: Unknown
29
+ type: unknown
30
+ split: test
31
+ metrics:
32
+ - type: accuracy
33
+ value: 1.0
34
+ name: Accuracy
35
+ ---
36
+
37
+ # SetFit with sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2
38
+
39
+ This is a [SetFit](https://github.com/huggingface/setfit) model that can be used for Text Classification. This SetFit model uses [sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2](https://huggingface.co/sentence-transformers/paraphrase-multilingual-MiniLM-L12-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.
40
+
41
+ The model has been trained using an efficient few-shot learning technique that involves:
42
+
43
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
44
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
45
+
46
+ ## Model Details
47
+
48
+ ### Model Description
49
+ - **Model Type:** SetFit
50
+ - **Sentence Transformer body:** [sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2](https://huggingface.co/sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2)
51
+ - **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
52
+ - **Maximum Sequence Length:** 128 tokens
53
+ - **Number of Classes:** 2 classes
54
+ <!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
55
+ <!-- - **Language:** Unknown -->
56
+ <!-- - **License:** Unknown -->
57
+
58
+ ### Model Sources
59
+
60
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
61
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
62
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
63
+
64
+ ### Model Labels
65
+ | Label | Examples |
66
+ |:----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
67
+ | toki pona | <ul><li>'ona li toki "toki" tawa meli.'</li><li>'toki li pona tawa mi.'</li><li>'mi toki e ni tawa ona: "o kama tawa tomo mi."'</li></ul> |
68
+ | other | <ul><li>'No te puedo creer el grado de precisión 🤣'</li><li>'i can’t deny i’m invested in the gaiartemis aspect of things :’)'</li><li>"I'm live on #twitch, and speedrunning EarthBound!\r\n\r\nhttps://twitch.tv/lordtacoTV "</li></ul> |
69
+
70
+ ## Evaluation
71
+
72
+ ### Metrics
73
+ | Label | Accuracy |
74
+ |:--------|:---------|
75
+ | **all** | 1.0 |
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("johnpaulbin/toki-pona-classifier-v2")
94
+ # Run inference
95
+ preds = model("IDIOT")
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 | 1 | 10.5705 | 61 |
128
+
129
+ | Label | Training Sample Count |
130
+ |:----------|:----------------------|
131
+ | other | 2035 |
132
+ | toki pona | 2000 |
133
+
134
+ ### Training Hyperparameters
135
+ - batch_size: (12, 12)
136
+ - num_epochs: (2, 2)
137
+ - max_steps: -1
138
+ - sampling_strategy: oversampling
139
+ - num_iterations: 1
140
+ - body_learning_rate: (2e-05, 1e-05)
141
+ - head_learning_rate: 0.01
142
+ - loss: CosineSimilarityLoss
143
+ - distance_metric: cosine_distance
144
+ - margin: 0.25
145
+ - end_to_end: False
146
+ - use_amp: False
147
+ - warmup_proportion: 0.1
148
+ - l2_weight: 0.01
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.0015 | 1 | 0.3252 | - |
157
+ | 0.0743 | 50 | 0.2704 | - |
158
+ | 0.1486 | 100 | 0.2257 | - |
159
+ | 0.2229 | 150 | 0.0567 | - |
160
+ | 0.2972 | 200 | 0.0063 | - |
161
+ | 0.3715 | 250 | 0.0015 | - |
162
+ | 0.4458 | 300 | 0.0034 | - |
163
+ | 0.5201 | 350 | 0.0026 | - |
164
+ | 0.5944 | 400 | 0.0036 | - |
165
+ | 0.6686 | 450 | 0.0005 | - |
166
+ | 0.7429 | 500 | 0.0021 | - |
167
+ | 0.8172 | 550 | 0.0021 | - |
168
+ | 0.8915 | 600 | 0.0003 | - |
169
+ | 0.9658 | 650 | 0.0002 | - |
170
+ | 1.0401 | 700 | 0.0002 | - |
171
+ | 1.1144 | 750 | 0.0018 | - |
172
+ | 1.1887 | 800 | 0.0003 | - |
173
+ | 1.2630 | 850 | 0.0002 | - |
174
+ | 1.3373 | 900 | 0.0001 | - |
175
+ | 1.4116 | 950 | 0.0015 | - |
176
+ | 1.4859 | 1000 | 0.0004 | - |
177
+ | 1.5602 | 1050 | 0.0001 | - |
178
+ | 1.6345 | 1100 | 0.0001 | - |
179
+ | 1.7088 | 1150 | 0.0019 | - |
180
+ | 1.7831 | 1200 | 0.0001 | - |
181
+ | 1.8574 | 1250 | 0.0001 | - |
182
+ | 1.9316 | 1300 | 0.0001 | - |
183
+
184
+ ### Framework Versions
185
+ - Python: 3.10.12
186
+ - SetFit: 1.1.0
187
+ - Sentence Transformers: 3.2.1
188
+ - Transformers: 4.42.2
189
+ - PyTorch: 2.5.1+cu121
190
+ - Datasets: 3.1.0
191
+ - Tokenizers: 0.19.1
192
+
193
+ ## Citation
194
+
195
+ ### BibTeX
196
+ ```bibtex
197
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
198
+ doi = {10.48550/ARXIV.2209.11055},
199
+ url = {https://arxiv.org/abs/2209.11055},
200
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
201
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
202
+ title = {Efficient Few-Shot Learning Without Prompts},
203
+ publisher = {arXiv},
204
+ year = {2022},
205
+ copyright = {Creative Commons Attribution 4.0 International}
206
+ }
207
+ ```
208
+
209
+ <!--
210
+ ## Glossary
211
+
212
+ *Clearly define terms in order to be accessible across audiences.*
213
+ -->
214
+
215
+ <!--
216
+ ## Model Card Authors
217
+
218
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
219
+ -->
220
+
221
+ <!--
222
+ ## Model Card Contact
223
+
224
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
225
+ -->
config.json ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2",
3
+ "architectures": [
4
+ "BertModel"
5
+ ],
6
+ "attention_probs_dropout_prob": 0.1,
7
+ "classifier_dropout": null,
8
+ "gradient_checkpointing": false,
9
+ "hidden_act": "gelu",
10
+ "hidden_dropout_prob": 0.1,
11
+ "hidden_size": 384,
12
+ "initializer_range": 0.02,
13
+ "intermediate_size": 1536,
14
+ "layer_norm_eps": 1e-12,
15
+ "max_position_embeddings": 512,
16
+ "model_type": "bert",
17
+ "num_attention_heads": 12,
18
+ "num_hidden_layers": 12,
19
+ "pad_token_id": 0,
20
+ "position_embedding_type": "absolute",
21
+ "torch_dtype": "float32",
22
+ "transformers_version": "4.42.2",
23
+ "type_vocab_size": 2,
24
+ "use_cache": true,
25
+ "vocab_size": 250037
26
+ }
config_sentence_transformers.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "sentence_transformers": "3.2.1",
4
+ "transformers": "4.42.2",
5
+ "pytorch": "2.5.1+cu121"
6
+ },
7
+ "prompts": {},
8
+ "default_prompt_name": null,
9
+ "similarity_fn_name": null
10
+ }
config_setfit.json ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ {
2
+ "normalize_embeddings": false,
3
+ "labels": [
4
+ "other",
5
+ "toki pona"
6
+ ]
7
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:4cec98bfce704ae36f8d127fd702d412796e243cddd4e2cc75c0d74703d98947
3
+ size 470637416
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:86f6e34f30092391f76eb47cf06ff84aada46abf44b75f3721dea99106ed0212
3
+ size 3999
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": 128,
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
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:cad551d5600a84242d0973327029452a1e3672ba6313c2a3c3d69c4310e12719
3
+ size 17082987
tokenizer_config.json ADDED
@@ -0,0 +1,64 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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": false,
31
+ "rstrip": false,
32
+ "single_word": false,
33
+ "special": true
34
+ },
35
+ "250001": {
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_lower_case": true,
48
+ "eos_token": "</s>",
49
+ "mask_token": "<mask>",
50
+ "max_length": 128,
51
+ "model_max_length": 128,
52
+ "pad_to_multiple_of": null,
53
+ "pad_token": "<pad>",
54
+ "pad_token_type_id": 0,
55
+ "padding_side": "right",
56
+ "sep_token": "</s>",
57
+ "stride": 0,
58
+ "strip_accents": null,
59
+ "tokenize_chinese_chars": true,
60
+ "tokenizer_class": "BertTokenizer",
61
+ "truncation_side": "right",
62
+ "truncation_strategy": "longest_first",
63
+ "unk_token": "<unk>"
64
+ }
unigram.json ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:da145b5e7700ae40f16691ec32a0b1fdc1ee3298db22a31ea55f57a966c4a65d
3
+ size 14763260