Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper • 1908.10084 • Published • 14
How to use ayushexel/reranker-ms-marco-MiniLM-L6-v2-gooaq-bce with sentence-transformers:
from sentence_transformers import CrossEncoder
model = CrossEncoder("ayushexel/reranker-ms-marco-MiniLM-L6-v2-gooaq-bce")
query = "Which planet is known as the Red Planet?"
passages = [
"Venus is often called Earth's twin because of its similar size and proximity.",
"Mars, known for its reddish appearance, is often referred to as the Red Planet.",
"Jupiter, the largest planet in our solar system, has a prominent red spot.",
"Saturn, famous for its rings, is sometimes mistaken for the Red Planet."
]
scores = model.predict([(query, passage) for passage in passages])
print(scores)This is a Cross Encoder model finetuned from cross-encoder/ms-marco-MiniLM-L6-v2 using the sentence-transformers library. It computes scores for pairs of texts, which can be used for text reranking and semantic search.
First install the Sentence Transformers library:
pip install -U sentence-transformers
Then you can load this model and run inference.
from sentence_transformers import CrossEncoder
# Download from the 🤗 Hub
model = CrossEncoder("ayushexel/reranker-ms-marco-MiniLM-L6-v2-gooaq-bce")
# Get scores for pairs of texts
pairs = [
['what does it mean when you get a sharp pain in your left arm?', 'Pain in the left arm A pain in your left arm could mean you have a bone or joint injury, a pinched nerve, or a problem with your heart. Read on to learn more about the causes of left arm pain and what symptoms could signal a serious problem.'],
['what does it mean when you get a sharp pain in your left arm?', "In this Article Whether it's throbbing, aching, or sharp, everyone has been in pain. The uncomfortable sensation is a red flag. Pain in your armpit could mean that you've simply strained a muscle, which is eased with ice and rest. It could also be a sign of more serious conditions, like an infection or breast cancer."],
['what does it mean when you get a sharp pain in your left arm?', 'Sharp: When you feel a sudden, intense spike of pain, that qualifies as “sharp.” Sharp pain may also fit the descriptors cutting and shooting. Stabbing: Like sharp pain, stabbing pain occurs suddenly and intensely. However, stabbing pain may fade and reoccur many times.'],
['what does it mean when you get a sharp pain in your left arm?', 'Symptoms. A herniated disc in the neck can cause neck pain, radiating arm pain, shoulder pain, and numbness or tingling in the arm or hand. The quality and type of pain can vary from dull, aching, and difficult to localize to sharp, burning, and easy to pinpoint.'],
['what does it mean when you get a sharp pain in your left arm?', 'Injuries or trauma to any part of the arm or shoulder, including bone fractures, joint dislocations, and muscle strains and sprains, are common causes of arm pain. Sometimes diseases that affect other organs in the body, like peripheral vascular disease or arthritis, can be the cause of pain in the arm.'],
]
scores = model.predict(pairs)
print(scores.shape)
# (5,)
# Or rank different texts based on similarity to a single text
ranks = model.rank(
'what does it mean when you get a sharp pain in your left arm?',
[
'Pain in the left arm A pain in your left arm could mean you have a bone or joint injury, a pinched nerve, or a problem with your heart. Read on to learn more about the causes of left arm pain and what symptoms could signal a serious problem.',
"In this Article Whether it's throbbing, aching, or sharp, everyone has been in pain. The uncomfortable sensation is a red flag. Pain in your armpit could mean that you've simply strained a muscle, which is eased with ice and rest. It could also be a sign of more serious conditions, like an infection or breast cancer.",
'Sharp: When you feel a sudden, intense spike of pain, that qualifies as “sharp.” Sharp pain may also fit the descriptors cutting and shooting. Stabbing: Like sharp pain, stabbing pain occurs suddenly and intensely. However, stabbing pain may fade and reoccur many times.',
'Symptoms. A herniated disc in the neck can cause neck pain, radiating arm pain, shoulder pain, and numbness or tingling in the arm or hand. The quality and type of pain can vary from dull, aching, and difficult to localize to sharp, burning, and easy to pinpoint.',
'Injuries or trauma to any part of the arm or shoulder, including bone fractures, joint dislocations, and muscle strains and sprains, are common causes of arm pain. Sometimes diseases that affect other organs in the body, like peripheral vascular disease or arthritis, can be the cause of pain in the arm.',
]
)
# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]
gooaq-devCrossEncoderRerankingEvaluator with these parameters:{
"at_k": 10,
"always_rerank_positives": false
}
| Metric | Value |
|---|---|
| map | 0.6380 (+0.2121) |
| mrr@10 | 0.6361 (+0.2199) |
| ndcg@10 | 0.6822 (+0.2001) |
NanoMSMARCO_R100, NanoNFCorpus_R100 and NanoNQ_R100CrossEncoderRerankingEvaluator with these parameters:{
"at_k": 10,
"always_rerank_positives": true
}
| Metric | NanoMSMARCO_R100 | NanoNFCorpus_R100 | NanoNQ_R100 |
|---|---|---|---|
| map | 0.5437 (+0.0541) | 0.3885 (+0.1275) | 0.4626 (+0.0430) |
| mrr@10 | 0.5348 (+0.0573) | 0.5630 (+0.0632) | 0.4628 (+0.0361) |
| ndcg@10 | 0.6060 (+0.0655) | 0.4077 (+0.0827) | 0.5091 (+0.0084) |
NanoBEIR_R100_meanCrossEncoderNanoBEIREvaluator with these parameters:{
"dataset_names": [
"msmarco",
"nfcorpus",
"nq"
],
"rerank_k": 100,
"at_k": 10,
"always_rerank_positives": true
}
| Metric | Value |
|---|---|
| map | 0.4649 (+0.0749) |
| mrr@10 | 0.5202 (+0.0522) |
| ndcg@10 | 0.5076 (+0.0522) |
question, answer, and label| question | answer | label | |
|---|---|---|---|
| type | string | string | int |
| details |
|
|
|
| question | answer | label |
|---|---|---|
what does it mean when you get a sharp pain in your left arm? |
Pain in the left arm A pain in your left arm could mean you have a bone or joint injury, a pinched nerve, or a problem with your heart. Read on to learn more about the causes of left arm pain and what symptoms could signal a serious problem. |
1 |
what does it mean when you get a sharp pain in your left arm? |
In this Article Whether it's throbbing, aching, or sharp, everyone has been in pain. The uncomfortable sensation is a red flag. Pain in your armpit could mean that you've simply strained a muscle, which is eased with ice and rest. It could also be a sign of more serious conditions, like an infection or breast cancer. |
0 |
what does it mean when you get a sharp pain in your left arm? |
Sharp: When you feel a sudden, intense spike of pain, that qualifies as “sharp.” Sharp pain may also fit the descriptors cutting and shooting. Stabbing: Like sharp pain, stabbing pain occurs suddenly and intensely. However, stabbing pain may fade and reoccur many times. |
0 |
BinaryCrossEntropyLoss with these parameters:{
"activation_fn": "torch.nn.modules.linear.Identity",
"pos_weight": 7
}
eval_strategy: stepsper_device_train_batch_size: 2048per_device_eval_batch_size: 2048learning_rate: 2e-05warmup_ratio: 0.1seed: 12bf16: Truedataloader_num_workers: 12load_best_model_at_end: Trueoverwrite_output_dir: Falsedo_predict: Falseeval_strategy: stepsprediction_loss_only: Trueper_device_train_batch_size: 2048per_device_eval_batch_size: 2048per_gpu_train_batch_size: Noneper_gpu_eval_batch_size: Nonegradient_accumulation_steps: 1eval_accumulation_steps: Nonetorch_empty_cache_steps: Nonelearning_rate: 2e-05weight_decay: 0.0adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08max_grad_norm: 1.0num_train_epochs: 3max_steps: -1lr_scheduler_type: linearlr_scheduler_kwargs: {}warmup_ratio: 0.1warmup_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: 12data_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: 12dataloader_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}tp_size: 0fsdp_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: Nonedispatch_batches: Nonesplit_batches: 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: Nonebatch_sampler: batch_samplermulti_dataset_batch_sampler: proportional| Epoch | Step | Training Loss | gooaq-dev_ndcg@10 | NanoMSMARCO_R100_ndcg@10 | NanoNFCorpus_R100_ndcg@10 | NanoNQ_R100_ndcg@10 | NanoBEIR_R100_mean_ndcg@10 |
|---|---|---|---|---|---|---|---|
| -1 | -1 | - | 0.6371 (+0.1550) | 0.6686 (+0.1282) | 0.3930 (+0.0680) | 0.7599 (+0.2592) | 0.6072 (+0.1518) |
| 0.0009 | 1 | 2.1175 | - | - | - | - | - |
| 0.1842 | 200 | 1.1892 | - | - | - | - | - |
| 0.3683 | 400 | 0.676 | - | - | - | - | - |
| 0.5525 | 600 | 0.6268 | - | - | - | - | - |
| 0.7366 | 800 | 0.606 | - | - | - | - | - |
| 0.9208 | 1000 | 0.5933 | 0.6731 (+0.1910) | 0.6038 (+0.0634) | 0.4572 (+0.1321) | 0.5220 (+0.0213) | 0.5277 (+0.0723) |
| 1.1050 | 1200 | 0.5756 | - | - | - | - | - |
| 1.2891 | 1400 | 0.5625 | - | - | - | - | - |
| 1.4733 | 1600 | 0.5575 | - | - | - | - | - |
| 1.6575 | 1800 | 0.549 | - | - | - | - | - |
| 1.8416 | 2000 | 0.5475 | 0.6799 (+0.1977) | 0.6072 (+0.0667) | 0.4278 (+0.1028) | 0.5031 (+0.0024) | 0.5127 (+0.0573) |
| 2.0258 | 2200 | 0.5391 | - | - | - | - | - |
| 2.2099 | 2400 | 0.5276 | - | - | - | - | - |
| 2.3941 | 2600 | 0.5271 | - | - | - | - | - |
| 2.5783 | 2800 | 0.5264 | - | - | - | - | - |
| 2.7624 | 3000 | 0.5244 | 0.6822 (+0.2001) | 0.6060 (+0.0655) | 0.4077 (+0.0827) | 0.5091 (+0.0084) | 0.5076 (+0.0522) |
| 2.9466 | 3200 | 0.5235 | - | - | - | - | - |
| -1 | -1 | - | 0.6822 (+0.2001) | 0.6060 (+0.0655) | 0.4077 (+0.0827) | 0.5091 (+0.0084) | 0.5076 (+0.0522) |
@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",
}
Base model
microsoft/MiniLM-L12-H384-uncased