Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper • 1908.10084 • Published • 14
How to use rdxtremity/harrir-bge-m3 with sentence-transformers:
from sentence_transformers import SentenceTransformer
model = SentenceTransformer("rdxtremity/harrir-bge-m3")
sentences = [
"运动鞋尺码",
"[ELLA] Ruched Diamante Pointy Flats | حذاء فلات مزموم مرصع بالفصوص بمقدمة مدببة. Category: Shoes > Flats & Slip-Ons.",
"[Ginger] Classic Crossbody Pink | حقيبة كروس كلاسيكية. Category: Bags > Crossbody Bags.",
"[Ipekyol] Monogram Pattern Sneakers | حذاء سنيكرز بنمط مونوغرام. Category: Shoes > Sneakers."
]
embeddings = model.encode(sentences)
similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [4, 4]This is a sentence-transformers model finetuned from BAAI/bge-m3. It maps sentences & paragraphs to a 1024-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': 'XLMRobertaModel'})
(1): Pooling({'embedding_dimension': 1024, 'pooling_mode': 'cls', '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("sentence_transformers_model_id")
# Run inference
sentences = [
'ردية ميدي نقوش زهور',
'[PRETTY LAVISH] Floral Print Halter Maxi Dress | فستان مكسي هولتر بنقشة الزهور. Category: Dresses > Maxi Dresses.',
'[Ginger] Boxy Cropped Shirt | قميص كروب بقصة مربعة. Category: Tops > Other Tops.',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 1024]
# Get the similarity scores for the embeddings
similarities = model.similarity(embeddings, embeddings)
print(similarities)
# tensor([[0.9999, 0.4676, 0.4029],
# [0.4676, 1.0000, 0.4774],
# [0.4029, 0.4774, 1.0000]])
TripletEvaluator| Metric | Value |
|---|---|
| cosine_accuracy | 0.8765 |
anchor, positive, and negative| anchor | positive | negative | |
|---|---|---|---|
| type | string | string | string |
| modality | text | text | text |
| details |
|
|
|
| anchor | positive | negative |
|---|---|---|
nike cortez |
[LACOSTE] T-Clip Low-Top Court Sneakers | تي-كليب سنيكرز كورت منخفض. Category: Shoes > Sneakers. |
[Nike] Nike Sportswear Knit Crop Tank | نايك توب تانك كروب محبوك سبورتس وير. Category: Tops > Tank Tops & Camis. |
nike cortez |
[Nike] Nike Cortez TXT | نايك كورتيز قماش. Category: Shoes > Sneakers. |
[Nike] Dri-Fit Metal Swoosh Cap Black | قبعة دراي-فيت كلوب. Category: Accessories > The Hat Store. |
nike cortez |
[Nike] Nike Cortez TXT | نايك كورتيز قماش. Category: Shoes > Sneakers. |
[TOMMY HILFIGER] Vulcanized Low Top Sneakers | سنيكرز فولكنايزد منخفض. Category: Shoes > Sneakers. |
TripletLoss with these parameters:{
"distance_metric": "TripletDistanceMetric.COSINE",
"triplet_margin": 0.2
}
per_device_train_batch_size: 16num_train_epochs: 1learning_rate: 5e-06warmup_steps: 0.1gradient_accumulation_steps: 4bf16: Truetf32: Trueper_device_train_batch_size: 16num_train_epochs: 1max_steps: -1learning_rate: 5e-06lr_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: 4average_tokens_across_devices: Truemax_grad_norm: 1.0label_smoothing_factor: 0.0bf16: Truefp16: Falsebf16_full_eval: Falsefp16_full_eval: Falsetf32: Truegradient_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: 8prediction_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_accuracy |
|---|---|---|---|
| -1 | -1 | - | 0.8667 |
| 0.0312 | 10 | 0.1282 | - |
| 0.0625 | 20 | 0.1300 | - |
| 0.0938 | 30 | 0.1292 | - |
| 0.125 | 40 | 0.1279 | - |
| 0.1562 | 50 | 0.1285 | - |
| 0.1875 | 60 | 0.1326 | - |
| 0.2188 | 70 | 0.1279 | - |
| 0.25 | 80 | 0.1220 | - |
| 0.2812 | 90 | 0.1263 | - |
| 0.3125 | 100 | 0.1231 | - |
| 0.3438 | 110 | 0.1227 | - |
| 0.375 | 120 | 0.1200 | - |
| 0.4062 | 130 | 0.1257 | - |
| 0.4375 | 140 | 0.1194 | - |
| 0.4688 | 150 | 0.1237 | - |
| 0.5 | 160 | 0.1248 | - |
| 0.5312 | 170 | 0.1220 | - |
| 0.5625 | 180 | 0.1208 | - |
| 0.5938 | 190 | 0.1199 | - |
| 0.625 | 200 | 0.1208 | - |
| 0.6562 | 210 | 0.1197 | - |
| 0.6875 | 220 | 0.1156 | - |
| 0.7188 | 230 | 0.1186 | - |
| 0.75 | 240 | 0.1227 | - |
| 0.7812 | 250 | 0.1171 | - |
| 0.8125 | 260 | 0.1214 | - |
| 0.8438 | 270 | 0.1156 | - |
| 0.875 | 280 | 0.1203 | - |
| 0.9062 | 290 | 0.1210 | - |
| 0.9375 | 300 | 0.1164 | - |
| 0.9688 | 310 | 0.1164 | - |
| 1.0 | 320 | 0.1213 | - |
| -1 | -1 | - | 0.8765 |
@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
BAAI/bge-m3