Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper
• 1908.10084 • Published
• 12
This is a Cross Encoder model finetuned from BAAI/bge-reranker-v2-m3 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("cross_encoder_model_id")
# Get scores for pairs of texts
pairs = [
["Who is the mother of Cyril Holland's father?", 'Cecilia of Normandy. Cecilia of Normandy (or Cecily; c. 1056 – 30 July 1126) is thought to be the eldest daughter of William the Conqueror and Matilda of Flanders. Her brothers were kings William II and Henry I of England. She was very close to her other brother, Robert Curthose, and was educated by the abbess Matilda.'],
['Did the the agency David Rossi works for keep files on Elvis Presley?', '13 Hours: The Secret Soldiers of Benghazi. In 2012, Benghazi, Libya is named one of the most dangerous places in the world, and countries have pulled their diplomatic offices out of the country in fear of an attack by militants. The United States, however, still has a diplomatic compound (not an official consulate) open in the city. Less than a mile away is a CIA outpost called "The Annex", which is protected by a team of private military contractors from Global Response Staff (GRS). New to the detail is Jack Silva, who arrives in Benghazi and is picked up by Tyrone "Rone" Woods, commander of the GRS team and a personal friend of Silva. Arriving at the Annex, Silva is introduced to the rest of the GRS team and the CIA Chief of Station, who constantly gives the team strict reminders to never engage the citizens.'],
['How many murders were there in 2015 in the city that is the capital of the state where Wellesley College is in Mona Lisa Smile?', 'Boston. In addition to city government, numerous commissions and state authorities—including the Massachusetts Department of Conservation and Recreation, the Boston Public Health Commission, the Massachusetts Water Resources Authority (MWRA), and the Massachusetts Port Authority (Massport)—play a role in the life of Bostonians. As the capital of Massachusetts, Boston plays a major role in state politics.'],
['In which year did the company that made SS.11 end?', 'NUMMI. New United Motor Manufacturing, Inc. (NUMMI) was an automobile manufacturing company in Fremont, California, jointly owned by General Motors and Toyota that opened in 1984 and closed in 2010. On October 27, 2010, its former plant reopened as a 100% Tesla Motors-owned production facility, known as the Tesla Factory. The plant is located in the East Industrial area of Fremont between Interstate 880 and Interstate 680.'],
["What did Goa's country launch to send the mangalyaan to the planet where Arsia Chasmata was found?", 'Arsia Chasmata. Arsia Chasmata is a steep-sided depression located northeast of Arsia Mons in the Phoenicis Lacus quadrangle on Mars, located at 7.6° S and 119.3° W. It is 97\xa0km long and was named after an albedo name.'],
]
scores = model.predict(pairs)
print(scores.shape)
# (5,)
# Or rank different texts based on similarity to a single text
ranks = model.rank(
"Who is the mother of Cyril Holland's father?",
[
'Cecilia of Normandy. Cecilia of Normandy (or Cecily; c. 1056 – 30 July 1126) is thought to be the eldest daughter of William the Conqueror and Matilda of Flanders. Her brothers were kings William II and Henry I of England. She was very close to her other brother, Robert Curthose, and was educated by the abbess Matilda.',
'13 Hours: The Secret Soldiers of Benghazi. In 2012, Benghazi, Libya is named one of the most dangerous places in the world, and countries have pulled their diplomatic offices out of the country in fear of an attack by militants. The United States, however, still has a diplomatic compound (not an official consulate) open in the city. Less than a mile away is a CIA outpost called "The Annex", which is protected by a team of private military contractors from Global Response Staff (GRS). New to the detail is Jack Silva, who arrives in Benghazi and is picked up by Tyrone "Rone" Woods, commander of the GRS team and a personal friend of Silva. Arriving at the Annex, Silva is introduced to the rest of the GRS team and the CIA Chief of Station, who constantly gives the team strict reminders to never engage the citizens.',
'Boston. In addition to city government, numerous commissions and state authorities—including the Massachusetts Department of Conservation and Recreation, the Boston Public Health Commission, the Massachusetts Water Resources Authority (MWRA), and the Massachusetts Port Authority (Massport)—play a role in the life of Bostonians. As the capital of Massachusetts, Boston plays a major role in state politics.',
'NUMMI. New United Motor Manufacturing, Inc. (NUMMI) was an automobile manufacturing company in Fremont, California, jointly owned by General Motors and Toyota that opened in 1984 and closed in 2010. On October 27, 2010, its former plant reopened as a 100% Tesla Motors-owned production facility, known as the Tesla Factory. The plant is located in the East Industrial area of Fremont between Interstate 880 and Interstate 680.',
'Arsia Chasmata. Arsia Chasmata is a steep-sided depression located northeast of Arsia Mons in the Phoenicis Lacus quadrangle on Mars, located at 7.6° S and 119.3° W. It is 97\xa0km long and was named after an albedo name.',
]
)
# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]
validation and train_subsetCEBinaryClassificationEvaluator| Metric | validation | train_subset |
|---|---|---|
| accuracy | 0.9244 | 0.798 |
| accuracy_threshold | 0.0406 | 0.2206 |
| f1 | 0.9207 | 0.7837 |
| f1_threshold | 0.0406 | 0.0406 |
| precision | 0.9679 | 0.7186 |
| recall | 0.8779 | 0.8618 |
| average_precision | 0.9717 | 0.8546 |
sentence_0, sentence_1, and label| sentence_0 | sentence_1 | label | |
|---|---|---|---|
| type | string | string | float |
| details |
|
|
|
| sentence_0 | sentence_1 | label |
|---|---|---|
Who is the mother of Cyril Holland's father? |
Cecilia of Normandy. Cecilia of Normandy (or Cecily; c. 1056 – 30 July 1126) is thought to be the eldest daughter of William the Conqueror and Matilda of Flanders. Her brothers were kings William II and Henry I of England. She was very close to her other brother, Robert Curthose, and was educated by the abbess Matilda. |
0.0 |
Did the the agency David Rossi works for keep files on Elvis Presley? |
13 Hours: The Secret Soldiers of Benghazi. In 2012, Benghazi, Libya is named one of the most dangerous places in the world, and countries have pulled their diplomatic offices out of the country in fear of an attack by militants. The United States, however, still has a diplomatic compound (not an official consulate) open in the city. Less than a mile away is a CIA outpost called "The Annex", which is protected by a team of private military contractors from Global Response Staff (GRS). New to the detail is Jack Silva, who arrives in Benghazi and is picked up by Tyrone "Rone" Woods, commander of the GRS team and a personal friend of Silva. Arriving at the Annex, Silva is introduced to the rest of the GRS team and the CIA Chief of Station, who constantly gives the team strict reminders to never engage the citizens. |
0.0 |
How many murders were there in 2015 in the city that is the capital of the state where Wellesley College is in Mona Lisa Smile? |
Boston. In addition to city government, numerous commissions and state authorities—including the Massachusetts Department of Conservation and Recreation, the Boston Public Health Commission, the Massachusetts Water Resources Authority (MWRA), and the Massachusetts Port Authority (Massport)—play a role in the life of Bostonians. As the capital of Massachusetts, Boston plays a major role in state politics. |
1.0 |
BinaryCrossEntropyLoss with these parameters:{
"activation_fn": "torch.nn.modules.linear.Identity",
"pos_weight": null
}
eval_strategy: stepsper_device_train_batch_size: 2per_device_eval_batch_size: 2overwrite_output_dir: Falsedo_predict: Falseeval_strategy: stepsprediction_loss_only: Trueper_device_train_batch_size: 2per_device_eval_batch_size: 2per_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.0adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08max_grad_norm: 1num_train_epochs: 3max_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: Falsefp16: 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: Falseignore_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: Falsehub_always_push: Falsegradient_checkpointing: Falsegradient_checkpointing_kwargs: Noneinclude_inputs_for_metrics: Falseeval_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: Falseeval_use_gather_object: Falseprompts: Nonebatch_sampler: batch_samplermulti_dataset_batch_sampler: proportionalrouter_mapping: {}learning_rate_mapping: {}| Epoch | Step | validation_average_precision | train_subset_average_precision |
|---|---|---|---|
| 0.0214 | 100 | 0.9844 | 0.8233 |
| 0.0427 | 200 | 0.9819 | 0.8052 |
| 0.0641 | 300 | 0.9728 | 0.8689 |
| 0.0854 | 400 | 0.9717 | 0.8546 |
@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
BAAI/bge-reranker-v2-m3