Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper • 1908.10084 • Published • 13
How to use LamaDiab/MiniLM-v28-SemanticEngine with sentence-transformers:
from sentence_transformers import SentenceTransformer
model = SentenceTransformer("LamaDiab/MiniLM-v28-SemanticEngine")
sentences = [
"chillax fluffy beanbag",
"living room furniture",
"lined orange",
"home_garden",
"home and garden",
"beanbag"
]
embeddings = model.encode(sentences)
similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [6, 6]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-v28-SemanticEngine")
# Run inference
sentences = [
'xbase 100 kids swimming goggles - clear lenses - blue / yellow',
'blue and yellow swimming goggles',
'snuggs wearable blanket monk red christmas deer',
]
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.7468, 0.0225],
# [ 0.7468, 1.0000, -0.0354],
# [ 0.0225, -0.0354, 1.0000]])
TripletEvaluator| Metric | Value |
|---|---|
| cosine_accuracy | 0.9803 |
anchor, positive, itemCategory, shoppingCategory, and shoppingCategory_normalized| anchor | positive | itemCategory | shoppingCategory | shoppingCategory_normalized | |
|---|---|---|---|---|---|
| type | string | string | string | string | string |
| details |
|
|
|
|
|
| anchor | positive | itemCategory | shoppingCategory | shoppingCategory_normalized |
|---|---|---|---|---|
sky blue dotted t-chemise |
t-shirt sky dotted |
top |
fashion |
fashion |
coffee - set of scented candles |
pleasant aroma candle |
candle |
home and garden |
home_garden |
nasturtium passion fruit chocolate |
chocolate |
sweet |
restaurants |
food_dining |
MultipleNegativesSymmetricRankingLoss with these parameters:{
"scale": 20.0,
"similarity_fct": "cos_sim",
"gather_across_devices": false
}
anchor, positive, negative, itemCategory, shoppingCategory, and shoppingCategory_normalized| anchor | positive | negative | itemCategory | shoppingCategory | shoppingCategory_normalized | |
|---|---|---|---|---|---|---|
| type | string | string | string | string | string | string |
| details |
|
|
|
|
|
|
| anchor | positive | negative | itemCategory | shoppingCategory | shoppingCategory_normalized |
|---|---|---|---|---|---|
pilot mechanical pencil progrex h-127 - 0.7 mm |
0.7 mm pencil |
rush tip marker set, 6 pastel colors, carton box, black edition no. 116453 |
pencil |
stationary |
office_school |
superior drawing marker -pen - set of 12 colors - 2 nib |
marker pen set |
palestine scarf notebook (spirals) |
marker |
stationary |
office_school |
first person singular author: haruki murakami |
haruki murakami book |
chocolate flakes mocha |
literature and fiction |
entertainment |
sports_entertainment |
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.001warmup_ratio: 0.1fp16: Truedataloader_num_workers: 1dataloader_prefetch_factor: 2dataloader_persistent_workers: Truepush_to_hub: Truehub_model_id: LamaDiab/MiniLM-v28-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.001adam_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: 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-v28-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.0003 | 1 | 2.1128 | - | - |
| 0.3205 | 1000 | 1.6035 | 0.7383 | 0.9653 |
| 0.6410 | 2000 | 1.0575 | 0.6787 | 0.9737 |
| 0.9615 | 3000 | 1.8049 | 0.6591 | 0.9739 |
| 1.2819 | 4000 | 1.2967 | 0.6036 | 0.9779 |
| 1.6022 | 5000 | 1.1471 | 0.5827 | 0.9798 |
| 1.9225 | 6000 | 1.0816 | 0.5906 | 0.9800 |
| 2.2428 | 7000 | 1.0567 | 0.5924 | 0.9795 |
| 2.5631 | 8000 | 1.0046 | 0.5827 | 0.9803 |
| 2.8834 | 9000 | 1.0313 | 0.5850 | 0.9803 |
@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
from sentence_transformers import SentenceTransformer model = SentenceTransformer("LamaDiab/MiniLM-v28-SemanticEngine") sentences = [ "chillax fluffy beanbag", "living room furniture", "lined orange", "home_garden", "home and garden", "beanbag" ] embeddings = model.encode(sentences) similarities = model.similarity(embeddings, embeddings) print(similarities.shape) # [6, 6]