ntproctor commited on
Commit
7f88b08
·
verified ·
1 Parent(s): ca7db9c

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,349 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ tags:
3
+ - sentence-transformers
4
+ - sentence-similarity
5
+ - feature-extraction
6
+ - generated_from_trainer
7
+ - dataset_size:39
8
+ - loss:MultipleNegativesRankingLoss
9
+ base_model: sentence-transformers/multi-qa-MiniLM-L6-cos-v1
10
+ widget:
11
+ - source_sentence: What topics are covered in the junior Physics course?
12
+ sentences:
13
+ - Modeling real-world situations using algebra, geometry, trigonometry, and statistics.
14
+ - At WPI (Worcester Polytechnic Institute), as full-time students.
15
+ - Mechanics, gravitation, electricity, magnetism, waves, and harmonic oscillations.
16
+ - source_sentence: How are students supported during their college application process?
17
+ sentences:
18
+ - Approximately 100 hours.
19
+ - They meet regularly with the college counselor and faculty advisors.
20
+ - '2:45'
21
+ - source_sentence: What is the role of Ms. Julie?
22
+ sentences:
23
+ - Ms. Burns.
24
+ - Independent research and engineering projects, including a school-wide science
25
+ fair.
26
+ - Operations Manager.
27
+ - source_sentence: What is the role of Ms. Post at Mass Academy?
28
+ sentences:
29
+ - Ms. Small.
30
+ - College Advisor.
31
+ - Dr. Kevin Crowthers.
32
+ - source_sentence: What courses do seniors take at WPI?
33
+ sentences:
34
+ - Ms. Wildfong.
35
+ - Courses in Mathematics, Science, and Humanities.
36
+ - They study web design, object-oriented programming, app development, and software
37
+ engineering.
38
+ pipeline_tag: sentence-similarity
39
+ library_name: sentence-transformers
40
+ ---
41
+
42
+ # SentenceTransformer based on sentence-transformers/multi-qa-MiniLM-L6-cos-v1
43
+
44
+ This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [sentence-transformers/multi-qa-MiniLM-L6-cos-v1](https://huggingface.co/sentence-transformers/multi-qa-MiniLM-L6-cos-v1). 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.
45
+
46
+ ## Model Details
47
+
48
+ ### Model Description
49
+ - **Model Type:** Sentence Transformer
50
+ - **Base model:** [sentence-transformers/multi-qa-MiniLM-L6-cos-v1](https://huggingface.co/sentence-transformers/multi-qa-MiniLM-L6-cos-v1) <!-- at revision b207367332321f8e44f96e224ef15bc607f4dbf0 -->
51
+ - **Maximum Sequence Length:** 512 tokens
52
+ - **Output Dimensionality:** 384 dimensions
53
+ - **Similarity Function:** Cosine Similarity
54
+ <!-- - **Training Dataset:** Unknown -->
55
+ <!-- - **Language:** Unknown -->
56
+ <!-- - **License:** Unknown -->
57
+
58
+ ### Model Sources
59
+
60
+ - **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
61
+ - **Repository:** [Sentence Transformers on GitHub](https://github.com/UKPLab/sentence-transformers)
62
+ - **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers)
63
+
64
+ ### Full Model Architecture
65
+
66
+ ```
67
+ SentenceTransformer(
68
+ (0): Transformer({'max_seq_length': 512, 'do_lower_case': False}) with Transformer model: BertModel
69
+ (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})
70
+ (2): Normalize()
71
+ )
72
+ ```
73
+
74
+ ## Usage
75
+
76
+ ### Direct Usage (Sentence Transformers)
77
+
78
+ First install the Sentence Transformers library:
79
+
80
+ ```bash
81
+ pip install -U sentence-transformers
82
+ ```
83
+
84
+ Then you can load this model and run inference.
85
+ ```python
86
+ from sentence_transformers import SentenceTransformer
87
+
88
+ # Download from the 🤗 Hub
89
+ model = SentenceTransformer("ntproctor/mass-academy-faq-embedder")
90
+ # Run inference
91
+ sentences = [
92
+ 'What courses do seniors take at WPI?',
93
+ 'Courses in Mathematics, Science, and Humanities.',
94
+ 'They study web design, object-oriented programming, app development, and software engineering.',
95
+ ]
96
+ embeddings = model.encode(sentences)
97
+ print(embeddings.shape)
98
+ # [3, 384]
99
+
100
+ # Get the similarity scores for the embeddings
101
+ similarities = model.similarity(embeddings, embeddings)
102
+ print(similarities.shape)
103
+ # [3, 3]
104
+ ```
105
+
106
+ <!--
107
+ ### Direct Usage (Transformers)
108
+
109
+ <details><summary>Click to see the direct usage in Transformers</summary>
110
+
111
+ </details>
112
+ -->
113
+
114
+ <!--
115
+ ### Downstream Usage (Sentence Transformers)
116
+
117
+ You can finetune this model on your own dataset.
118
+
119
+ <details><summary>Click to expand</summary>
120
+
121
+ </details>
122
+ -->
123
+
124
+ <!--
125
+ ### Out-of-Scope Use
126
+
127
+ *List how the model may foreseeably be misused and address what users ought not to do with the model.*
128
+ -->
129
+
130
+ <!--
131
+ ## Bias, Risks and Limitations
132
+
133
+ *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.*
134
+ -->
135
+
136
+ <!--
137
+ ### Recommendations
138
+
139
+ *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.*
140
+ -->
141
+
142
+ ## Training Details
143
+
144
+ ### Training Dataset
145
+
146
+ #### Unnamed Dataset
147
+
148
+ * Size: 39 training samples
149
+ * Columns: <code>sentence_0</code> and <code>sentence_1</code>
150
+ * Approximate statistics based on the first 39 samples:
151
+ | | sentence_0 | sentence_1 |
152
+ |:--------|:----------------------------------------------------------------------------------|:----------------------------------------------------------------------------------|
153
+ | type | string | string |
154
+ | details | <ul><li>min: 6 tokens</li><li>mean: 11.54 tokens</li><li>max: 17 tokens</li></ul> | <ul><li>min: 5 tokens</li><li>mean: 13.44 tokens</li><li>max: 24 tokens</li></ul> |
155
+ * Samples:
156
+ | sentence_0 | sentence_1 |
157
+ |:------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------|
158
+ | <code>How are students supported during their college application process?</code> | <code>They meet regularly with the college counselor and faculty advisors.</code> |
159
+ | <code>What kind of projects are done during the engineering portion of STEM?</code> | <code>Assistive technology devices designed and built for real clients.</code> |
160
+ | <code>Who teaches Wellness?</code> | <code>Ms. Liz.</code> |
161
+ * Loss: [<code>MultipleNegativesRankingLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#multiplenegativesrankingloss) with these parameters:
162
+ ```json
163
+ {
164
+ "scale": 20.0,
165
+ "similarity_fct": "cos_sim"
166
+ }
167
+ ```
168
+
169
+ ### Training Hyperparameters
170
+ #### Non-Default Hyperparameters
171
+
172
+ - `num_train_epochs`: 50
173
+ - `multi_dataset_batch_sampler`: round_robin
174
+
175
+ #### All Hyperparameters
176
+ <details><summary>Click to expand</summary>
177
+
178
+ - `overwrite_output_dir`: False
179
+ - `do_predict`: False
180
+ - `eval_strategy`: no
181
+ - `prediction_loss_only`: True
182
+ - `per_device_train_batch_size`: 8
183
+ - `per_device_eval_batch_size`: 8
184
+ - `per_gpu_train_batch_size`: None
185
+ - `per_gpu_eval_batch_size`: None
186
+ - `gradient_accumulation_steps`: 1
187
+ - `eval_accumulation_steps`: None
188
+ - `torch_empty_cache_steps`: None
189
+ - `learning_rate`: 5e-05
190
+ - `weight_decay`: 0.0
191
+ - `adam_beta1`: 0.9
192
+ - `adam_beta2`: 0.999
193
+ - `adam_epsilon`: 1e-08
194
+ - `max_grad_norm`: 1
195
+ - `num_train_epochs`: 50
196
+ - `max_steps`: -1
197
+ - `lr_scheduler_type`: linear
198
+ - `lr_scheduler_kwargs`: {}
199
+ - `warmup_ratio`: 0.0
200
+ - `warmup_steps`: 0
201
+ - `log_level`: passive
202
+ - `log_level_replica`: warning
203
+ - `log_on_each_node`: True
204
+ - `logging_nan_inf_filter`: True
205
+ - `save_safetensors`: True
206
+ - `save_on_each_node`: False
207
+ - `save_only_model`: False
208
+ - `restore_callback_states_from_checkpoint`: False
209
+ - `no_cuda`: False
210
+ - `use_cpu`: False
211
+ - `use_mps_device`: False
212
+ - `seed`: 42
213
+ - `data_seed`: None
214
+ - `jit_mode_eval`: False
215
+ - `use_ipex`: False
216
+ - `bf16`: False
217
+ - `fp16`: False
218
+ - `fp16_opt_level`: O1
219
+ - `half_precision_backend`: auto
220
+ - `bf16_full_eval`: False
221
+ - `fp16_full_eval`: False
222
+ - `tf32`: None
223
+ - `local_rank`: 0
224
+ - `ddp_backend`: None
225
+ - `tpu_num_cores`: None
226
+ - `tpu_metrics_debug`: False
227
+ - `debug`: []
228
+ - `dataloader_drop_last`: False
229
+ - `dataloader_num_workers`: 0
230
+ - `dataloader_prefetch_factor`: None
231
+ - `past_index`: -1
232
+ - `disable_tqdm`: False
233
+ - `remove_unused_columns`: True
234
+ - `label_names`: None
235
+ - `load_best_model_at_end`: False
236
+ - `ignore_data_skip`: False
237
+ - `fsdp`: []
238
+ - `fsdp_min_num_params`: 0
239
+ - `fsdp_config`: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}
240
+ - `tp_size`: 0
241
+ - `fsdp_transformer_layer_cls_to_wrap`: None
242
+ - `accelerator_config`: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}
243
+ - `deepspeed`: None
244
+ - `label_smoothing_factor`: 0.0
245
+ - `optim`: adamw_torch
246
+ - `optim_args`: None
247
+ - `adafactor`: False
248
+ - `group_by_length`: False
249
+ - `length_column_name`: length
250
+ - `ddp_find_unused_parameters`: None
251
+ - `ddp_bucket_cap_mb`: None
252
+ - `ddp_broadcast_buffers`: False
253
+ - `dataloader_pin_memory`: True
254
+ - `dataloader_persistent_workers`: False
255
+ - `skip_memory_metrics`: True
256
+ - `use_legacy_prediction_loop`: False
257
+ - `push_to_hub`: False
258
+ - `resume_from_checkpoint`: None
259
+ - `hub_model_id`: None
260
+ - `hub_strategy`: every_save
261
+ - `hub_private_repo`: None
262
+ - `hub_always_push`: False
263
+ - `gradient_checkpointing`: False
264
+ - `gradient_checkpointing_kwargs`: None
265
+ - `include_inputs_for_metrics`: False
266
+ - `include_for_metrics`: []
267
+ - `eval_do_concat_batches`: True
268
+ - `fp16_backend`: auto
269
+ - `push_to_hub_model_id`: None
270
+ - `push_to_hub_organization`: None
271
+ - `mp_parameters`:
272
+ - `auto_find_batch_size`: False
273
+ - `full_determinism`: False
274
+ - `torchdynamo`: None
275
+ - `ray_scope`: last
276
+ - `ddp_timeout`: 1800
277
+ - `torch_compile`: False
278
+ - `torch_compile_backend`: None
279
+ - `torch_compile_mode`: None
280
+ - `include_tokens_per_second`: False
281
+ - `include_num_input_tokens_seen`: False
282
+ - `neftune_noise_alpha`: None
283
+ - `optim_target_modules`: None
284
+ - `batch_eval_metrics`: False
285
+ - `eval_on_start`: False
286
+ - `use_liger_kernel`: False
287
+ - `eval_use_gather_object`: False
288
+ - `average_tokens_across_devices`: False
289
+ - `prompts`: None
290
+ - `batch_sampler`: batch_sampler
291
+ - `multi_dataset_batch_sampler`: round_robin
292
+
293
+ </details>
294
+
295
+ ### Framework Versions
296
+ - Python: 3.12.0
297
+ - Sentence Transformers: 4.1.0
298
+ - Transformers: 4.51.3
299
+ - PyTorch: 2.7.0
300
+ - Accelerate: 1.6.0
301
+ - Datasets: 3.5.1
302
+ - Tokenizers: 0.21.1
303
+
304
+ ## Citation
305
+
306
+ ### BibTeX
307
+
308
+ #### Sentence Transformers
309
+ ```bibtex
310
+ @inproceedings{reimers-2019-sentence-bert,
311
+ title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks",
312
+ author = "Reimers, Nils and Gurevych, Iryna",
313
+ booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing",
314
+ month = "11",
315
+ year = "2019",
316
+ publisher = "Association for Computational Linguistics",
317
+ url = "https://arxiv.org/abs/1908.10084",
318
+ }
319
+ ```
320
+
321
+ #### MultipleNegativesRankingLoss
322
+ ```bibtex
323
+ @misc{henderson2017efficient,
324
+ title={Efficient Natural Language Response Suggestion for Smart Reply},
325
+ author={Matthew Henderson and Rami Al-Rfou and Brian Strope and Yun-hsuan Sung and Laszlo Lukacs and Ruiqi Guo and Sanjiv Kumar and Balint Miklos and Ray Kurzweil},
326
+ year={2017},
327
+ eprint={1705.00652},
328
+ archivePrefix={arXiv},
329
+ primaryClass={cs.CL}
330
+ }
331
+ ```
332
+
333
+ <!--
334
+ ## Glossary
335
+
336
+ *Clearly define terms in order to be accessible across audiences.*
337
+ -->
338
+
339
+ <!--
340
+ ## Model Card Authors
341
+
342
+ *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.*
343
+ -->
344
+
345
+ <!--
346
+ ## Model Card Contact
347
+
348
+ *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.*
349
+ -->
config.json ADDED
@@ -0,0 +1,25 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "architectures": [
3
+ "BertModel"
4
+ ],
5
+ "attention_probs_dropout_prob": 0.1,
6
+ "classifier_dropout": null,
7
+ "gradient_checkpointing": false,
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.51.3",
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": "4.1.0",
4
+ "transformers": "4.51.3",
5
+ "pytorch": "2.7.0"
6
+ },
7
+ "prompts": {},
8
+ "default_prompt_name": null,
9
+ "similarity_fn_name": "cosine"
10
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:13c64c3f03e8c83b1b11e10f4db9a9d6a81469160db8c5226c14899a4c0c7b84
3
+ size 90864192
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": 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,65 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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": false,
45
+ "cls_token": "[CLS]",
46
+ "do_basic_tokenize": true,
47
+ "do_lower_case": true,
48
+ "extra_special_tokens": {},
49
+ "mask_token": "[MASK]",
50
+ "max_length": 250,
51
+ "model_max_length": 512,
52
+ "never_split": null,
53
+ "pad_to_multiple_of": null,
54
+ "pad_token": "[PAD]",
55
+ "pad_token_type_id": 0,
56
+ "padding_side": "right",
57
+ "sep_token": "[SEP]",
58
+ "stride": 0,
59
+ "strip_accents": null,
60
+ "tokenize_chinese_chars": true,
61
+ "tokenizer_class": "BertTokenizer",
62
+ "truncation_side": "right",
63
+ "truncation_strategy": "longest_first",
64
+ "unk_token": "[UNK]"
65
+ }
vocab.txt ADDED
The diff for this file is too large to render. See raw diff