RonanMcGovern commited on
Commit
cd4e810
1 Parent(s): 39b690c

Add new SentenceTransformer 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,311 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language: []
3
+ library_name: sentence-transformers
4
+ tags:
5
+ - sentence-transformers
6
+ - sentence-similarity
7
+ - feature-extraction
8
+ - generated_from_trainer
9
+ - dataset_size:19
10
+ - loss:TripletLoss
11
+ datasets: []
12
+ base_model: sentence-transformers/all-MiniLM-L12-v2
13
+ widget: []
14
+ pipeline_tag: sentence-similarity
15
+ ---
16
+
17
+ # SentenceTransformer based on sentence-transformers/all-MiniLM-L12-v2
18
+
19
+ This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [sentence-transformers/all-MiniLM-L12-v2](https://huggingface.co/sentence-transformers/all-MiniLM-L12-v2). It maps sentences & paragraphs to a 384-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more.
20
+
21
+ ## Model Details
22
+
23
+ ### Model Description
24
+ - **Model Type:** Sentence Transformer
25
+ - **Base model:** [sentence-transformers/all-MiniLM-L12-v2](https://huggingface.co/sentence-transformers/all-MiniLM-L12-v2) <!-- at revision a05860a77cef7b37e0048a7864658139bc18a854 -->
26
+ - **Maximum Sequence Length:** 128 tokens
27
+ - **Output Dimensionality:** 384 tokens
28
+ - **Similarity Function:** Cosine Similarity
29
+ <!-- - **Training Dataset:** Unknown -->
30
+ <!-- - **Language:** Unknown -->
31
+ <!-- - **License:** Unknown -->
32
+
33
+ ### Model Sources
34
+
35
+ - **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
36
+ - **Repository:** [Sentence Transformers on GitHub](https://github.com/UKPLab/sentence-transformers)
37
+ - **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)
38
+
39
+ ### Full Model Architecture
40
+
41
+ ```
42
+ SentenceTransformer(
43
+ (0): Transformer({'max_seq_length': 128, 'do_lower_case': False}) with Transformer model: BertModel
44
+ (1): Pooling({'word_embedding_dimension': 384, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True})
45
+ (2): Normalize()
46
+ )
47
+ ```
48
+
49
+ ## Usage
50
+
51
+ ### Direct Usage (Sentence Transformers)
52
+
53
+ First install the Sentence Transformers library:
54
+
55
+ ```bash
56
+ pip install -U sentence-transformers
57
+ ```
58
+
59
+ Then you can load this model and run inference.
60
+ ```python
61
+ from sentence_transformers import SentenceTransformer
62
+
63
+ # Download from the 🤗 Hub
64
+ model = SentenceTransformer("RonanMcGovern/all-MiniLM-L12-v2-ft")
65
+ # Run inference
66
+ sentences = [
67
+ 'The weather is lovely today.',
68
+ "It's so sunny outside!",
69
+ 'He drove to the stadium.',
70
+ ]
71
+ embeddings = model.encode(sentences)
72
+ print(embeddings.shape)
73
+ # [3, 384]
74
+
75
+ # Get the similarity scores for the embeddings
76
+ similarities = model.similarity(embeddings, embeddings)
77
+ print(similarities.shape)
78
+ # [3, 3]
79
+ ```
80
+
81
+ <!--
82
+ ### Direct Usage (Transformers)
83
+
84
+ <details><summary>Click to see the direct usage in Transformers</summary>
85
+
86
+ </details>
87
+ -->
88
+
89
+ <!--
90
+ ### Downstream Usage (Sentence Transformers)
91
+
92
+ You can finetune this model on your own dataset.
93
+
94
+ <details><summary>Click to expand</summary>
95
+
96
+ </details>
97
+ -->
98
+
99
+ <!--
100
+ ### Out-of-Scope Use
101
+
102
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
103
+ -->
104
+
105
+ <!--
106
+ ## Bias, Risks and Limitations
107
+
108
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
109
+ -->
110
+
111
+ <!--
112
+ ### Recommendations
113
+
114
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
115
+ -->
116
+
117
+ ## Training Details
118
+
119
+ ### Training Hyperparameters
120
+ #### Non-Default Hyperparameters
121
+
122
+ - `per_device_train_batch_size`: 4
123
+ - `per_device_eval_batch_size`: 1
124
+ - `lr_scheduler_type`: cosine
125
+ - `warmup_ratio`: 0.1
126
+ - `bf16`: True
127
+
128
+ #### All Hyperparameters
129
+ <details><summary>Click to expand</summary>
130
+
131
+ - `overwrite_output_dir`: False
132
+ - `do_predict`: False
133
+ - `prediction_loss_only`: True
134
+ - `per_device_train_batch_size`: 4
135
+ - `per_device_eval_batch_size`: 1
136
+ - `per_gpu_train_batch_size`: None
137
+ - `per_gpu_eval_batch_size`: None
138
+ - `gradient_accumulation_steps`: 1
139
+ - `eval_accumulation_steps`: None
140
+ - `learning_rate`: 5e-05
141
+ - `weight_decay`: 0.0
142
+ - `adam_beta1`: 0.9
143
+ - `adam_beta2`: 0.999
144
+ - `adam_epsilon`: 1e-08
145
+ - `max_grad_norm`: 1.0
146
+ - `num_train_epochs`: 3
147
+ - `max_steps`: -1
148
+ - `lr_scheduler_type`: cosine
149
+ - `lr_scheduler_kwargs`: {}
150
+ - `warmup_ratio`: 0.1
151
+ - `warmup_steps`: 0
152
+ - `log_level`: passive
153
+ - `log_level_replica`: warning
154
+ - `log_on_each_node`: True
155
+ - `logging_nan_inf_filter`: True
156
+ - `save_safetensors`: True
157
+ - `save_on_each_node`: False
158
+ - `save_only_model`: False
159
+ - `no_cuda`: False
160
+ - `use_cpu`: False
161
+ - `use_mps_device`: False
162
+ - `seed`: 42
163
+ - `data_seed`: None
164
+ - `jit_mode_eval`: False
165
+ - `use_ipex`: False
166
+ - `bf16`: True
167
+ - `fp16`: False
168
+ - `fp16_opt_level`: O1
169
+ - `half_precision_backend`: auto
170
+ - `bf16_full_eval`: False
171
+ - `fp16_full_eval`: False
172
+ - `tf32`: None
173
+ - `local_rank`: 0
174
+ - `ddp_backend`: None
175
+ - `tpu_num_cores`: None
176
+ - `tpu_metrics_debug`: False
177
+ - `debug`: []
178
+ - `dataloader_drop_last`: False
179
+ - `dataloader_num_workers`: 0
180
+ - `dataloader_prefetch_factor`: None
181
+ - `past_index`: -1
182
+ - `disable_tqdm`: False
183
+ - `remove_unused_columns`: True
184
+ - `label_names`: None
185
+ - `load_best_model_at_end`: False
186
+ - `ignore_data_skip`: False
187
+ - `fsdp`: []
188
+ - `fsdp_min_num_params`: 0
189
+ - `fsdp_config`: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}
190
+ - `fsdp_transformer_layer_cls_to_wrap`: None
191
+ - `accelerator_config`: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True}
192
+ - `deepspeed`: None
193
+ - `label_smoothing_factor`: 0.0
194
+ - `optim`: adamw_torch
195
+ - `optim_args`: None
196
+ - `adafactor`: False
197
+ - `group_by_length`: False
198
+ - `length_column_name`: length
199
+ - `ddp_find_unused_parameters`: None
200
+ - `ddp_bucket_cap_mb`: None
201
+ - `ddp_broadcast_buffers`: False
202
+ - `dataloader_pin_memory`: True
203
+ - `dataloader_persistent_workers`: False
204
+ - `skip_memory_metrics`: True
205
+ - `use_legacy_prediction_loop`: False
206
+ - `push_to_hub`: False
207
+ - `resume_from_checkpoint`: None
208
+ - `hub_model_id`: None
209
+ - `hub_strategy`: every_save
210
+ - `hub_private_repo`: False
211
+ - `hub_always_push`: False
212
+ - `gradient_checkpointing`: False
213
+ - `gradient_checkpointing_kwargs`: None
214
+ - `include_inputs_for_metrics`: False
215
+ - `fp16_backend`: auto
216
+ - `push_to_hub_model_id`: None
217
+ - `push_to_hub_organization`: None
218
+ - `mp_parameters`:
219
+ - `auto_find_batch_size`: False
220
+ - `full_determinism`: False
221
+ - `torchdynamo`: None
222
+ - `ray_scope`: last
223
+ - `ddp_timeout`: 1800
224
+ - `torch_compile`: False
225
+ - `torch_compile_backend`: None
226
+ - `torch_compile_mode`: None
227
+ - `dispatch_batches`: None
228
+ - `split_batches`: None
229
+ - `include_tokens_per_second`: False
230
+ - `include_num_input_tokens_seen`: False
231
+ - `neftune_noise_alpha`: None
232
+ - `batch_sampler`: batch_sampler
233
+ - `multi_dataset_batch_sampler`: proportional
234
+
235
+ </details>
236
+
237
+ ### Training Logs
238
+ | Epoch | Step | Training Loss | loss |
239
+ |:-----:|:----:|:-------------:|:------:|
240
+ | 0.2 | 1 | 4.9536 | 4.8210 |
241
+ | 0.4 | 2 | 4.7665 | 4.7824 |
242
+ | 0.6 | 3 | 4.9081 | 4.7393 |
243
+ | 0.8 | 4 | 4.8136 | 4.7062 |
244
+ | 1.0 | 5 | 4.9766 | 4.6937 |
245
+ | 1.2 | 6 | 4.6935 | 4.6845 |
246
+ | 1.4 | 7 | 4.5294 | 4.6731 |
247
+ | 1.6 | 8 | 4.709 | 4.6682 |
248
+ | 1.8 | 9 | 4.4863 | 4.6610 |
249
+ | 2.0 | 10 | 4.64 | 4.6552 |
250
+ | 2.2 | 11 | 4.5238 | 4.6501 |
251
+ | 2.4 | 12 | 4.3835 | 4.6456 |
252
+ | 2.6 | 13 | 4.3515 | 4.6416 |
253
+ | 2.8 | 14 | 4.5113 | 4.6416 |
254
+ | 3.0 | 15 | 4.5309 | 4.6403 |
255
+
256
+
257
+ ### Framework Versions
258
+ - Python: 3.10.12
259
+ - Sentence Transformers: 3.0.1
260
+ - Transformers: 4.38.1
261
+ - PyTorch: 2.1.1+cu121
262
+ - Accelerate: 0.27.2
263
+ - Datasets: 2.17.1
264
+ - Tokenizers: 0.15.2
265
+
266
+ ## Citation
267
+
268
+ ### BibTeX
269
+
270
+ #### Sentence Transformers
271
+ ```bibtex
272
+ @inproceedings{reimers-2019-sentence-bert,
273
+ title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks",
274
+ author = "Reimers, Nils and Gurevych, Iryna",
275
+ booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing",
276
+ month = "11",
277
+ year = "2019",
278
+ publisher = "Association for Computational Linguistics",
279
+ url = "https://arxiv.org/abs/1908.10084",
280
+ }
281
+ ```
282
+
283
+ #### TripletLoss
284
+ ```bibtex
285
+ @misc{hermans2017defense,
286
+ title={In Defense of the Triplet Loss for Person Re-Identification},
287
+ author={Alexander Hermans and Lucas Beyer and Bastian Leibe},
288
+ year={2017},
289
+ eprint={1703.07737},
290
+ archivePrefix={arXiv},
291
+ primaryClass={cs.CV}
292
+ }
293
+ ```
294
+
295
+ <!--
296
+ ## Glossary
297
+
298
+ *Clearly define terms in order to be accessible across audiences.*
299
+ -->
300
+
301
+ <!--
302
+ ## Model Card Authors
303
+
304
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
305
+ -->
306
+
307
+ <!--
308
+ ## Model Card Contact
309
+
310
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
311
+ -->
config.json ADDED
@@ -0,0 +1,26 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "_name_or_path": "sentence-transformers/all-MiniLM-L12-v2",
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": 384,
12
+ "initializer_range": 0.02,
13
+ "intermediate_size": 1536,
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
+ "pad_token_id": 0,
20
+ "position_embedding_type": "absolute",
21
+ "torch_dtype": "float32",
22
+ "transformers_version": "4.38.1",
23
+ "type_vocab_size": 2,
24
+ "use_cache": true,
25
+ "vocab_size": 30522
26
+ }
config_sentence_transformers.json ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "__version__": {
3
+ "sentence_transformers": "3.0.1",
4
+ "transformers": "4.38.1",
5
+ "pytorch": "2.1.1+cu121"
6
+ },
7
+ "prompts": {},
8
+ "default_prompt_name": null,
9
+ "similarity_fn_name": null
10
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:484407208cb29a12ed168a929b0f47c37827ca1e076411c4002ec418eca5fb65
3
+ size 133462128
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": 128,
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": "[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": true,
45
+ "cls_token": "[CLS]",
46
+ "do_basic_tokenize": true,
47
+ "do_lower_case": true,
48
+ "mask_token": "[MASK]",
49
+ "max_length": 128,
50
+ "model_max_length": 128,
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": null,
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