lgd commited on
Commit
abb6018
·
verified ·
1 Parent(s): b4f1fec

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,215 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ library_name: setfit
3
+ tags:
4
+ - setfit
5
+ - sentence-transformers
6
+ - text-classification
7
+ - generated_from_setfit_trainer
8
+ base_model: sentence-transformers/paraphrase-mpnet-base-v2
9
+ metrics:
10
+ - accuracy
11
+ - precision
12
+ - recall
13
+ - f1
14
+ widget:
15
+ - text: table drinking water threatsresource5c5007c2 56ef 4fb8 a37b 4f6dc9e37295
16
+ - text: physical profile data collected oregon coast provide observation seasoar tow
17
+ support globec northeast pacific mesoscale survey august 2000 ncei accession 0001050
18
+ - text: wood production intensification area aipl area intensification wood production
19
+ aipl territory mainly intended wood production silvicultural work aim increase
20
+ value per unit area volume per stem quality stem production desired specie combination
21
+ various production objective official register aipl applicable according article
22
+ 69 sustainable forest management act ladtfthis third party metadata element translated
23
+ using automated translation tool amazon translate formdescriptors natureandenvironment
24
+ scienceandtechnology aipl area high forest potential sustainable forest management
25
+ forest development public forest silvicultural investment forest territorial limit
26
+ wood production stf forest territorial subdivision government information
27
+ - text: shelter profile information
28
+ - text: incident cerregulated pipeline facility canada energy regulator provides data
29
+ incident cerregulated pipeline facility defined onshore pipeline regulation processing
30
+ plant regulation data updated quarterlythe data provided 2008 current used visualization
31
+ tool canada energy regulator website source code visualization tool also available
32
+ economicsandindustry healthandsafety natureandenvironment cer pipeline safety
33
+ incident incident pipeline incident pipeline spill
34
+ pipeline_tag: text-classification
35
+ inference: false
36
+ model-index:
37
+ - name: SetFit with sentence-transformers/paraphrase-mpnet-base-v2
38
+ results:
39
+ - task:
40
+ type: text-classification
41
+ name: Text Classification
42
+ dataset:
43
+ name: Unknown
44
+ type: unknown
45
+ split: test
46
+ metrics:
47
+ - type: accuracy
48
+ value: 0.6
49
+ name: Accuracy
50
+ - type: precision
51
+ value: 1.0
52
+ name: Precision
53
+ - type: recall
54
+ value: 0.6666666666666666
55
+ name: Recall
56
+ - type: f1
57
+ value: 0.8
58
+ name: F1
59
+ ---
60
+
61
+ # SetFit with sentence-transformers/paraphrase-mpnet-base-v2
62
+
63
+ This is a [SetFit](https://github.com/huggingface/setfit) model that can be used for Text Classification. This SetFit model uses [sentence-transformers/paraphrase-mpnet-base-v2](https://huggingface.co/sentence-transformers/paraphrase-mpnet-base-v2) as the Sentence Transformer embedding model. A OneVsRestClassifier instance is used for classification.
64
+
65
+ The model has been trained using an efficient few-shot learning technique that involves:
66
+
67
+ 1. Fine-tuning a [Sentence Transformer](https://www.sbert.net) with contrastive learning.
68
+ 2. Training a classification head with features from the fine-tuned Sentence Transformer.
69
+
70
+ ## Model Details
71
+
72
+ ### Model Description
73
+ - **Model Type:** SetFit
74
+ - **Sentence Transformer body:** [sentence-transformers/paraphrase-mpnet-base-v2](https://huggingface.co/sentence-transformers/paraphrase-mpnet-base-v2)
75
+ - **Classification head:** a OneVsRestClassifier instance
76
+ - **Maximum Sequence Length:** 512 tokens
77
+ <!-- - **Number of Classes:** Unknown -->
78
+ <!-- - **Training Dataset:** [Unknown](https://huggingface.co/datasets/unknown) -->
79
+ <!-- - **Language:** Unknown -->
80
+ <!-- - **License:** Unknown -->
81
+
82
+ ### Model Sources
83
+
84
+ - **Repository:** [SetFit on GitHub](https://github.com/huggingface/setfit)
85
+ - **Paper:** [Efficient Few-Shot Learning Without Prompts](https://arxiv.org/abs/2209.11055)
86
+ - **Blogpost:** [SetFit: Efficient Few-Shot Learning Without Prompts](https://huggingface.co/blog/setfit)
87
+
88
+ ## Evaluation
89
+
90
+ ### Metrics
91
+ | Label | Accuracy | Precision | Recall | F1 |
92
+ |:--------|:---------|:----------|:-------|:----|
93
+ | **all** | 0.6 | 1.0 | 0.6667 | 0.8 |
94
+
95
+ ## Uses
96
+
97
+ ### Direct Use for Inference
98
+
99
+ First install the SetFit library:
100
+
101
+ ```bash
102
+ pip install setfit
103
+ ```
104
+
105
+ Then you can load this model and run inference.
106
+
107
+ ```python
108
+ from setfit import SetFitModel
109
+
110
+ # Download from the 🤗 Hub
111
+ model = SetFitModel.from_pretrained("lgd/setfit-multilabel")
112
+ # Run inference
113
+ preds = model("shelter profile information")
114
+ ```
115
+
116
+ <!--
117
+ ### Downstream Use
118
+
119
+ *List how someone could finetune this model on their own dataset.*
120
+ -->
121
+
122
+ <!--
123
+ ### Out-of-Scope Use
124
+
125
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
126
+ -->
127
+
128
+ <!--
129
+ ## Bias, Risks and Limitations
130
+
131
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
132
+ -->
133
+
134
+ <!--
135
+ ### Recommendations
136
+
137
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
138
+ -->
139
+
140
+ ## Training Details
141
+
142
+ ### Training Set Metrics
143
+ | Training set | Min | Median | Max |
144
+ |:-------------|:----|:-------|:----|
145
+ | Word count | 2 | 5.3 | 7 |
146
+
147
+ ### Training Hyperparameters
148
+ - batch_size: (8, 8)
149
+ - num_epochs: (12, 12)
150
+ - max_steps: -1
151
+ - sampling_strategy: oversampling
152
+ - body_learning_rate: (2e-05, 1e-05)
153
+ - head_learning_rate: 0.01
154
+ - loss: CosineSimilarityLoss
155
+ - distance_metric: cosine_distance
156
+ - margin: 0.25
157
+ - end_to_end: False
158
+ - use_amp: False
159
+ - warmup_proportion: 0.1
160
+ - seed: 42
161
+ - eval_max_steps: -1
162
+ - load_best_model_at_end: False
163
+
164
+ ### Training Results
165
+ | Epoch | Step | Training Loss | Validation Loss |
166
+ |:-----:|:----:|:-------------:|:---------------:|
167
+ | 0.125 | 1 | 0.3106 | - |
168
+ | 6.25 | 50 | 0.0408 | - |
169
+ | 0.125 | 1 | 0.0929 | - |
170
+ | 6.25 | 50 | 0.0393 | - |
171
+ | 0.125 | 1 | 0.0134 | - |
172
+ | 6.25 | 50 | 0.0165 | - |
173
+
174
+ ### Framework Versions
175
+ - Python: 3.10.12
176
+ - SetFit: 1.0.3
177
+ - Sentence Transformers: 3.0.1
178
+ - Transformers: 4.39.0
179
+ - PyTorch: 2.3.0+cu121
180
+ - Datasets: 2.20.0
181
+ - Tokenizers: 0.15.2
182
+
183
+ ## Citation
184
+
185
+ ### BibTeX
186
+ ```bibtex
187
+ @article{https://doi.org/10.48550/arxiv.2209.11055,
188
+ doi = {10.48550/ARXIV.2209.11055},
189
+ url = {https://arxiv.org/abs/2209.11055},
190
+ author = {Tunstall, Lewis and Reimers, Nils and Jo, Unso Eun Seo and Bates, Luke and Korat, Daniel and Wasserblat, Moshe and Pereg, Oren},
191
+ keywords = {Computation and Language (cs.CL), FOS: Computer and information sciences, FOS: Computer and information sciences},
192
+ title = {Efficient Few-Shot Learning Without Prompts},
193
+ publisher = {arXiv},
194
+ year = {2022},
195
+ copyright = {Creative Commons Attribution 4.0 International}
196
+ }
197
+ ```
198
+
199
+ <!--
200
+ ## Glossary
201
+
202
+ *Clearly define terms in order to be accessible across audiences.*
203
+ -->
204
+
205
+ <!--
206
+ ## Model Card Authors
207
+
208
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
209
+ -->
210
+
211
+ <!--
212
+ ## Model Card Contact
213
+
214
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
215
+ -->
config.json ADDED
@@ -0,0 +1,24 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "sentence-transformers/paraphrase-mpnet-base-v2",
3
+ "architectures": [
4
+ "MPNetModel"
5
+ ],
6
+ "attention_probs_dropout_prob": 0.1,
7
+ "bos_token_id": 0,
8
+ "eos_token_id": 2,
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-05,
15
+ "max_position_embeddings": 514,
16
+ "model_type": "mpnet",
17
+ "num_attention_heads": 12,
18
+ "num_hidden_layers": 12,
19
+ "pad_token_id": 1,
20
+ "relative_attention_num_buckets": 32,
21
+ "torch_dtype": "float32",
22
+ "transformers_version": "4.39.0",
23
+ "vocab_size": 30527
24
+ }
config_sentence_transformers.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "sentence_transformers": "3.0.1",
4
+ "transformers": "4.39.0",
5
+ "pytorch": "2.3.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
+ "labels": null,
3
+ "normalize_embeddings": false
4
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:1a4d4d0460bb696aa6144b45d6cfc56e3f10ed447d2b3e43fb620cba475d2ef9
3
+ size 437967672
model_head.pkl ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:ed201ba19a800fa208d63db7b3c9bb6b3160e4069303e2bd4b9115823dfac0fc
3
+ size 26916
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,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
The diff for this file is too large to render. See raw diff
 
tokenizer_config.json ADDED
@@ -0,0 +1,59 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
+ "104": {
28
+ "content": "[UNK]",
29
+ "lstrip": false,
30
+ "normalized": false,
31
+ "rstrip": false,
32
+ "single_word": false,
33
+ "special": true
34
+ },
35
+ "30526": {
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_basic_tokenize": true,
48
+ "do_lower_case": true,
49
+ "eos_token": "</s>",
50
+ "mask_token": "<mask>",
51
+ "model_max_length": 512,
52
+ "never_split": null,
53
+ "pad_token": "<pad>",
54
+ "sep_token": "</s>",
55
+ "strip_accents": null,
56
+ "tokenize_chinese_chars": true,
57
+ "tokenizer_class": "MPNetTokenizer",
58
+ "unk_token": "[UNK]"
59
+ }
vocab.txt ADDED
The diff for this file is too large to render. See raw diff