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 = [
['What was the 2011 Census population of this village and civil parish in Lincolnshire, where Regents Academy is based?', 'Manby. Manby is a village and civil parish in the East Lindsey district of Lincolnshire, England, and lies approximately 5 mi east from Louth. The 2001 Census recorded a village population of 833, reducing to 759 at the 2011 Census.'],
['Piña colada and Aperol Spritz can both be described as what kind of drink?', '2-Acetylpyridine. 2-Acetylpyridine is an organic compound with the formula CH3COC5H4N. It is a viscous colorless liquid that is widely used as a flavoring substance. It is found in malt and produced by the Maillard reaction and by nixtamalization. It contributes to the flavor of corn tortillas, popcorn, and beer.'],
['What song by a Barbadian singer was covered by Marié Christina Digby?', 'Umbrella (song). "Umbrella" is a song by Barbadian singer Rihanna from her third studio album "Good Girl Gone Bad" (2007). It features American rapper Jay-Z, who co-wrote the song with its producers Tricky Stewart and Kuk Harrell, with additional writing from The-Dream. The song was originally written with Britney Spears in mind, but her label rejected it. "Umbrella" is a pop, hip hop and R&B song referring to a romantic and platonic relationship and the strength of that relationship.'],
["When was the Roman politician and general died during who's reign Gaius Nasennius were soldiers?", "Narses. Narses (also sometimes written Nerses; Armenian: Նարսես ; Greek: Ναρσής ; 478–573) was, with Belisarius, one of the great generals in the service of the Byzantine Emperor Justinian I during the Roman reconquest that took place during Justinian's reign. A Romanized Armenian, Narses spent most of his life as an important eunuch in the palace of the emperors in Constantinople."],
['California Tortilla was voted as having the best burritos in both 2009 and 2010 by a magazine founded in what year?', 'California Tortilla. California Tortilla, also known as CalTort, is a chain of franchised fast casual Mexican-style restaurants, the first of which was opened in August 1995 in Bethesda, Maryland by business partners Pam Felix and Alan Cohen. The chain\'s menu, which features Mission burritos, is comparable to that of its competitors, such as Baja Fresh and Chipotle Mexican Grill. A typical restaurant has 2500 sqft with seating for 75 people. California Tortilla was voted by readers of "Washingtonian" magazine as having the best burritos in both 2009 and 2010, and "best Mexican" in 2014 and 2015. The chain sold its 5 millionth burrito on August 22, 2007.'],
]
scores = model.predict(pairs)
print(scores.shape)
# (5,)
# Or rank different texts based on similarity to a single text
ranks = model.rank(
'What was the 2011 Census population of this village and civil parish in Lincolnshire, where Regents Academy is based?',
[
'Manby. Manby is a village and civil parish in the East Lindsey district of Lincolnshire, England, and lies approximately 5 mi east from Louth. The 2001 Census recorded a village population of 833, reducing to 759 at the 2011 Census.',
'2-Acetylpyridine. 2-Acetylpyridine is an organic compound with the formula CH3COC5H4N. It is a viscous colorless liquid that is widely used as a flavoring substance. It is found in malt and produced by the Maillard reaction and by nixtamalization. It contributes to the flavor of corn tortillas, popcorn, and beer.',
'Umbrella (song). "Umbrella" is a song by Barbadian singer Rihanna from her third studio album "Good Girl Gone Bad" (2007). It features American rapper Jay-Z, who co-wrote the song with its producers Tricky Stewart and Kuk Harrell, with additional writing from The-Dream. The song was originally written with Britney Spears in mind, but her label rejected it. "Umbrella" is a pop, hip hop and R&B song referring to a romantic and platonic relationship and the strength of that relationship.',
"Narses. Narses (also sometimes written Nerses; Armenian: Նարսես ; Greek: Ναρσής ; 478–573) was, with Belisarius, one of the great generals in the service of the Byzantine Emperor Justinian I during the Roman reconquest that took place during Justinian's reign. A Romanized Armenian, Narses spent most of his life as an important eunuch in the palace of the emperors in Constantinople.",
'California Tortilla. California Tortilla, also known as CalTort, is a chain of franchised fast casual Mexican-style restaurants, the first of which was opened in August 1995 in Bethesda, Maryland by business partners Pam Felix and Alan Cohen. The chain\'s menu, which features Mission burritos, is comparable to that of its competitors, such as Baja Fresh and Chipotle Mexican Grill. A typical restaurant has 2500 sqft with seating for 75 people. California Tortilla was voted by readers of "Washingtonian" magazine as having the best burritos in both 2009 and 2010, and "best Mexican" in 2014 and 2015. The chain sold its 5 millionth burrito on August 22, 2007.',
]
)
# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]
validation and train_subsetCEBinaryClassificationEvaluator| Metric | validation | train_subset |
|---|---|---|
| accuracy | 0.9367 | 0.908 |
| accuracy_threshold | 0.7832 | 0.9297 |
| f1 | 0.9389 | 0.9132 |
| f1_threshold | 0.7832 | 0.8477 |
| precision | 0.9068 | 0.8897 |
| recall | 0.9733 | 0.938 |
| average_precision | 0.9587 | 0.9412 |
sentence_0, sentence_1, and label| sentence_0 | sentence_1 | label | |
|---|---|---|---|
| type | string | string | float |
| details |
|
|
|
| sentence_0 | sentence_1 | label |
|---|---|---|
What was the 2011 Census population of this village and civil parish in Lincolnshire, where Regents Academy is based? |
Manby. Manby is a village and civil parish in the East Lindsey district of Lincolnshire, England, and lies approximately 5 mi east from Louth. The 2001 Census recorded a village population of 833, reducing to 759 at the 2011 Census. |
1.0 |
Piña colada and Aperol Spritz can both be described as what kind of drink? |
2-Acetylpyridine. 2-Acetylpyridine is an organic compound with the formula CH3COC5H4N. It is a viscous colorless liquid that is widely used as a flavoring substance. It is found in malt and produced by the Maillard reaction and by nixtamalization. It contributes to the flavor of corn tortillas, popcorn, and beer. |
0.0 |
What song by a Barbadian singer was covered by Marié Christina Digby? |
Umbrella (song). "Umbrella" is a song by Barbadian singer Rihanna from her third studio album "Good Girl Gone Bad" (2007). It features American rapper Jay-Z, who co-wrote the song with its producers Tricky Stewart and Kuk Harrell, with additional writing from The-Dream. The song was originally written with Britney Spears in mind, but her label rejected it. "Umbrella" is a pop, hip hop and R&B song referring to a romantic and platonic relationship and the strength of that relationship. |
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 | Training Loss | validation_average_precision | train_subset_average_precision |
|---|---|---|---|---|
| 0.125 | 250 | - | 0.9311 | 0.9034 |
| 0.25 | 500 | 0.4545 | 0.9403 | 0.9061 |
| 0.375 | 750 | - | 0.9398 | 0.9220 |
| 0.5 | 1000 | 0.3954 | 0.9485 | 0.9292 |
| 0.625 | 1250 | - | 0.9500 | 0.9263 |
| 0.75 | 1500 | 0.3922 | 0.9519 | 0.9235 |
| 0.875 | 1750 | - | 0.9556 | 0.9224 |
| 1.0 | 2000 | 0.4131 | 0.9587 | 0.9412 |
@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