FletchAmplyfi commited on
Commit
161b06f
·
verified ·
1 Parent(s): 96ef299

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