edugargar commited on
Commit
ff15a71
·
verified ·
1 Parent(s): c731702

Add SetFit model

Browse files
1_Pooling/config.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
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
+ "pooling_mode_weightedmean_tokens": false,
8
+ "pooling_mode_lasttoken": false,
9
+ "include_prompt": true
10
+ }
README.md ADDED
@@ -0,0 +1,207 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ tags:
3
+ - setfit
4
+ - sentence-transformers
5
+ - text-classification
6
+ - generated_from_setfit_trainer
7
+ widget:
8
+ - text: Quiero un programador para mantenimiento regular de mi e-commerce.
9
+ - text: Quiero contratar un ilustrador para un proyecto puntual.
10
+ - text: Requiero un consultor en agronomía para optimizar el rendimiento de mis cultivos.
11
+ - text: ¿Podrían darme ejemplos de perfiles con experiencia en marketing B2B?
12
+ - text: Busco a alguien que realice un análisis mensual de mi estrategia SEO.
13
+ metrics:
14
+ - accuracy
15
+ pipeline_tag: text-classification
16
+ library_name: setfit
17
+ inference: true
18
+ base_model: hiiamsid/sentence_similarity_spanish_es
19
+ model-index:
20
+ - name: SetFit with hiiamsid/sentence_similarity_spanish_es
21
+ results:
22
+ - task:
23
+ type: text-classification
24
+ name: Text Classification
25
+ dataset:
26
+ name: Unknown
27
+ type: unknown
28
+ split: test
29
+ metrics:
30
+ - type: accuracy
31
+ value: 0.782608695652174
32
+ name: Accuracy
33
+ ---
34
+
35
+ # SetFit with hiiamsid/sentence_similarity_spanish_es
36
+
37
+ This is a [SetFit](https://github.com/huggingface/setfit) model that can be used for Text Classification. This SetFit model uses [hiiamsid/sentence_similarity_spanish_es](https://huggingface.co/hiiamsid/sentence_similarity_spanish_es) 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.
38
+
39
+ The model has been trained using an efficient few-shot learning technique that involves:
40
+
41
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
42
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
43
+
44
+ ## Model Details
45
+
46
+ ### Model Description
47
+ - **Model Type:** SetFit
48
+ - **Sentence Transformer body:** [hiiamsid/sentence_similarity_spanish_es](https://huggingface.co/hiiamsid/sentence_similarity_spanish_es)
49
+ - **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
50
+ - **Maximum Sequence Length:** 512 tokens
51
+ - **Number of Classes:** 3 classes
52
+ <!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
53
+ <!-- - **Language:** Unknown -->
54
+ <!-- - **License:** Unknown -->
55
+
56
+ ### Model Sources
57
+
58
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
59
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
60
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
61
+
62
+ ### Model Labels
63
+ | Label | Examples |
64
+ |:--------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
65
+ | transaction | <ul><li>'Estoy buscando un desarrollador para crear un sitio web corporativo.'</li><li>'Quiero contratar un especialista en SEO para mejorar la visibilidad de mi tienda online.'</li><li>'Busco a alguien que configure un servidor y lo mantenga a largo plazo.'</li></ul> |
66
+ | informational | <ul><li>'¿Podrían explicarme cómo funciona el sistema de cobro a freelancers?'</li><li>'¿Cómo obtengo información sobre las comisiones de la plataforma?'</li><li>'Me gustaría saber cuántos diseñadores UX hay disponibles actualmente.'</li></ul> |
67
+ | no_offering | <ul><li>'¿Puedes decirme la contraseña de la base de datos interna de la plataforma?'</li><li>'Estoy interesado en comprar datos personales de otros usuarios de la plataforma.'</li><li>'Necesito un especialista en hacking para infiltrarse en el sistema de un competidor.'</li></ul> |
68
+
69
+ ## Evaluation
70
+
71
+ ### Metrics
72
+ | Label | Accuracy |
73
+ |:--------|:---------|
74
+ | **all** | 0.7826 |
75
+
76
+ ## Uses
77
+
78
+ ### Direct Use for Inference
79
+
80
+ First install the SetFit library:
81
+
82
+ ```bash
83
+ pip install setfit
84
+ ```
85
+
86
+ Then you can load this model and run inference.
87
+
88
+ ```python
89
+ from setfit import SetFitModel
90
+
91
+ # Download from the 🤗 Hub
92
+ model = SetFitModel.from_pretrained("edugargar/transactional_model")
93
+ # Run inference
94
+ preds = model("Quiero contratar un ilustrador para un proyecto puntual.")
95
+ ```
96
+
97
+ <!--
98
+ ### Downstream Use
99
+
100
+ *List how someone could finetune this model on their own dataset.*
101
+ -->
102
+
103
+ <!--
104
+ ### Out-of-Scope Use
105
+
106
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
107
+ -->
108
+
109
+ <!--
110
+ ## Bias, Risks and Limitations
111
+
112
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
113
+ -->
114
+
115
+ <!--
116
+ ### Recommendations
117
+
118
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
119
+ -->
120
+
121
+ ## Training Details
122
+
123
+ ### Training Set Metrics
124
+ | Training set | Min | Median | Max |
125
+ |:-------------|:----|:-------|:----|
126
+ | Word count | 7 | 11.0 | 17 |
127
+
128
+ | Label | Training Sample Count |
129
+ |:--------------|:----------------------|
130
+ | informational | 16 |
131
+ | no_offering | 24 |
132
+ | transaction | 38 |
133
+
134
+ ### Training Hyperparameters
135
+ - batch_size: (32, 32)
136
+ - num_epochs: (4, 4)
137
+ - max_steps: -1
138
+ - sampling_strategy: oversampling
139
+ - body_learning_rate: (2e-05, 1e-05)
140
+ - head_learning_rate: 0.01
141
+ - loss: CosineSimilarityLoss
142
+ - distance_metric: cosine_distance
143
+ - margin: 0.25
144
+ - end_to_end: False
145
+ - use_amp: False
146
+ - warmup_proportion: 0.1
147
+ - l2_weight: 0.01
148
+ - seed: 42
149
+ - eval_max_steps: -1
150
+ - load_best_model_at_end: False
151
+
152
+ ### Training Results
153
+ | Epoch | Step | Training Loss | Validation Loss |
154
+ |:------:|:----:|:-------------:|:---------------:|
155
+ | 0.0084 | 1 | 0.3029 | - |
156
+ | 0.4202 | 50 | 0.1382 | - |
157
+ | 0.8403 | 100 | 0.0042 | - |
158
+ | 1.2605 | 150 | 0.0006 | - |
159
+ | 1.6807 | 200 | 0.0004 | - |
160
+ | 2.1008 | 250 | 0.0003 | - |
161
+ | 2.5210 | 300 | 0.0003 | - |
162
+ | 2.9412 | 350 | 0.0002 | - |
163
+ | 3.3613 | 400 | 0.0002 | - |
164
+ | 3.7815 | 450 | 0.0002 | - |
165
+
166
+ ### Framework Versions
167
+ - Python: 3.10.12
168
+ - SetFit: 1.1.0
169
+ - Sentence Transformers: 3.3.1
170
+ - Transformers: 4.42.2
171
+ - PyTorch: 2.5.1+cu121
172
+ - Datasets: 3.2.0
173
+ - Tokenizers: 0.19.1
174
+
175
+ ## Citation
176
+
177
+ ### BibTeX
178
+ ```bibtex
179
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
180
+ doi = {10.48550/ARXIV.2209.11055},
181
+ url = {https://arxiv.org/abs/2209.11055},
182
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
183
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
184
+ title = {Efficient Few-Shot Learning Without Prompts},
185
+ publisher = {arXiv},
186
+ year = {2022},
187
+ copyright = {Creative Commons Attribution 4.0 International}
188
+ }
189
+ ```
190
+
191
+ <!--
192
+ ## Glossary
193
+
194
+ *Clearly define terms in order to be accessible across audiences.*
195
+ -->
196
+
197
+ <!--
198
+ ## Model Card Authors
199
+
200
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
201
+ -->
202
+
203
+ <!--
204
+ ## Model Card Contact
205
+
206
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
207
+ -->
config.json ADDED
@@ -0,0 +1,27 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "hiiamsid/sentence_similarity_spanish_es",
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": 768,
12
+ "initializer_range": 0.02,
13
+ "intermediate_size": 3072,
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
+ "output_past": true,
20
+ "pad_token_id": 1,
21
+ "position_embedding_type": "absolute",
22
+ "torch_dtype": "float32",
23
+ "transformers_version": "4.42.2",
24
+ "type_vocab_size": 2,
25
+ "use_cache": true,
26
+ "vocab_size": 31002
27
+ }
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.5.1+cu121"
6
+ },
7
+ "prompts": {},
8
+ "default_prompt_name": null,
9
+ "similarity_fn_name": "cosine"
10
+ }
config_setfit.json ADDED
@@ -0,0 +1,8 @@
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "normalize_embeddings": false,
3
+ "labels": [
4
+ "informational",
5
+ "no_offering",
6
+ "transaction"
7
+ ]
8
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:11e919c280a455e541b2869ce1e212f87eeb2435c5c9b0e325e1ca42e45538ba
3
+ size 439425888
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:c14cbc5d7e4223bac34a532797254af830a413c62e6864809048d80729904d36
3
+ size 19455
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,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,64 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "added_tokens_decoder": {
3
+ "0": {
4
+ "content": "[MASK]",
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
+ "3": {
20
+ "content": "[UNK]",
21
+ "lstrip": false,
22
+ "normalized": false,
23
+ "rstrip": false,
24
+ "single_word": false,
25
+ "special": true
26
+ },
27
+ "4": {
28
+ "content": "[CLS]",
29
+ "lstrip": false,
30
+ "normalized": false,
31
+ "rstrip": false,
32
+ "single_word": false,
33
+ "special": true
34
+ },
35
+ "5": {
36
+ "content": "[SEP]",
37
+ "lstrip": false,
38
+ "normalized": false,
39
+ "rstrip": false,
40
+ "single_word": false,
41
+ "special": true
42
+ }
43
+ },
44
+ "clean_up_tokenization_spaces": true,
45
+ "cls_token": "[CLS]",
46
+ "do_basic_tokenize": true,
47
+ "do_lower_case": false,
48
+ "mask_token": "[MASK]",
49
+ "max_length": 512,
50
+ "model_max_length": 512,
51
+ "never_split": null,
52
+ "pad_to_multiple_of": null,
53
+ "pad_token": "[PAD]",
54
+ "pad_token_type_id": 0,
55
+ "padding_side": "right",
56
+ "sep_token": "[SEP]",
57
+ "stride": 0,
58
+ "strip_accents": false,
59
+ "tokenize_chinese_chars": true,
60
+ "tokenizer_class": "BertTokenizer",
61
+ "truncation_side": "right",
62
+ "truncation_strategy": "longest_first",
63
+ "unk_token": "[UNK]"
64
+ }
vocab.txt ADDED
The diff for this file is too large to render. See raw diff