Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper
•
1908.10084
•
Published
•
12
This is a sentence-transformers model trained. It maps sentences & paragraphs to a 768-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': 64, 'do_lower_case': False, 'architecture': 'BertModel'})
(1): Pooling({'word_embedding_dimension': 768, '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})
)
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("sentence_transformers_model_id")
# Run inference
sentences = [
'He is also well singing in other regional forms such as Bhajans , Ghazals , Nazrulgeeti and numerous semi-classical songs .',
'He is also skilled in singing other regional forms like Bhajans , Ghazals , Nazrulgeeti and numerous semi-classical songs as well .',
'Conotalopia mustelina is a species of sea snail , a top gastropod mollusk in the Trochidae family , the navy snails .',
]
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.9958, 0.5938],
# [0.9958, 1.0000, 0.6041],
# [0.5938, 0.6041, 1.0000]])
paws-val-watcherBinaryClassificationEvaluator| Metric | Value |
|---|---|
| cosine_accuracy | 0.9277 |
| cosine_accuracy_threshold | 0.819 |
| cosine_f1 | 0.9206 |
| cosine_f1_threshold | 0.818 |
| cosine_precision | 0.8942 |
| cosine_recall | 0.9487 |
| cosine_ap | 0.9613 |
| cosine_mcc | 0.8557 |
sentence_0, sentence_1, and label| sentence_0 | sentence_1 | label | |
|---|---|---|---|
| type | string | string | float |
| details |
|
|
|
| sentence_0 | sentence_1 | label |
|---|---|---|
The southern area contains the Tara Mountains and the northern area consists of open plains along the coast , and the city proper . |
The southern area contains the Tara mountains and the northern area consists of open plains along the coast and the actual city . |
1.0 |
It began as a fishing village inhabited by Polish settlers from the Kaszub region in 1870 , as well as by some German immigrants . |
It began as a fishing village populated by German settlers from the Kaszub region , as well as some Polish immigrants in 1870 . |
0.0 |
Wyoming Highway 377 was a short Wyoming state road in central Sweetwater County that served the community of Point of Rocks and the Jim Bridger Power Plant . |
Wyoming Highway 377 was a short Wyoming State Road in central Sweetwater County that served as the community of Point of Rocks and the Jim Bridger Power Plant . |
1.0 |
ContrastiveLoss with these parameters:{
"distance_metric": "SiameseDistanceMetric.COSINE_DISTANCE",
"margin": 0.5,
"size_average": true
}
per_device_train_batch_size: 16per_device_eval_batch_size: 16num_train_epochs: 4multi_dataset_batch_sampler: round_robinoverwrite_output_dir: Falsedo_predict: Falseeval_strategy: noprediction_loss_only: Trueper_device_train_batch_size: 16per_device_eval_batch_size: 16per_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: 4max_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: 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}parallelism_config: Nonedeepspeed: Nonelabel_smoothing_factor: 0.0optim: adamw_torch_fusedoptim_args: Noneadafactor: Falsegroup_by_length: Falselength_column_name: lengthproject: huggingfacetrackio_space_id: trackioddp_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: noneftune_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: Trueprompts: Nonebatch_sampler: batch_samplermulti_dataset_batch_sampler: round_robinrouter_mapping: {}learning_rate_mapping: {}| Epoch | Step | Training Loss | paws-val-watcher_cosine_ap |
|---|---|---|---|
| 0.1813 | 500 | 0.0319 | - |
| 0.3626 | 1000 | 0.0224 | - |
| 0.5439 | 1500 | 0.0175 | - |
| 0.7252 | 2000 | 0.0146 | - |
| 0.9065 | 2500 | 0.013 | - |
| 1.0 | 2758 | - | 0.9348 |
| 1.0877 | 3000 | 0.0109 | - |
| 1.2690 | 3500 | 0.0092 | - |
| 1.4503 | 4000 | 0.0085 | - |
| 1.6316 | 4500 | 0.008 | - |
| 1.8129 | 5000 | 0.0075 | - |
| 1.9942 | 5500 | 0.0076 | - |
| 2.0 | 5516 | - | 0.9543 |
| 2.1755 | 6000 | 0.0053 | - |
| 2.3568 | 6500 | 0.0053 | - |
| 2.5381 | 7000 | 0.0052 | - |
| 2.7194 | 7500 | 0.0049 | - |
| 2.9007 | 8000 | 0.0047 | - |
| 3.0 | 8274 | - | 0.9580 |
| 3.0819 | 8500 | 0.0042 | - |
| 3.2632 | 9000 | 0.0037 | - |
| 3.4445 | 9500 | 0.0035 | - |
| 3.6258 | 10000 | 0.0036 | - |
| 3.8071 | 10500 | 0.0036 | - |
| 3.9884 | 11000 | 0.0036 | - |
| 4.0 | 11032 | - | 0.9613 |
@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",
}
@inproceedings{hadsell2006dimensionality,
author={Hadsell, R. and Chopra, S. and LeCun, Y.},
booktitle={2006 IEEE Computer Society Conference on Computer Vision and Pattern Recognition (CVPR'06)},
title={Dimensionality Reduction by Learning an Invariant Mapping},
year={2006},
volume={2},
number={},
pages={1735-1742},
doi={10.1109/CVPR.2006.100}
}