an778 commited on
Commit
d3f39a1
·
verified ·
1 Parent(s): 2f97fda

Add SetFit model

Browse files
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,181 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ tags:
3
+ - setfit
4
+ - sentence-transformers
5
+ - text-classification
6
+ - generated_from_setfit_trainer
7
+ widget:
8
+ - text: caption summarizes main takeaway
9
+ - text: the caption is long so can take a little time to understand the context of
10
+ the chart
11
+ - text: Informative caption but
12
+ - text: The chart's caption is long but includes an overview of the data
13
+ - text: Although the caption is long, it expands on each of the studies making it
14
+ easier to understand the main takeaway
15
+ metrics:
16
+ - accuracy
17
+ pipeline_tag: text-classification
18
+ library_name: setfit
19
+ inference: true
20
+ base_model: sentence-transformers/all-MiniLM-L6-v2
21
+ ---
22
+
23
+ # SetFit with sentence-transformers/all-MiniLM-L6-v2
24
+
25
+ This is a [SetFit](https://github.com/huggingface/setfit) model that can be used for Text Classification. This SetFit model uses [sentence-transformers/all-MiniLM-L6-v2](https://huggingface.co/sentence-transformers/all-MiniLM-L6-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.
26
+
27
+ The model has been trained using an efficient few-shot learning technique that involves:
28
+
29
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
30
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
31
+
32
+ ## Model Details
33
+
34
+ ### Model Description
35
+ - **Model Type:** SetFit
36
+ - **Sentence Transformer body:** [sentence-transformers/all-MiniLM-L6-v2](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2)
37
+ - **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
38
+ - **Maximum Sequence Length:** 256 tokens
39
+ - **Number of Classes:** 2 classes
40
+ <!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
41
+ <!-- - **Language:** Unknown -->
42
+ <!-- - **License:** Unknown -->
43
+
44
+ ### Model Sources
45
+
46
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
47
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
48
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
49
+
50
+ ### Model Labels
51
+ | Label | Examples |
52
+ |:------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
53
+ | 0 | <ul><li>'The caption provides thorough information about the anomalies, but it can take a while to understand the context about the takeaway'</li><li>'The caption is detailed, but does not provide the clear takeaway'</li><li>'The caption provided is extensive, which is informative but it adds to the complexity'</li></ul> |
54
+ | 1 | <ul><li>'The different bars in the chart are not easy to comprehend without reading the captions'</li><li>'Although the caption is long, it expands on each of the studies making it easier to understand the main takeaway'</li><li>'The caption is informative, it also has some unnecessary information that might not be needed to interpret the charts'</li></ul> |
55
+
56
+ ## Uses
57
+
58
+ ### Direct Use for Inference
59
+
60
+ First install the SetFit library:
61
+
62
+ ```bash
63
+ pip install setfit
64
+ ```
65
+
66
+ Then you can load this model and run inference.
67
+
68
+ ```python
69
+ from setfit import SetFitModel
70
+
71
+ # Download from the 🤗 Hub
72
+ model = SetFitModel.from_pretrained("an778/sentence-transformers")
73
+ # Run inference
74
+ preds = model("Informative caption but")
75
+ ```
76
+
77
+ <!--
78
+ ### Downstream Use
79
+
80
+ *List how someone could finetune this model on their own dataset.*
81
+ -->
82
+
83
+ <!--
84
+ ### Out-of-Scope Use
85
+
86
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
87
+ -->
88
+
89
+ <!--
90
+ ## Bias, Risks and Limitations
91
+
92
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
93
+ -->
94
+
95
+ <!--
96
+ ### Recommendations
97
+
98
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
99
+ -->
100
+
101
+ ## Training Details
102
+
103
+ ### Training Set Metrics
104
+ | Training set | Min | Median | Max |
105
+ |:-------------|:----|:--------|:----|
106
+ | Word count | 3 | 11.8125 | 21 |
107
+
108
+ | Label | Training Sample Count |
109
+ |:------|:----------------------|
110
+ | 0 | 8 |
111
+ | 1 | 8 |
112
+
113
+ ### Training Hyperparameters
114
+ - batch_size: (16, 16)
115
+ - num_epochs: (4, 4)
116
+ - max_steps: -1
117
+ - sampling_strategy: oversampling
118
+ - body_learning_rate: (2e-05, 1e-05)
119
+ - head_learning_rate: 0.01
120
+ - loss: CosineSimilarityLoss
121
+ - distance_metric: cosine_distance
122
+ - margin: 0.25
123
+ - end_to_end: False
124
+ - use_amp: False
125
+ - warmup_proportion: 0.1
126
+ - l2_weight: 0.01
127
+ - seed: 42
128
+ - eval_max_steps: -1
129
+ - load_best_model_at_end: True
130
+
131
+ ### Training Results
132
+ | Epoch | Step | Training Loss | Validation Loss |
133
+ |:------:|:----:|:-------------:|:---------------:|
134
+ | 0.1111 | 1 | 0.2351 | - |
135
+ | 1.0 | 9 | - | 0.2198 |
136
+ | 2.0 | 18 | - | 0.2101 |
137
+ | 3.0 | 27 | - | 0.1996 |
138
+ | 4.0 | 36 | - | 0.1938 |
139
+
140
+ ### Framework Versions
141
+ - Python: 3.11.11
142
+ - SetFit: 1.1.2
143
+ - Sentence Transformers: 3.4.1
144
+ - Transformers: 4.50.3
145
+ - PyTorch: 2.6.0+cu124
146
+ - Datasets: 3.5.0
147
+ - Tokenizers: 0.21.1
148
+
149
+ ## Citation
150
+
151
+ ### BibTeX
152
+ ```bibtex
153
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
154
+ doi = {10.48550/ARXIV.2209.11055},
155
+ url = {https://arxiv.org/abs/2209.11055},
156
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
157
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
158
+ title = {Efficient Few-Shot Learning Without Prompts},
159
+ publisher = {arXiv},
160
+ year = {2022},
161
+ copyright = {Creative Commons Attribution 4.0 International}
162
+ }
163
+ ```
164
+
165
+ <!--
166
+ ## Glossary
167
+
168
+ *Clearly define terms in order to be accessible across audiences.*
169
+ -->
170
+
171
+ <!--
172
+ ## Model Card Authors
173
+
174
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
175
+ -->
176
+
177
+ <!--
178
+ ## Model Card Contact
179
+
180
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
181
+ -->
config.json ADDED
@@ -0,0 +1,25 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "architectures": [
3
+ "BertModel"
4
+ ],
5
+ "attention_probs_dropout_prob": 0.1,
6
+ "classifier_dropout": null,
7
+ "gradient_checkpointing": false,
8
+ "hidden_act": "gelu",
9
+ "hidden_dropout_prob": 0.1,
10
+ "hidden_size": 384,
11
+ "initializer_range": 0.02,
12
+ "intermediate_size": 1536,
13
+ "layer_norm_eps": 1e-12,
14
+ "max_position_embeddings": 512,
15
+ "model_type": "bert",
16
+ "num_attention_heads": 12,
17
+ "num_hidden_layers": 6,
18
+ "pad_token_id": 0,
19
+ "position_embedding_type": "absolute",
20
+ "torch_dtype": "float32",
21
+ "transformers_version": "4.50.3",
22
+ "type_vocab_size": 2,
23
+ "use_cache": true,
24
+ "vocab_size": 30522
25
+ }
config_sentence_transformers.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "sentence_transformers": "3.4.1",
4
+ "transformers": "4.50.3",
5
+ "pytorch": "2.6.0+cu124"
6
+ },
7
+ "prompts": {},
8
+ "default_prompt_name": null,
9
+ "similarity_fn_name": "cosine"
10
+ }
config_setfit.json ADDED
@@ -0,0 +1,7 @@
 
 
 
 
 
 
 
 
1
+ {
2
+ "labels": [
3
+ 0,
4
+ 1
5
+ ],
6
+ "normalize_embeddings": false
7
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:ab77a24647ddd258dd29a0454016c323e09523feb1be759dd72c33463b5e6571
3
+ size 90864192
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:d145f91bfa7d1b4cc5cc470af35cb7378777e4d9746a8484da63acfb656b64a6
3
+ size 3935
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": 256,
3
+ "do_lower_case": false
4
+ }
special_tokens_map.json ADDED
@@ -0,0 +1,37 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "cls_token": {
3
+ "content": "[CLS]",
4
+ "lstrip": false,
5
+ "normalized": false,
6
+ "rstrip": false,
7
+ "single_word": false
8
+ },
9
+ "mask_token": {
10
+ "content": "[MASK]",
11
+ "lstrip": false,
12
+ "normalized": false,
13
+ "rstrip": false,
14
+ "single_word": false
15
+ },
16
+ "pad_token": {
17
+ "content": "[PAD]",
18
+ "lstrip": false,
19
+ "normalized": false,
20
+ "rstrip": false,
21
+ "single_word": false
22
+ },
23
+ "sep_token": {
24
+ "content": "[SEP]",
25
+ "lstrip": false,
26
+ "normalized": false,
27
+ "rstrip": false,
28
+ "single_word": false
29
+ },
30
+ "unk_token": {
31
+ "content": "[UNK]",
32
+ "lstrip": false,
33
+ "normalized": false,
34
+ "rstrip": false,
35
+ "single_word": false
36
+ }
37
+ }
tokenizer.json ADDED
The diff for this file is too large to render. See raw diff
 
