Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper • 1908.10084 • Published • 13
How to use tani-at-nola/reranker-deberta-v3-base-nli with sentence-transformers:
from sentence_transformers import CrossEncoder
model = CrossEncoder("tani-at-nola/reranker-deberta-v3-base-nli")
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 microsoft/deberta-v3-base 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("tani-at-nola/reranker-deberta-v3-base-nli")
# Get scores for pairs of texts
pairs = [
['The sisters are hugging goodbye while holding to go packages after just eating lunch.', 'Two women are embracing while holding to go packages.'],
['Two woman are holding packages.', 'Two women are embracing while holding to go packages.'],
['The men are fighting outside a deli.', 'Two women are embracing while holding to go packages.'],
['Two kids in numbered jerseys wash their hands.', 'Two young children in blue jerseys, one with the number 9 and one with the number 2 are standing on wooden steps in a bathroom and washing their hands in a sink.'],
['Two kids at a ballgame wash their hands.', 'Two young children in blue jerseys, one with the number 9 and one with the number 2 are standing on wooden steps in a bathroom and washing their hands in a sink.'],
]
scores = model.predict(pairs)
print(scores.shape)
# (5,)
# Or rank different texts based on similarity to a single text
ranks = model.rank(
'The sisters are hugging goodbye while holding to go packages after just eating lunch.',
[
'Two women are embracing while holding to go packages.',
'Two women are embracing while holding to go packages.',
'Two women are embracing while holding to go packages.',
'Two young children in blue jerseys, one with the number 9 and one with the number 2 are standing on wooden steps in a bathroom and washing their hands in a sink.',
'Two young children in blue jerseys, one with the number 9 and one with the number 2 are standing on wooden steps in a bathroom and washing their hands in a sink.',
]
)
# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]
AllNLI-norm-dev and AllNLI-testCrossEncoderClassificationEvaluator| Metric | AllNLI-norm-dev | AllNLI-test |
|---|---|---|
| accuracy | 0.6807 | 0.6814 |
| accuracy_threshold | 0.4376 | 0.56 |
| f1 | 0.5466 | 0.527 |
| f1_threshold | 0.0044 | 0.001 |
| precision | 0.4004 | 0.3655 |
| recall | 0.861 | 0.9436 |
| average_precision | 0.4993 | 0.4819 |
hypothesis, premise, and label| hypothesis | premise | label | |
|---|---|---|---|
| type | string | string | int |
| details |
|
|
|
| hypothesis | premise | label |
|---|---|---|
A person is training his horse for a competition. |
A person on a horse jumps over a broken down airplane. |
0 |
A person is at a diner, ordering an omelette. |
A person on a horse jumps over a broken down airplane. |
0 |
A person is outdoors, on a horse. |
A person on a horse jumps over a broken down airplane. |
1 |
BinaryCrossEntropyLoss with these parameters:{
"activation_fn": "torch.nn.modules.linear.Identity",
"pos_weight": null
}
hypothesis, premise, and label| hypothesis | premise | label | |
|---|---|---|---|
| type | string | string | int |
| details |
|
|
|
| hypothesis | premise | label |
|---|---|---|
The sisters are hugging goodbye while holding to go packages after just eating lunch. |
Two women are embracing while holding to go packages. |
0 |
Two woman are holding packages. |
Two women are embracing while holding to go packages. |
1 |
The men are fighting outside a deli. |
Two women are embracing while holding to go packages. |
0 |
BinaryCrossEntropyLoss with these parameters:{
"activation_fn": "torch.nn.modules.linear.Identity",
"pos_weight": null
}
eval_strategy: stepsper_device_train_batch_size: 64per_device_eval_batch_size: 64num_train_epochs: 5warmup_ratio: 0.1bf16: Trueload_best_model_at_end: Trueoverwrite_output_dir: Falsedo_predict: Falseeval_strategy: stepsprediction_loss_only: Trueper_device_train_batch_size: 64per_device_eval_batch_size: 64per_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: 1.0num_train_epochs: 5max_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: 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: Truedataloader_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: Falsehub_revision: Nonegradient_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: Falseliger_kernel_config: Noneeval_use_gather_object: Falseaverage_tokens_across_devices: Falseprompts: Nonebatch_sampler: batch_samplermulti_dataset_batch_sampler: proportionalrouter_mapping: {}learning_rate_mapping: {}| Epoch | Step | Training Loss | Validation Loss | AllNLI-norm-dev_average_precision | AllNLI-test_average_precision |
|---|---|---|---|---|---|
| -1 | -1 | - | - | 0.3614 | - |
| 0.0068 | 100 | 0.7205 | - | - | - |
| 0.0136 | 200 | 0.6972 | - | - | - |
| 0.0204 | 300 | 0.6086 | - | - | - |
| 0.0272 | 400 | 0.4855 | - | - | - |
| 0.0340 | 500 | 0.3991 | - | - | - |
| 0.0408 | 600 | 0.3409 | - | - | - |
| 0.0476 | 700 | 0.2987 | - | - | - |
| 0.0544 | 800 | 0.2841 | - | - | - |
| 0.0611 | 900 | 0.2729 | - | - | - |
| 0.0679 | 1000 | 0.2627 | - | - | - |
| 0.0747 | 1100 | 0.2517 | - | - | - |
| 0.0815 | 1200 | 0.2286 | - | - | - |
| 0.0883 | 1300 | 0.2385 | - | - | - |
| 0.0951 | 1400 | 0.2329 | - | - | - |
| 0.1019 | 1500 | 0.2213 | 0.1959 | 0.4997 | - |
| 0.1087 | 1600 | 0.22 | - | - | - |
| 0.1155 | 1700 | 0.2295 | - | - | - |
| 0.1223 | 1800 | 0.2236 | - | - | - |
| 0.1291 | 1900 | 0.2273 | - | - | - |
| 0.1359 | 2000 | 0.2071 | - | - | - |
| 0.1427 | 2100 | 0.2254 | - | - | - |
| 0.1495 | 2200 | 0.2217 | - | - | - |
| 0.1563 | 2300 | 0.2093 | - | - | - |
| 0.1631 | 2400 | 0.2112 | - | - | - |
| 0.1698 | 2500 | 0.2176 | - | - | - |
| 0.1766 | 2600 | 0.2195 | - | - | - |
| 0.1834 | 2700 | 0.2107 | - | - | - |
| 0.1902 | 2800 | 0.2164 | - | - | - |
| 0.1970 | 2900 | 0.213 | - | - | - |
| 0.2038 | 3000 | 0.2055 | 0.1726 | 0.4789 | - |
| 0.2106 | 3100 | 0.2039 | - | - | - |
| 0.2174 | 3200 | 0.2157 | - | - | - |
| 0.2242 | 3300 | 0.2155 | - | - | - |
| 0.2310 | 3400 | 0.2017 | - | - | - |
| 0.2378 | 3500 | 0.2068 | - | - | - |
| 0.2446 | 3600 | 0.2111 | - | - | - |
| 0.2514 | 3700 | 0.2062 | - | - | - |
| 0.2582 | 3800 | 0.2062 | - | - | - |
| 0.2650 | 3900 | 0.2217 | - | - | - |
| 0.2718 | 4000 | 0.2012 | - | - | - |
| 0.2786 | 4100 | 0.2127 | - | - | - |
| 0.2853 | 4200 | 0.212 | - | - | - |
| 0.2921 | 4300 | 0.2075 | - | - | - |
| 0.2989 | 4400 | 0.2099 | - | - | - |
| 0.3057 | 4500 | 0.2134 | 0.1644 | 0.4993 | - |
| -1 | -1 | - | - | - | 0.4819 |
@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/deberta-v3-base