Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper
•
1908.10084
•
Published
•
11
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 = [
['Paloma and Monkey Gland, are what type of item?', "Monkey Gland. The Monkey Gland is a cocktail of gin, orange juice, grenadine and absinthe created in the 1920s by Harry MacElhone, owner of Harry's New York Bar in Paris, France."],
['Tess Asplund fought against the Neo-Nazi movement that existed in which countries?', 'Tess Asplund. Tess Asplund, born 1974, is a Swedish activist who gained attention following her protest against neo-Nazis in Borlänge, Sweden. David Lagerlof is the photographer of the viral image of Asplund, which shows her facing uniformed members of the Swedish Nordic Resistance Movement with her fist in the air. She is originally from Colombia and describes herself as Afro-Swedish. About the incident, Asplund is quoted as having said “If this picture of me can get more people to dare to show resistance, then it’s all good...the people must unite and show that it is not okay that racism is becoming normalised and that fascists are running around on our streets.”'],
['Which magazine, Arizona Highways or Adventist World, is published by Herald Publishing Association?', 'My Worlds: The Collection. My Worlds: The Collection is the first compilation album released by Canadian recording artist Justin Bieber. As the international alternative to the Walmart and Sam\'s Club exclusive "My Worlds Acoustic" (2010), "My Worlds: The Collection" was released in numerous European countries on November 19, 2010. The album consists of two discs; the first is a slightly altered version of "My Worlds Acoustic", and the second is "My Worlds", a compilation itself made up of "My World" (2009) and "My World 2.0" (2010). In addition, the album also features a new song, an inspirational ballad entitled "Pray", a Jaden Smith collaboration, "Never Say Never", and remixes of "Somebody to Love". The new versions of the songs were produced by Bieber\'s music director, Dan Kanter, his vocal producer Kuk Harrell, and also producer Rob Wells. While most reviewers complimented the set , several thought that its release was unneeded. The album charted moderately in Europe, reaching the top half of several album charts.'],
['Who made the sculpture of the an American professional baseball player and manager regarded as one of the greatest players in baseball history?', 'Ted Williams. Theodore Samuel Williams (August 30, 1918 – July 5, 2002) was an American professional baseball player and manager. He played his entire 19-year Major League Baseball (MLB) career as a left fielder for the Boston Red Sox from 1939 to 1960, only interrupted by service time during World War II and the Korean War. Nicknamed "The Kid", "The Splendid Splinter", "Teddy Ballgame", "The Thumper", and "The Greatest Hitter Who Ever Lived", Williams is regarded as one of the greatest players in baseball history. Williams was also an outstanding fielder, especially in the difficult left field of Fenway Park in Boston, where he played his entire Major League career at that position.'],
['Paul-Werner Krapke is notable for his management of a main battle tank developed by who?', 'Paul-Werner Krapke. Paul-Werner Krapke (born 1915) is a German armored fighting vehicle engineer, notable for his management of the Leopard 2 project.'],
]
scores = model.predict(pairs)
print(scores.shape)
# (5,)
# Or rank different texts based on similarity to a single text
ranks = model.rank(
'Paloma and Monkey Gland, are what type of item?',
[
"Monkey Gland. The Monkey Gland is a cocktail of gin, orange juice, grenadine and absinthe created in the 1920s by Harry MacElhone, owner of Harry's New York Bar in Paris, France.",
'Tess Asplund. Tess Asplund, born 1974, is a Swedish activist who gained attention following her protest against neo-Nazis in Borlänge, Sweden. David Lagerlof is the photographer of the viral image of Asplund, which shows her facing uniformed members of the Swedish Nordic Resistance Movement with her fist in the air. She is originally from Colombia and describes herself as Afro-Swedish. About the incident, Asplund is quoted as having said “If this picture of me can get more people to dare to show resistance, then it’s all good...the people must unite and show that it is not okay that racism is becoming normalised and that fascists are running around on our streets.”',
'My Worlds: The Collection. My Worlds: The Collection is the first compilation album released by Canadian recording artist Justin Bieber. As the international alternative to the Walmart and Sam\'s Club exclusive "My Worlds Acoustic" (2010), "My Worlds: The Collection" was released in numerous European countries on November 19, 2010. The album consists of two discs; the first is a slightly altered version of "My Worlds Acoustic", and the second is "My Worlds", a compilation itself made up of "My World" (2009) and "My World 2.0" (2010). In addition, the album also features a new song, an inspirational ballad entitled "Pray", a Jaden Smith collaboration, "Never Say Never", and remixes of "Somebody to Love". The new versions of the songs were produced by Bieber\'s music director, Dan Kanter, his vocal producer Kuk Harrell, and also producer Rob Wells. While most reviewers complimented the set , several thought that its release was unneeded. The album charted moderately in Europe, reaching the top half of several album charts.',
'Ted Williams. Theodore Samuel Williams (August 30, 1918 – July 5, 2002) was an American professional baseball player and manager. He played his entire 19-year Major League Baseball (MLB) career as a left fielder for the Boston Red Sox from 1939 to 1960, only interrupted by service time during World War II and the Korean War. Nicknamed "The Kid", "The Splendid Splinter", "Teddy Ballgame", "The Thumper", and "The Greatest Hitter Who Ever Lived", Williams is regarded as one of the greatest players in baseball history. Williams was also an outstanding fielder, especially in the difficult left field of Fenway Park in Boston, where he played his entire Major League career at that position.',
'Paul-Werner Krapke. Paul-Werner Krapke (born 1915) is a German armored fighting vehicle engineer, notable for his management of the Leopard 2 project.',
]
)
# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]
validation and train_subsetCEBinaryClassificationEvaluator| Metric | validation | train_subset |
|---|---|---|
| accuracy | 0.9933 | 0.976 |
| accuracy_threshold | 0.162 | 0.5996 |
| f1 | 0.9933 | 0.9771 |
| f1_threshold | 0.162 | 0.5996 |
| precision | 1.0 | 0.9734 |
| recall | 0.9867 | 0.9808 |
| average_precision | 0.9992 | 0.9929 |
sentence_0, sentence_1, and label| sentence_0 | sentence_1 | label | |
|---|---|---|---|
| type | string | string | float |
| details |
|
|
|
| sentence_0 | sentence_1 | label |
|---|---|---|
Paloma and Monkey Gland, are what type of item? |
Monkey Gland. The Monkey Gland is a cocktail of gin, orange juice, grenadine and absinthe created in the 1920s by Harry MacElhone, owner of Harry's New York Bar in Paris, France. |
1.0 |
Tess Asplund fought against the Neo-Nazi movement that existed in which countries? |
Tess Asplund. Tess Asplund, born 1974, is a Swedish activist who gained attention following her protest against neo-Nazis in Borlänge, Sweden. David Lagerlof is the photographer of the viral image of Asplund, which shows her facing uniformed members of the Swedish Nordic Resistance Movement with her fist in the air. She is originally from Colombia and describes herself as Afro-Swedish. About the incident, Asplund is quoted as having said “If this picture of me can get more people to dare to show resistance, then it’s all good...the people must unite and show that it is not okay that racism is becoming normalised and that fascists are running around on our streets.” |
1.0 |
Which magazine, Arizona Highways or Adventist World, is published by Herald Publishing Association? |
My Worlds: The Collection. My Worlds: The Collection is the first compilation album released by Canadian recording artist Justin Bieber. As the international alternative to the Walmart and Sam's Club exclusive "My Worlds Acoustic" (2010), "My Worlds: The Collection" was released in numerous European countries on November 19, 2010. The album consists of two discs; the first is a slightly altered version of "My Worlds Acoustic", and the second is "My Worlds", a compilation itself made up of "My World" (2009) and "My World 2.0" (2010). In addition, the album also features a new song, an inspirational ballad entitled "Pray", a Jaden Smith collaboration, "Never Say Never", and remixes of "Somebody to Love". The new versions of the songs were produced by Bieber's music director, Dan Kanter, his vocal producer Kuk Harrell, and also producer Rob Wells. While most reviewers complimented the set , several thought that its release was unneeded. The album charted moderately in Europe, reachi... |
0.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.9988 | 0.9896 |
| 0.25 | 500 | 0.2247 | 0.9989 | 0.9896 |
| 0.375 | 750 | - | 0.9988 | 0.9918 |
| 0.5 | 1000 | 0.2255 | 0.9992 | 0.9929 |
@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