Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper • 1908.10084 • Published • 13
How to use srikarvar/multilingual-e5-small-triplet-final-2 with sentence-transformers:
from sentence_transformers import SentenceTransformer
model = SentenceTransformer("srikarvar/multilingual-e5-small-triplet-final-2")
sentences = [
"How to cook a turkey?",
"How to make a turkey sandwich?",
"World's biggest desert by area",
"Steps to roast a turkey"
]
embeddings = model.encode(sentences)
similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [4, 4]This is a sentence-transformers model finetuned from intfloat/multilingual-e5-small. It maps sentences & paragraphs to a 384-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more.
SentenceTransformer(
(0): Transformer({'max_seq_length': 512, 'do_lower_case': False}) with Transformer model: BertModel
(1): Pooling({'word_embedding_dimension': 384, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True})
(2): Normalize()
)
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("srikarvar/multilingual-e5-small-triplet-final-2")
# Run inference
sentences = [
'What is the capital city of Canada?',
'What is the capital of Canada?',
'What is the capital city of Australia?',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 384]
# Get the similarity scores for the embeddings
similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [3, 3]
triplet-validationTripletEvaluator| Metric | Value |
|---|---|
| cosine_accuracy | 0.9836 |
| dot_accuracy | 0.0164 |
| manhattan_accuracy | 0.9836 |
| euclidean_accuracy | 0.9836 |
| max_accuracy | 0.9836 |
anchor, positive, and negative| anchor | positive | negative | |
|---|---|---|---|
| type | string | string | string |
| details |
|
|
|
| anchor | positive | negative |
|---|---|---|
What is the capital of Brazil? |
Capital city of Brazil |
What is the capital of Argentina? |
How do I install Python on my computer? |
How do I set up Python on my PC? |
How do I uninstall Python on my computer? |
How do I apply for a credit card? |
How do I get a credit card? |
How do I cancel a credit card? |
TripletLoss with these parameters:{
"distance_metric": "TripletDistanceMetric.EUCLIDEAN",
"triplet_margin": 0.7
}
anchor, positive, and negative| anchor | positive | negative | |
|---|---|---|---|
| type | string | string | string |
| details |
|
|
|
| anchor | positive | negative |
|---|---|---|
How to create a podcast? |
Steps to start a podcast |
How to create a vlog? |
How many states are there in the USA? |
Total number of states in the United States |
How many provinces are there in Canada? |
What is the population of India? |
How many people live in India? |
What is the population of China? |
TripletLoss with these parameters:{
"distance_metric": "TripletDistanceMetric.EUCLIDEAN",
"triplet_margin": 0.7
}
eval_strategy: epochper_device_train_batch_size: 32per_device_eval_batch_size: 32gradient_accumulation_steps: 2learning_rate: 3e-06weight_decay: 0.01num_train_epochs: 22lr_scheduler_type: cosinewarmup_steps: 50load_best_model_at_end: Trueoptim: adamw_torch_fusedoverwrite_output_dir: Falsedo_predict: Falseeval_strategy: epochprediction_loss_only: Trueper_device_train_batch_size: 32per_device_eval_batch_size: 32per_gpu_train_batch_size: Noneper_gpu_eval_batch_size: Nonegradient_accumulation_steps: 2eval_accumulation_steps: Nonelearning_rate: 3e-06weight_decay: 0.01adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08max_grad_norm: 1.0num_train_epochs: 22max_steps: -1lr_scheduler_type: cosinelr_scheduler_kwargs: {}warmup_ratio: 0.0warmup_steps: 50log_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: 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_torch_fusedoptim_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: Falsebatch_sampler: batch_samplermulti_dataset_batch_sampler: proportional| Epoch | Step | Training Loss | loss | triplet-validation_max_accuracy |
|---|---|---|---|---|
| 1.0 | 9 | - | 0.6381 | - |
| 1.1111 | 10 | 0.6743 | - | - |
| 2.0 | 18 | - | 0.6262 | - |
| 2.2222 | 20 | 0.6608 | - | - |
| 3.0 | 27 | - | 0.6066 | - |
| 3.3333 | 30 | 0.6517 | - | - |
| 4.0 | 36 | - | 0.5795 | - |
| 4.4444 | 40 | 0.6288 | - | - |
| 5.0 | 45 | - | 0.5453 | - |
| 5.5556 | 50 | 0.5934 | - | - |
| 6.0 | 54 | - | 0.5052 | - |
| 6.6667 | 60 | 0.5708 | - | - |
| 7.0 | 63 | - | 0.4652 | - |
| 7.7778 | 70 | 0.5234 | - | - |
| 8.0 | 72 | - | 0.4270 | - |
| 8.8889 | 80 | 0.5041 | - | - |
| 9.0 | 81 | - | 0.3918 | - |
| 10.0 | 90 | 0.4666 | 0.3589 | - |
| 11.0 | 99 | - | 0.3292 | - |
| 11.1111 | 100 | 0.4554 | - | - |
| 12.0 | 108 | - | 0.3029 | - |
| 12.2222 | 110 | 0.4208 | - | - |
| 13.0 | 117 | - | 0.2797 | - |
| 13.3333 | 120 | 0.4076 | - | - |
| 14.0 | 126 | - | 0.2607 | - |
| 14.4444 | 130 | 0.3958 | - | - |
| 15.0 | 135 | - | 0.2471 | - |
| 15.5556 | 140 | 0.3881 | - | - |
| 16.0 | 144 | - | 0.2365 | - |
| 16.6667 | 150 | 0.3595 | - | - |
| 17.0 | 153 | - | 0.2286 | - |
| 17.7778 | 160 | 0.354 | - | - |
| 18.0 | 162 | - | 0.2232 | - |
| 18.8889 | 170 | 0.3506 | - | - |
| 19.0 | 171 | - | 0.2199 | - |
| 20.0 | 180 | 0.3555 | 0.2182 | - |
| 21.0 | 189 | - | 0.2175 | - |
| 21.1111 | 190 | 0.3526 | - | - |
| 22.0 | 198 | - | 0.2174 | 0.9836 |
@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",
}
@misc{hermans2017defense,
title={In Defense of the Triplet Loss for Person Re-Identification},
author={Alexander Hermans and Lucas Beyer and Bastian Leibe},
year={2017},
eprint={1703.07737},
archivePrefix={arXiv},
primaryClass={cs.CV}
}
Base model
intfloat/multilingual-e5-small