Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper • 1908.10084 • Published • 14
How to use adugeen/phrases-reranker-e5-base with sentence-transformers:
from sentence_transformers import SentenceTransformer
model = SentenceTransformer("adugeen/phrases-reranker-e5-base")
sentences = [
"Instruct: Given a dialogue context, retrieve relevant followup phrase that align with the context\nDialogue Context: bot_0: Do you like gaming. I am a big fan.\nbot_1: My kids play games but I don't play much. I love to watch movies!.\nbot_0: Oh really what is their favorite game?\nbot_1: I think it's called fortnite. I sometimes watch while cooking healthy meals. What's yours?\nbot_0: The best game I like to play is alistar.\nbot_1: Never heard of it. Old timer here! Just turned 30. What other things do you like?",
"Followup phrase: I usually only eat them when my kids want them, it's not something that I'll make for myself. What's your favorite dip for chicken nuggets?",
"Followup phrase: My big doberman lays on me all the time and ripped mine off",
"Followup phrase: Yeah, he also got me into cars."
]
embeddings = model.encode(sentences)
similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [4, 4]This is a sentence-transformers model finetuned from intfloat/multilingual-e5-base. It maps sentences & paragraphs to a 768-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more.
SentenceTransformer(
(0): Transformer({'max_seq_length': 512, 'do_lower_case': False}) with Transformer model: XLMRobertaModel
(1): Pooling({'word_embedding_dimension': 768, '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})
(2): Normalize()
)
First install the Sentence Transformers library:
pip install -U sentence-transformers
Then you can load this model and run inference.
from sentence_transformers import SentenceTransformer
# Download from the 🤗 Hub
model = SentenceTransformer("sentence_transformers_model_id")
# Run inference
sentences = [
"Instruct: Given a dialogue context, retrieve relevant followup phrase that align with the context\nDialogue Context: bot_0: Hello, I just got back from class. What are you doing?\nbot_1: I just got done working out at the gym.\nbot_0: Cool, what is your favorite exercise?\nbot_1: Do you have your own vehicle?\nbot_0: No, I am a student. I walk everywhere or I take the bus.\nbot_1: Oh wow, that must get tiring. Do you have a significant other?\nbot_0: It's not, I even have energy to play baseball. I do not, I am single.\nbot_1: Thats awesome that you have the energy. My significant other is a lawyer. We're married..\nbot_0: Awe, I hope to have a job designing ads one day.\nbot_1: That sounds neat. Are you a vegetarian?\nbot_0: No, but have thought about it!",
'Followup phrase: I do not. My husband wants a boy, he is in the army.',
'Followup phrase: I am amazing, except I found out I am allergic to fish!',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 768]
# Get the similarity scores for the embeddings
similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [3, 3]
BinaryClassificationEvaluator| Metric | Value |
|---|---|
| cosine_accuracy | 0.9325 |
| cosine_accuracy_threshold | 0.6963 |
| cosine_f1 | 0.7933 |
| cosine_f1_threshold | 0.6896 |
| cosine_precision | 0.7918 |
| cosine_recall | 0.7948 |
| cosine_ap | 0.8752 |
| cosine_mcc | 0.7518 |
sentence1 and sentence2| sentence1 | sentence2 | |
|---|---|---|
| type | string | string |
| details |
|
|
| sentence1 | sentence2 |
|---|---|
Instruct: Given a dialogue context, retrieve relevant followup phrase that align with the context |
Followup phrase: I don't own my own car! I actually really enjoying walking and running, but then again, I live in a small town and semi-close to work. |
Instruct: Given a dialogue context, retrieve relevant followup phrase that align with the context |
Followup phrase: Ah I see! I like going to the gym to work out. |
Instruct: Given a dialogue context, retrieve relevant followup phrase that align with the context |
Followup phrase: I'm a computer programmer. What do you do for work. |
MultipleNegativesRankingLoss with these parameters:{
"scale": 100,
"similarity_fct": "cos_sim"
}
sentence1, sentence2, and label| sentence1 | sentence2 | label | |
|---|---|---|---|
| type | string | string | int |
| details |
|
|
|
| sentence1 | sentence2 | label |
|---|---|---|
Instruct: Given a dialogue context, retrieve relevant followup phrase that align with the context |
Followup phrase: Yes, you could say it is a great source of joy for me. |
1 |
Instruct: Given a dialogue context, retrieve relevant followup phrase that align with the context |
Followup phrase: That sounds amazing! But I was thinking of going to mexico this summer and was going to ask if you were going to be there? Would your timeshare be available? |
0 |
Instruct: Given a dialogue context, retrieve relevant followup phrase that align with the context |
Followup phrase: Mostly just authentic mexican food, with lots of spice. |
0 |
MultipleNegativesRankingLoss with these parameters:{
"scale": 100,
"similarity_fct": "cos_sim"
}
eval_strategy: epochper_device_train_batch_size: 100per_device_eval_batch_size: 100weight_decay: 0.01num_train_epochs: 5bf16: Trueload_best_model_at_end: Trueprompts: {'sentence1': 'Instruct: Given a dialogue context, retrieve relevant followup phrase that align with the context\nDialogue Context: ', 'sentence2': 'Followup phrase: '}batch_sampler: no_duplicatesoverwrite_output_dir: Falsedo_predict: Falseeval_strategy: epochprediction_loss_only: Trueper_device_train_batch_size: 100per_device_eval_batch_size: 100per_gpu_train_batch_size: Noneper_gpu_eval_batch_size: Nonegradient_accumulation_steps: 1eval_accumulation_steps: Nonetorch_empty_cache_steps: Nonelearning_rate: 5e-05weight_decay: 0.01adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08max_grad_norm: 1.0num_train_epochs: 5max_steps: -1lr_scheduler_type: linearlr_scheduler_kwargs: {}warmup_ratio: 0.0warmup_steps: 0log_level: passivelog_level_replica: warninglog_on_each_node: Truelogging_nan_inf_filter: Truesave_safetensors: Truesave_on_each_node: Falsesave_only_model: Falserestore_callback_states_from_checkpoint: Falseno_cuda: Falseuse_cpu: Falseuse_mps_device: Falseseed: 42data_seed: Nonejit_mode_eval: Falseuse_ipex: Falsebf16: Truefp16: Falsefp16_opt_level: O1half_precision_backend: autobf16_full_eval: Falsefp16_full_eval: Falsetf32: Nonelocal_rank: 0ddp_backend: Nonetpu_num_cores: Nonetpu_metrics_debug: Falsedebug: []dataloader_drop_last: Falsedataloader_num_workers: 0dataloader_prefetch_factor: Nonepast_index: -1disable_tqdm: Falseremove_unused_columns: Truelabel_names: Noneload_best_model_at_end: Trueignore_data_skip: Falsefsdp: []fsdp_min_num_params: 0fsdp_config: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}fsdp_transformer_layer_cls_to_wrap: Noneaccelerator_config: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}deepspeed: Nonelabel_smoothing_factor: 0.0optim: adamw_torchoptim_args: Noneadafactor: Falsegroup_by_length: Falselength_column_name: lengthddp_find_unused_parameters: Noneddp_bucket_cap_mb: Noneddp_broadcast_buffers: Falsedataloader_pin_memory: Truedataloader_persistent_workers: Falseskip_memory_metrics: Trueuse_legacy_prediction_loop: Falsepush_to_hub: Falseresume_from_checkpoint: Nonehub_model_id: Nonehub_strategy: every_savehub_private_repo: Nonehub_always_push: Falsegradient_checkpointing: Falsegradient_checkpointing_kwargs: Noneinclude_inputs_for_metrics: Falseinclude_for_metrics: []eval_do_concat_batches: Truefp16_backend: autopush_to_hub_model_id: Nonepush_to_hub_organization: Nonemp_parameters: auto_find_batch_size: Falsefull_determinism: Falsetorchdynamo: Noneray_scope: lastddp_timeout: 1800torch_compile: Falsetorch_compile_backend: Nonetorch_compile_mode: Noneinclude_tokens_per_second: Falseinclude_num_input_tokens_seen: Falseneftune_noise_alpha: Noneoptim_target_modules: Nonebatch_eval_metrics: Falseeval_on_start: Falseuse_liger_kernel: Falseeval_use_gather_object: Falseaverage_tokens_across_devices: Falseprompts: {'sentence1': 'Instruct: Given a dialogue context, retrieve relevant followup phrase that align with the context\nDialogue Context: ', 'sentence2': 'Followup phrase: '}batch_sampler: no_duplicatesmulti_dataset_batch_sampler: proportional| Epoch | Step | Training Loss | Validation Loss | cosine_ap |
|---|---|---|---|---|
| 0.1013 | 100 | 1.8292 | - | - |
| 0.2026 | 200 | 1.4433 | - | - |
| 0.3040 | 300 | 1.2605 | - | - |
| 0.4053 | 400 | 1.1947 | - | - |
| 0.5066 | 500 | 1.1714 | - | - |
| 0.6079 | 600 | 1.1106 | - | - |
| 0.7092 | 700 | 1.0978 | - | - |
| 0.8105 | 800 | 1.0527 | - | - |
| 0.9119 | 900 | 1.0524 | - | - |
| 1.0 | 987 | - | 8.1109 | 0.8790 |
| 1.0132 | 1000 | 1.0068 | - | - |
| 1.1145 | 1100 | 0.949 | - | - |
| 1.2158 | 1200 | 0.9519 | - | - |
| 1.3171 | 1300 | 0.9364 | - | - |
| 1.4184 | 1400 | 0.9253 | - | - |
| 1.5198 | 1500 | 0.9724 | - | - |
| 1.6211 | 1600 | 0.9227 | - | - |
| 1.7224 | 1700 | 0.9169 | - | - |
| 1.8237 | 1800 | 0.9146 | - | - |
| 1.9250 | 1900 | 0.9029 | - | - |
| 2.0 | 1974 | - | 8.4529 | 0.8727 |
| 2.0263 | 2000 | 0.9073 | - | - |
| 2.1277 | 2100 | 0.8685 | - | - |
| 2.2290 | 2200 | 0.8413 | - | - |
| 2.3303 | 2300 | 0.8763 | - | - |
| 2.4316 | 2400 | 0.8524 | - | - |
| 2.5329 | 2500 | 0.8729 | - | - |
| 2.6342 | 2600 | 0.856 | - | - |
| 2.7356 | 2700 | 0.8652 | - | - |
| 2.8369 | 2800 | 0.8768 | - | - |
| 2.9382 | 2900 | 0.8477 | - | - |
| 3.0 | 2961 | - | 8.7662 | 0.8752 |
@inproceedings{reimers-2019-sentence-bert,
title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks",
author = "Reimers, Nils and Gurevych, Iryna",
booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing",
month = "11",
year = "2019",
publisher = "Association for Computational Linguistics",
url = "https://arxiv.org/abs/1908.10084",
}
@misc{henderson2017efficient,
title={Efficient Natural Language Response Suggestion for Smart Reply},
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},
year={2017},
eprint={1705.00652},
archivePrefix={arXiv},
primaryClass={cs.CL}
}
Base model
intfloat/multilingual-e5-base