tokenizer_config.json ADDED
@@ -0,0 +1,65 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "added_tokens_decoder": {
3
+ "0": {
4
+ "content": "[PAD]",
5
+ "lstrip": false,
6
+ "normalized": false,
7
+ "rstrip": false,
8
+ "single_word": false,
9
+ "special": true
10
+ },
11
+ "100": {
12
+ "content": "[UNK]",
13
+ "lstrip": false,
14
+ "normalized": false,
15
+ "rstrip": false,
16
+ "single_word": false,
17
+ "special": true
18
+ },
19
+ "101": {
20
+ "content": "[CLS]",
21
+ "lstrip": false,
22
+ "normalized": false,
23
+ "rstrip": false,
24
+ "single_word": false,
25
+ "special": true
26
+ },
27
+ "102": {
28
+ "content": "[SEP]",
29
+ "lstrip": false,
30
+ "normalized": false,
31
+ "rstrip": false,
32
+ "single_word": false,
33
+ "special": true
34
+ },
35
+ "103": {
36
+ "content": "[MASK]",
37
+ "lstrip": false,
38
+ "normalized": false,
39
+ "rstrip": false,
40
+ "single_word": false,
41
+ "special": true
42
+ }
43
+ },
44
+ "clean_up_tokenization_spaces": false,
45
+ "cls_token": "[CLS]",
46
+ "do_basic_tokenize": true,
47
+ "do_lower_case": true,
48
+ "extra_special_tokens": {},
49
+ "mask_token": "[MASK]",
50
+ "max_length": 128,
51
+ "model_max_length": 256,
52
+ "never_split": null,
53
+ "pad_to_multiple_of": null,
54
+ "pad_token": "[PAD]",
55
+ "pad_token_type_id": 0,
56
+ "padding_side": "right",
57
+ "sep_token": "[SEP]",
58
+ "stride": 0,
59
+ "strip_accents": null,
60
+ "tokenize_chinese_chars": true,
61
+ "tokenizer_class": "BertTokenizer",
62
+ "truncation_side": "right",
63
+ "truncation_strategy": "longest_first",
64
+ "unk_token": "[UNK]"
65
+ }
vocab.txt ADDED
The diff for this file is too large to render. See raw diff