Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper • 1908.10084 • Published • 17
How to use tomaarsen/bert-base-uncased-qqp-cross-domain with sentence-transformers:
from sentence_transformers import SentenceTransformer
model = SentenceTransformer("tomaarsen/bert-base-uncased-qqp-cross-domain")
sentences = [
"How do I put restraining order against myself?",
"What are the best 24/7 coffee shops in San Francisco?",
"Can I take out a restraining order against myself?",
"Friendship: How to get rid of romantic feelings for a friend?"
]
embeddings = model.encode(sentences)
similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [4, 4]This is a sentence-transformers model finetuned from google-bert/bert-base-uncased. It maps sentences & paragraphs to a 768-dimensional dense vector space and can be used for retrieval.
SentenceTransformer(
(0): Transformer({'transformer_task': 'feature-extraction', 'modality_config': {'text': {'method': 'forward', 'method_output_name': 'last_hidden_state'}}, 'module_output_name': 'token_embeddings', 'architecture': 'BertModel'})
(1): Pooling({'embedding_dimension': 768, 'pooling_mode': 'mean', 'include_prompt': True})
)
First install the Sentence Transformers library:
pip install -U sentence-transformers
Then you can load this model and run inference.
from sentence_transformers import SentenceTransformer
# Download from the 🤗 Hub
model = SentenceTransformer("tomaarsen/bert-base-uncased-qqp-cross-domain")
# Run inference
sentences = [
"What is the best code troll you've ever seen?",
"What is the best favicon you've ever seen?",
'What is it feel like to die?',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 768]
# Get the similarity scores for the embeddings
similarities = model.similarity(embeddings, embeddings)
print(similarities)
# tensor([[1.0000, 0.4664, 0.0131],
# [0.4664, 1.0000, 0.0492],
# [0.0131, 0.0492, 1.0000]])
BinaryClassificationEvaluator| Metric | Value |
|---|---|
| cosine_accuracy | 0.753 |
| cosine_accuracy_threshold | 0.7228 |
| cosine_f1 | 0.6999 |
| cosine_f1_threshold | 0.636 |
| cosine_precision | 0.5904 |
| cosine_recall | 0.8593 |
| cosine_ap | 0.7111 |
| cosine_mcc | 0.5009 |
sentence1, sentence2, and score| sentence1 | sentence2 | score | |
|---|---|---|---|
| type | string | string | float |
| modality | text | text | |
| details |
|
|
|
| sentence1 | sentence2 | score |
|---|---|---|
According to garuda purana, how can a child conceived through IVF be differentiated from an inauspicious soul? |
What differentiates a 10x doctor from the rest? |
0.10419108718633652 |
Does diabetes cause erectile dysfunction? |
Does stress is one of the cause erectile dysfunction? |
0.4059196412563324 |
What are the pros and cons of using Python vs. Java? |
What are the advantages and disadvantages of Python over Java? |
0.7368191480636597 |
CosineSimilarityLoss with these parameters:{
"loss_fct": "torch.nn.modules.loss.MSELoss",
"cos_score_transformation": "torch.nn.modules.linear.Identity"
}
per_device_train_batch_size: 16num_train_epochs: 1warmup_steps: 0.1per_device_eval_batch_size: 16per_device_train_batch_size: 16num_train_epochs: 1max_steps: -1learning_rate: 5e-05lr_scheduler_type: linearlr_scheduler_kwargs: Nonewarmup_steps: 0.1optim: adamw_torch_fusedoptim_args: Noneweight_decay: 0.0adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08optim_target_modules: Nonegradient_accumulation_steps: 1average_tokens_across_devices: Truemax_grad_norm: 1.0label_smoothing_factor: 0.0bf16: Falsefp16: Falsebf16_full_eval: Falsefp16_full_eval: Falsetf32: Nonegradient_checkpointing: Falsegradient_checkpointing_kwargs: Nonetorch_compile: Falsetorch_compile_backend: Nonetorch_compile_mode: Noneuse_liger_kernel: Falseliger_kernel_config: Noneuse_cache: Falseneftune_noise_alpha: Nonetorch_empty_cache_steps: Noneauto_find_batch_size: Falselog_on_each_node: Truelogging_nan_inf_filter: Trueinclude_num_input_tokens_seen: nolog_level: passivelog_level_replica: warningdisable_tqdm: Falseproject: huggingfacetrackio_space_id: Nonetrackio_bucket_id: Nonetrackio_static_space_id: Noneper_device_eval_batch_size: 16prediction_loss_only: Trueeval_on_start: Falseeval_do_concat_batches: Trueeval_use_gather_object: Falseeval_accumulation_steps: Noneinclude_for_metrics: []batch_eval_metrics: Falsesave_only_model: Falsesave_on_each_node: Falseenable_jit_checkpoint: Falsepush_to_hub: Falsehub_private_repo: Nonehub_model_id: Nonehub_strategy: every_savehub_always_push: Falsehub_revision: Noneload_best_model_at_end: Falseignore_data_skip: Falserestore_callback_states_from_checkpoint: Falsefull_determinism: Falseseed: 42data_seed: Noneuse_cpu: Falseaccelerator_config: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}parallelism_config: Nonedataloader_drop_last: Falsedataloader_num_workers: 0dataloader_pin_memory: Truedataloader_persistent_workers: Falsedataloader_prefetch_factor: Noneremove_unused_columns: Truelabel_names: Nonetrain_sampling_strategy: randomlength_column_name: lengthddp_find_unused_parameters: Noneddp_bucket_cap_mb: Noneddp_broadcast_buffers: Falseddp_static_graph: Noneddp_backend: Noneddp_timeout: 1800fsdp: []fsdp_config: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}deepspeed: Nonedebug: []skip_memory_metrics: Truedo_predict: Falseresume_from_checkpoint: Nonewarmup_ratio: Nonelocal_rank: -1prompts: Nonebatch_sampler: batch_samplermulti_dataset_batch_sampler: proportionalrouter_mapping: {}learning_rate_mapping: {}| Epoch | Step | Training Loss | cosine_ap |
|---|---|---|---|
| 0.0500 | 1233 | 0.0152 | - |
| 0.1000 | 2465 | - | 0.7075 |
| 0.1001 | 2466 | 0.0070 | - |
| 0.1501 | 3699 | 0.0074 | - |
| 0.2000 | 4930 | - | 0.7079 |
| 0.2001 | 4932 | 0.0066 | - |
| 0.2502 | 6165 | 0.0065 | - |
| 0.3001 | 7395 | - | 0.7102 |
| 0.3002 | 7398 | 0.0061 | - |
| 0.3502 | 8631 | 0.0059 | - |
| 0.4001 | 9860 | - | 0.7060 |
| 0.4003 | 9864 | 0.0057 | - |
| 0.4503 | 11097 | 0.0055 | - |
| 0.5001 | 12325 | - | 0.7086 |
| 0.5003 | 12330 | 0.0053 | - |
| 0.5504 | 13563 | 0.0050 | - |
| 0.6001 | 14790 | - | 0.7113 |
| 0.6004 | 14796 | 0.0049 | - |
| 0.6504 | 16029 | 0.0047 | - |
| 0.7002 | 17255 | - | 0.7087 |
| 0.7005 | 17262 | 0.0046 | - |
| 0.7505 | 18495 | 0.0044 | - |
| 0.8002 | 19720 | - | 0.7082 |
| 0.8005 | 19728 | 0.0042 | - |
| 0.8506 | 20961 | 0.0041 | - |
| 0.9002 | 22185 | - | 0.7103 |
| 0.9006 | 22194 | 0.0039 | - |
| 0.9506 | 23427 | 0.0039 | - |
| 1.0 | 24644 | - | 0.7111 |
@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
google-bert/bert-base-uncased