adriansanz commited on
Commit
c9cec93
1 Parent(s): 2817695

Add SetFit model

Browse files
.gitattributes CHANGED
@@ -33,3 +33,4 @@ 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
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,192 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: projecte-aina/ST-NLI-ca_paraphrase-multilingual-mpnet-base
3
+ library_name: setfit
4
+ metrics:
5
+ - accuracy
6
+ pipeline_tag: text-classification
7
+ tags:
8
+ - setfit
9
+ - sentence-transformers
10
+ - text-classification
11
+ - generated_from_setfit_trainer
12
+ widget:
13
+ - text: Hola, quin és el paper dels dipòsits o fiances en la garantia dels serveis?
14
+ - text: Hola!
15
+ - text: Hola, tinc algunes preguntes sobre tràmits que voldria fer.
16
+ - text: Quin és el propòsit de la garantia dels serveis adjudicats?
17
+ - text: Sóc interessat en saber què inclou el tràmit de sol·licitud de subvencions.
18
+ inference: true
19
+ ---
20
+
21
+ # SetFit with projecte-aina/ST-NLI-ca_paraphrase-multilingual-mpnet-base
22
+
23
+ This is a [SetFit](https://github.com/huggingface/setfit) model that can be used for Text Classification. This SetFit model uses [projecte-aina/ST-NLI-ca_paraphrase-multilingual-mpnet-base](https://huggingface.co/projecte-aina/ST-NLI-ca_paraphrase-multilingual-mpnet-base) 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.
24
+
25
+ The model has been trained using an efficient few-shot learning technique that involves:
26
+
27
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
28
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
29
+
30
+ ## Model Details
31
+
32
+ ### Model Description
33
+ - **Model Type:** SetFit
34
+ - **Sentence Transformer body:** [projecte-aina/ST-NLI-ca_paraphrase-multilingual-mpnet-base](https://huggingface.co/projecte-aina/ST-NLI-ca_paraphrase-multilingual-mpnet-base)
35
+ - **Classification head:** a [LogisticRegression](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html) instance
36
+ - **Maximum Sequence Length:** 128 tokens
37
+ - **Number of Classes:** 2 classes
38
+ <!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
39
+ <!-- - **Language:** Unknown -->
40
+ <!-- - **License:** Unknown -->
41
+
42
+ ### Model Sources
43
+
44
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
45
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
46
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
47
+
48
+ ### Model Labels
49
+ | Label | Examples |
50
+ |:------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
51
+ | 0 | <ul><li>'Quin és el procediment per a la devolució de fiances i avals?'</li><li>"Sóc usuari i m'agradaria saber quin és el procediment per fer una sol·licitud per aquest tràmit."</li><li>'Quin és el benefici de la devolució de fiances i avals?'</li></ul> |
52
+ | 1 | <ul><li>'Bon dia, com et va?'</li><li>'Bon dia, vull saber més sobre els tràmits disponibles.'</li><li>'Ei!'</li></ul> |
53
+
54
+ ## Uses
55
+
56
+ ### Direct Use for Inference
57
+
58
+ First install the SetFit library:
59
+
60
+ ```bash
61
+ pip install setfit
62
+ ```
63
+
64
+ Then you can load this model and run inference.
65
+
66
+ ```python
67
+ from setfit import SetFitModel
68
+
69
+ # Download from the 🤗 Hub
70
+ model = SetFitModel.from_pretrained("adriansanz/gret5")
71
+ # Run inference
72
+ preds = model("Hola!")
73
+ ```
74
+
75
+ <!--
76
+ ### Downstream Use
77
+
78
+ *List how someone could finetune this model on their own dataset.*
79
+ -->
80
+
81
+ <!--
82
+ ### Out-of-Scope Use
83
+
84
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
85
+ -->
86
+
87
+ <!--
88
+ ## Bias, Risks and Limitations
89
+
90
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
91
+ -->
92
+
93
+ <!--
94
+ ### Recommendations
95
+
96
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
97
+ -->
98
+
99
+ ## Training Details
100
+
101
+ ### Training Set Metrics
102
+ | Training set | Min | Median | Max |
103
+ |:-------------|:----|:-------|:----|
104
+ | Word count | 1 | 9.1548 | 17 |
105
+
106
+ | Label | Training Sample Count |
107
+ |:------|:----------------------|
108
+ | 0 | 42 |
109
+ | 1 | 42 |
110
+
111
+ ### Training Hyperparameters
112
+ - batch_size: (16, 16)
113
+ - num_epochs: (3, 3)
114
+ - max_steps: -1
115
+ - sampling_strategy: oversampling
116
+ - body_learning_rate: (2e-05, 1e-05)
117
+ - head_learning_rate: 0.01
118
+ - loss: CosineSimilarityLoss
119
+ - distance_metric: cosine_distance
120
+ - margin: 0.25
121
+ - end_to_end: False
122
+ - use_amp: False
123
+ - warmup_proportion: 0.1
124
+ - l2_weight: 0.01
125
+ - seed: 42
126
+ - evaluation_strategy: epoch
127
+ - eval_max_steps: -1
128
+ - load_best_model_at_end: False
129
+
130
+ ### Training Results
131
+ | Epoch | Step | Training Loss | Validation Loss |
132
+ |:------:|:----:|:-------------:|:---------------:|
133
+ | 0.0044 | 1 | 0.2076 | - |
134
+ | 0.2212 | 50 | 0.099 | - |
135
+ | 0.4425 | 100 | 0.0016 | - |
136
+ | 0.6637 | 150 | 0.0002 | - |
137
+ | 0.8850 | 200 | 0.0002 | - |
138
+ | 1.0 | 226 | - | 0.0002 |
139
+ | 1.1062 | 250 | 0.0001 | - |
140
+ | 1.3274 | 300 | 0.0001 | - |
141
+ | 1.5487 | 350 | 0.0001 | - |
142
+ | 1.7699 | 400 | 0.0001 | - |
143
+ | 1.9912 | 450 | 0.0001 | - |
144
+ | 2.0 | 452 | - | 0.0001 |
145
+ | 2.2124 | 500 | 0.0001 | - |
146
+ | 2.4336 | 550 | 0.0001 | - |
147
+ | 2.6549 | 600 | 0.0001 | - |
148
+ | 2.8761 | 650 | 0.0 | - |
149
+ | 3.0 | 678 | - | 0.0001 |
150
+
151
+ ### Framework Versions
152
+ - Python: 3.10.12
153
+ - SetFit: 1.1.0
154
+ - Sentence Transformers: 3.2.1
155
+ - Transformers: 4.42.2
156
+ - PyTorch: 2.5.0+cu121
157
+ - Datasets: 3.1.0
158
+ - Tokenizers: 0.19.1
159
+
160
+ ## Citation
161
+
162
+ ### BibTeX
163
+ ```bibtex
164
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
165
+ doi = {10.48550/ARXIV.2209.11055},
166
+ url = {https://arxiv.org/abs/2209.11055},
167
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
168
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
169
+ title = {Efficient Few-Shot Learning Without Prompts},
170
+ publisher = {arXiv},
171
+ year = {2022},
172
+ copyright = {Creative Commons Attribution 4.0 International}
173
+ }
174
+ ```
175
+
176
+ <!--
177
+ ## Glossary
178
+
179
+ *Clearly define terms in order to be accessible across audiences.*
180
+ -->
181
+
182
+ <!--
183
+ ## Model Card Authors
184
+
185
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
186
+ -->
187
+
188
+ <!--
189
+ ## Model Card Contact
190
+
191
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
192
+ -->
config.json ADDED
@@ -0,0 +1,29 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "projecte-aina/ST-NLI-ca_paraphrase-multilingual-mpnet-base",
3
+ "architectures": [
4
+ "XLMRobertaModel"
5
+ ],
6
+ "attention_probs_dropout_prob": 0.1,
7
+ "bos_token_id": 0,
8
+ "classifier_dropout": null,
9
+ "eos_token_id": 2,
10
+ "gradient_checkpointing": false,
11
+ "hidden_act": "gelu",
12
+ "hidden_dropout_prob": 0.1,
13
+ "hidden_size": 768,
14
+ "initializer_range": 0.02,
15
+ "intermediate_size": 3072,
16
+ "layer_norm_eps": 1e-05,
17
+ "max_position_embeddings": 514,
18
+ "model_type": "xlm-roberta",
19
+ "num_attention_heads": 12,
20
+ "num_hidden_layers": 12,
21
+ "output_past": true,
22
+ "pad_token_id": 1,
23
+ "position_embedding_type": "absolute",
24
+ "torch_dtype": "float32",
25
+ "transformers_version": "4.42.2",
26
+ "type_vocab_size": 1,
27
+ "use_cache": true,
28
+ "vocab_size": 250002
29
+ }
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.0+cu121"
6
+ },
7
+ "prompts": {},
8
+ "default_prompt_name": null,
9
+ "similarity_fn_name": null
10
+ }
config_setfit.json ADDED
@@ -0,0 +1,4 @@
 
 
 
 
 
1
+ {
2
+ "normalize_embeddings": false,
3
+ "labels": null
4
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:099dd1279239aef8c8f5637ccd4603433c9a05142cf992c58ca8c6be187097c9
3
+ size 1112197096
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:ee95d7982b25898d87643cc4b5a7ddd79a2b1220815c425ea057a4ae0b499f5c
3
+ size 7007
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
+ }
sentencepiece.bpe.model ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:cfc8146abe2a0488e9e2a0c56de7952f7c11ab059eca145a0a727afce0db2865
3
+ size 5069051
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,61 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ "eos_token": "</s>",
48
+ "mask_token": "<mask>",
49
+ "max_length": 128,
50
+ "model_max_length": 128,
51
+ "pad_to_multiple_of": null,
52
+ "pad_token": "<pad>",
53
+ "pad_token_type_id": 0,
54
+ "padding_side": "right",
55
+ "sep_token": "</s>",
56
+ "stride": 0,
57
+ "tokenizer_class": "XLMRobertaTokenizer",
58
+ "truncation_side": "right",
59
+ "truncation_strategy": "longest_first",
60
+ "unk_token": "<unk>"
61
+ }