Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper • 1908.10084 • Published • 13
How to use LamaDiab/MiniLM-v2-v36-CosineWarmup-SemanticEngine with sentence-transformers:
from sentence_transformers import SentenceTransformer
model = SentenceTransformer("LamaDiab/MiniLM-v2-v36-CosineWarmup-SemanticEngine")
sentences = [
"kids' slippers with a sporty neon green design (size 24-25)",
"slipper",
"colorful slipper",
"black winter hoodie"
]
embeddings = model.encode(sentences)
similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [4, 4]This is a sentence-transformers model finetuned from sentence-transformers/all-MiniLM-L6-v2. 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': 256, 'do_lower_case': False, 'architecture': '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("LamaDiab/MiniLM-v2-v36-CosineWarmup-SemanticEngine")
# Run inference
sentences = [
'black seed oil',
'natural black seed oil',
'essentials lip gloss temptation - rusty brown',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 384]
# Get the similarity scores for the embeddings
similarities = model.similarity(embeddings, embeddings)
print(similarities)
# tensor([[1.0000, 0.9519, 0.1931],
# [0.9519, 1.0000, 0.1874],
# [0.1931, 0.1874, 1.0000]])
TripletEvaluator| Metric | Value |
|---|---|
| cosine_accuracy | 0.9774 |
anchor, positive, and itemCategory| anchor | positive | itemCategory | |
|---|---|---|---|
| type | string | string | string |
| details |
|
|
|
| anchor | positive | itemCategory |
|---|---|---|
adults tie-dye pant |
pants |
trousers |
manicure remover vanilla |
fruit fragrances nail polish remover |
nailcare |
canvas frame painting acrylic colors 5 |
canvas |
painting |
MultipleNegativesSymmetricRankingLoss with these parameters:{
"scale": 20.0,
"similarity_fct": "cos_sim",
"gather_across_devices": false
}
anchor, positive, negative, and itemCategory| anchor | positive | negative | itemCategory | |
|---|---|---|---|---|
| type | string | string | string | string |
| details |
|
|
|
|
| anchor | positive | negative | itemCategory |
|---|---|---|---|
extra bubblemint sugar free chewing gum |
extra gum |
céleste belgian chocolate sablé |
sweet |
golden pothos |
evergreen plant |
spider-man action figure |
plant |
effortless style slit linen pants - beige |
soft pants |
the one lilac |
trousers |
MultipleNegativesSymmetricRankingLoss with these parameters:{
"scale": 20.0,
"similarity_fct": "cos_sim",
"gather_across_devices": false
}
eval_strategy: stepsper_device_train_batch_size: 256per_device_eval_batch_size: 256learning_rate: 3e-05weight_decay: 0.01lr_scheduler_type: cosinewarmup_ratio: 0.1fp16: Truedataloader_num_workers: 1dataloader_prefetch_factor: 2dataloader_persistent_workers: Truepush_to_hub: Truehub_model_id: LamaDiab/MiniLM-v2-v36-CosineWarmup-SemanticEnginehub_strategy: all_checkpointsoverwrite_output_dir: Falsedo_predict: Falseeval_strategy: stepsprediction_loss_only: Trueper_device_train_batch_size: 256per_device_eval_batch_size: 256per_gpu_train_batch_size: Noneper_gpu_eval_batch_size: Nonegradient_accumulation_steps: 1eval_accumulation_steps: Nonetorch_empty_cache_steps: Nonelearning_rate: 3e-05weight_decay: 0.01adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08max_grad_norm: 1.0num_train_epochs: 3max_steps: -1lr_scheduler_type: cosinelr_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: 1dataloader_prefetch_factor: 2past_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}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: Trueskip_memory_metrics: Trueuse_legacy_prediction_loop: Falsepush_to_hub: Trueresume_from_checkpoint: Nonehub_model_id: LamaDiab/MiniLM-v2-v36-CosineWarmup-SemanticEnginehub_strategy: all_checkpointshub_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 | cosine_accuracy |
|---|---|---|---|---|
| 0.0002 | 1 | 2.5242 | - | - |
| 0.1912 | 1000 | 1.9109 | 1.0157 | 0.9569 |
| 0.3823 | 2000 | 1.4072 | 0.9177 | 0.9651 |
| 0.5735 | 3000 | 1.1814 | 0.8813 | 0.9720 |
| 0.7647 | 4000 | 1.1321 | 0.8326 | 0.9733 |
| 0.9558 | 5000 | 1.663 | 0.8296 | 0.9718 |
| 1.1470 | 6000 | 1.5416 | 0.7977 | 0.9752 |
| 1.3380 | 7000 | 1.1543 | 0.7820 | 0.9752 |
| 1.5291 | 8000 | 1.137 | 0.7756 | 0.9769 |
| 1.7202 | 9000 | 1.1203 | 0.7740 | 0.9762 |
| 1.9113 | 10000 | 1.1047 | 0.7580 | 0.9770 |
| 2.1024 | 11000 | 1.0624 | 0.7653 | 0.9767 |
| 2.2935 | 12000 | 1.0559 | 0.7649 | 0.9772 |
| 2.4846 | 13000 | 1.0365 | 0.7623 | 0.9771 |
| 2.6757 | 14000 | 1.0455 | 0.7622 | 0.9774 |
| 2.8668 | 15000 | 1.0532 | 0.7623 | 0.9774 |
@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
sentence-transformers/all-MiniLM-L6-v2