Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper โข 1908.10084 โข Published โข 19
How to use egerber1/xlm-roberta-crossencoder with sentence-transformers:
from sentence_transformers import CrossEncoder
model = CrossEncoder("egerber1/xlm-roberta-crossencoder")
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 FacebookAI/xlm-roberta-base on the reranker_10k dataset 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("egerber1/xlm-roberta-crossencoder")
# Get scores for pairs of texts
pairs = [
['Elektroschweiรband fรผr Fixpunkt DN 70 Elektroschweiรband fรผr Fixpunkt - Zur Fixpunktbefestigung von Rohren in Verbindung mit Rohrschellen - Einteilig - Nennweite: DN 70 liefern und montieren', 'Geberit PE Elektroschweiรband fรผr Fixpunkt DN70'],
['Elektroschweiรband fรผr Fixpunkt DN 70 Elektroschweiรband fรผr Fixpunkt - Zur Fixpunktbefestigung von Rohren in Verbindung mit Rohrschellen - Einteilig - Nennweite: DN 70 liefern und montieren', 'Geberit Rohrschelle gedรคmmt Gewindemuffe M8/10 DN70'],
['Elektroschweiรband fรผr Fixpunkt DN 70 Elektroschweiรband fรผr Fixpunkt - Zur Fixpunktbefestigung von Rohren in Verbindung mit Rohrschellen - Einteilig - Nennweite: DN 70 liefern und montieren', 'Geberit PE Steckmuffe mit Lippendichtung DN70'],
['Elektroschweiรband fรผr Fixpunkt DN 70 Elektroschweiรband fรผr Fixpunkt - Zur Fixpunktbefestigung von Rohren in Verbindung mit Rohrschellen - Einteilig - Nennweite: DN 70 liefern und montieren', 'Geberit PE Elektroschweiรband fรผr Fixpunkt DN56'],
['Elektroschweiรband fรผr Fixpunkt DN 70 Elektroschweiรband fรผr Fixpunkt - Zur Fixpunktbefestigung von Rohren in Verbindung mit Rohrschellen - Einteilig - Nennweite: DN 70 liefern und montieren', 'Geberit PE Elektroschweiรband fรผr Fixpunkt DN90'],
]
scores = model.predict(pairs)
print(scores.shape)
# (5,)
# Or rank different texts based on similarity to a single text
ranks = model.rank(
'Elektroschweiรband fรผr Fixpunkt DN 70 Elektroschweiรband fรผr Fixpunkt - Zur Fixpunktbefestigung von Rohren in Verbindung mit Rohrschellen - Einteilig - Nennweite: DN 70 liefern und montieren',
[
'Geberit PE Elektroschweiรband fรผr Fixpunkt DN70',
'Geberit Rohrschelle gedรคmmt Gewindemuffe M8/10 DN70',
'Geberit PE Steckmuffe mit Lippendichtung DN70',
'Geberit PE Elektroschweiรband fรผr Fixpunkt DN56',
'Geberit PE Elektroschweiรband fรผr Fixpunkt DN90',
]
)
# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]
query, passage, and label| query | passage | label | |
|---|---|---|---|
| type | string | string | int |
| details |
|
|
|
| query | passage | label |
|---|---|---|
Elektroschweiรband fรผr Fixpunkt DN 70 Elektroschweiรband fรผr Fixpunkt - Zur Fixpunktbefestigung von Rohren in Verbindung mit Rohrschellen - Einteilig - Nennweite: DN 70 liefern und montieren |
Geberit PE Elektroschweiรband fรผr Fixpunkt DN70 |
1 |
Elektroschweiรband fรผr Fixpunkt DN 70 Elektroschweiรband fรผr Fixpunkt - Zur Fixpunktbefestigung von Rohren in Verbindung mit Rohrschellen - Einteilig - Nennweite: DN 70 liefern und montieren |
Geberit Rohrschelle gedรคmmt Gewindemuffe M8/10 DN70 |
0 |
Elektroschweiรband fรผr Fixpunkt DN 70 Elektroschweiรband fรผr Fixpunkt - Zur Fixpunktbefestigung von Rohren in Verbindung mit Rohrschellen - Einteilig - Nennweite: DN 70 liefern und montieren |
Geberit PE Steckmuffe mit Lippendichtung DN70 |
0 |
BinaryCrossEntropyLoss with these parameters:{
"activation_fn": "torch.nn.modules.linear.Identity",
"pos_weight": 9.561403274536133
}
per_device_train_batch_size: 32per_device_eval_batch_size: 64learning_rate: 2e-05warmup_ratio: 0.1fp16: Truedataloader_num_workers: 8overwrite_output_dir: Falsedo_predict: Falseeval_strategy: noprediction_loss_only: Trueper_device_train_batch_size: 32per_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: 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: 42data_seed: Nonejit_mode_eval: Falseuse_ipex: Falsebf16: Falsefp16: Truefp16_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: 8dataloader_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}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: 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 |
|---|---|---|
| 0.0033 | 1 | 0.8052 |
| 1.6611 | 500 | 1.2767 |
@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
FacebookAI/xlm-roberta-base