Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper • 1908.10084 • Published • 15
How to use mihaylovnikitos/multilingual-e5-small-hotel with sentence-transformers:
from sentence_transformers import SentenceTransformer
model = SentenceTransformer("mihaylovnikitos/multilingual-e5-small-hotel")
sentences = [
"task: search result | query: глэмпинг для удалённой работы с быстрым интернетом посреди леса",
"title: none | text: бюджетный городской хостел 'городской лайнер' в центре города предлагает общие комнаты и отдельные семейные капсулы, общую кухню и лаундж с настольными играми. рядом — городской аквапарк (трансфер за плату) и детские развлекательные центры; собственных анимационных программ и детского клуба у хостела нет. подходит для путешественников-бэкпекеров и подростков, не для комфортного семейного отдыха у моря. сегмент — бюджетный.",
"title: none | text: кемпинг 'речная роща' — открытая палаточная зона на берегу реки с общими туалетами и душевыми, общей кухней и большим лагерным костром. подходит для любителей живого общения и активного отдыха: сплавы, рыбалка, вечерние концерты. связь слабая, интернет отсутствует; электрозаправки и розетки только в приёмной зоне. сегмент — бюджетный.",
"title: none | text: семейный санаторий 'здоровье и радость' предлагает комплексные лечебные программы: кардиологическая реабилитация под контролем врача, индивидуальные занятия лфк, электрофорез и массаж, физиотерапевтические процедуры. на базе центра — медицинский кабинет с круглосуточным дежурством, регулярные консультации кардиолога и программы восстановительной физкультуры. для детей: детский клуб 3–12 лет с разделением по возрастным группам, ежедневная анимация 2 часа (утром и вечером), возможна оплата услуг няни по запросу, большая огороженная игровая площадка с безопасным покрытием и крытой игровой комнатой. номера — семейные и смежные комнаты, питание по диетам для пожилых и детское меню. сегмент — средний."
]
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 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': 'BertModel'})
(1): Pooling({'embedding_dimension': 384, 'pooling_mode': 'mean', '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("mihaylovnikitos/multilingual-e5-small-hotel")
# Run inference
sentences = [
"task: search result | query: hotel near the hospital for a patient's relatives, long-term stay, inexpensive",
"title: none | text: camping 'forest glade' offers secluded chalet cabins and tent pitches 40 km from the city, with a shared grill kitchen on site and seasonal laundry. suitable for family outdoor recreation: playground, bicycle rental and evening campfires. prices — budget segment off-season, but there is no access to the hospital.",
"title: none | text: отель 'снежный причал' — комфортный городской отель среднего сегмента, предлагает специальный новогодний пакет: праздничная программа с ведущим и живой музыкой, украшенная большая живая ёлка в лобби, новогодний банкет (шведский стол + горячее гала-меню) и организованный профессиональный фейерверк во внутреннем дворе ровно в полночь 31 декабря. пакет включает размещение в номере стандарта или полулюкса, поздний выезд 1 января, детское меню и анимацию для детей 4–12 лет. на территории — утеплённый уличный фонтан и охраняемая парковка. сегмент — средний.",
]
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.0577, 0.9229],
# [0.0577, 1.0000, 0.0938],
# [0.9229, 0.0938, 1.0000]])
sentence1, sentence2, and label| sentence1 | sentence2 | label | |
|---|---|---|---|
| type | string | string | float |
| modality | text | text | |
| details |
|
|
|
| sentence1 | sentence2 | label |
|---|---|---|
task: search result | query: ищем с девушкой спокойное место у моря, без детских горок и криков, только для взрослых, желательно спа и тихий пляж поблизости — хочется романтики и релакса, на пару дней |
title: none | text: бутик-отель 'морской риф' — adults-only комплекс в 50 метрах от частного мелкогалечного пляжа с зоной для пар и шезлонгами, где не допускаются гости младше 18 лет. на территории современный спа-центр: финская сауна, паровая с соляной стеной, комнаты для парных массажей и процедуры для двоих. номера 'люкс' с панорамными окнами и балконами выходят на море, в каждом — кровать king-size, мини-бар и сервис ужина при свечах по запросу. тихая ухоженная территория, всего 28 номеров, романтические пакеты: ужин на пляже, шампанское и лепестки роз. сегмент — премиум/средний-премиум. |
1.0 |
task: search result | query: ищем с девушкой спокойное место у моря, без детских горок и криков, только для взрослых, желательно спа и тихий пляж поблизости — хочется романтики и релакса, на пару дней |
title: none | text: элегантный курортный отель 'лазурная бухта' расположен на первой линии и предлагает просторный открытый спа-комплекс с бассейном, сауной и расписанием массажей. в отеле есть приватные секции пляжа с зонтиками и баром; в номерах — балконы с видом на море и возможность заказать ужин на террасе. на территории регулярно проходят семейные анимационные программы, работает детский клуб и оборудована игровая площадка; отель принимает гостей любых возрастов. сегмент — средний/семейный. |
0.5 |
task: search result | query: ищем с девушкой спокойное место у моря, без детских горок и криков, только для взрослых, желательно спа и тихий пляж поблизости — хочется романтики и релакса, на пару дней |
title: none | text: бутик-отель 'морской риф' — adults-only комплекс в 50 метрах от частного мелкогалечного пляжа с зоной для пар и шезлонгами, где не допускаются гости младше 18 лет. на территории современный спа-центр: финская сауна, паровая с соляной стеной, комнаты для парных массажей и процедуры для двоих. номера 'люкс' с панорамными окнами и балконами выходят на море, в каждом — кровать king-size, мини-бар и сервис ужина при свечах по запросу. тихая ухоженная территория, всего 28 номеров, романтические пакеты: ужин на пляже, шампанское и лепестки роз. сегмент — премиум/средний-премиум. |
0.7 |
CoSENTLoss with these parameters:{
"scale": 20.0,
"similarity_fct": "pairwise_cos_sim"
}
sentence1, sentence2, and label| sentence1 | sentence2 | label | |
|---|---|---|---|
| type | string | string | float |
| modality | text | text | |
| details |
|
|
|
| sentence1 | sentence2 | label |
|---|---|---|
task: search result | query: спокойный отдых на море для двоих без детей, adults only, спа, тихий пляж, романтика |
title: none | text: бутик-отель 'морской риф' — adults-only комплекс в 50 метрах от частного мелкогалечного пляжа с зоной для пар и шезлонгами, где не допускаются гости младше 18 лет. на территории современный спа-центр: финская сауна, паровая с соляной стеной, комнаты для парных массажей и процедуры для двоих. номера 'люкс' с панорамными окнами и балконами выходят на море, в каждом — кровать king-size, мини-бар и сервис ужина при свечах по запросу. тихая ухоженная территория, всего 28 номеров, романтические пакеты: ужин на пляже, шампанское и лепестки роз. сегмент — премиум/средний-премиум. |
1.0 |
task: search result | query: спокойный отдых на море для двоих без детей, adults only, спа, тихий пляж, романтика |
title: none | text: элегантный курортный отель 'лазурная бухта' расположен на первой линии и предлагает просторный открытый спа-комплекс с бассейном, сауной и расписанием массажей. в отеле есть приватные секции пляжа с зонтиками и баром; в номерах — балконы с видом на море и возможность заказать ужин на террасе. на территории регулярно проходят семейные анимационные программы, работает детский клуб и оборудована игровая площадка; отель принимает гостей любых возрастов. сегмент — средний/семейный. |
0.5 |
task: search result | query: спокойный отдых на море для двоих без детей, adults only, спа, тихий пляж, романтика |
title: none | text: бутик-отель 'морской риф' — adults-only комплекс в 50 метрах от частного мелкогалечного пляжа с зоной для пар и шезлонгами, где не допускаются гости младше 18 лет. на территории современный спа-центр: финская сауна, паровая с соляной стеной, комнаты для парных массажей и процедуры для двоих. номера 'люкс' с панорамными окнами и балконами выходят на море, в каждом — кровать king-size, мини-бар и сервис ужина при свечах по запросу. тихая ухоженная территория, всего 28 номеров, романтические пакеты: ужин на пляже, шампанское и лепестки роз. сегмент — премиум/средний-премиум. |
0.7 |
CoSENTLoss with these parameters:{
"scale": 20.0,
"similarity_fct": "pairwise_cos_sim"
}
gradient_accumulation_steps: 2warmup_steps: 0.1data_seed: 42batch_sampler: no_duplicatesdo_predict: Falseprediction_loss_only: Trueper_device_train_batch_size: 8per_device_eval_batch_size: 8gradient_accumulation_steps: 2eval_accumulation_steps: Nonetorch_empty_cache_steps: Nonelearning_rate: 5e-05weight_decay: 0.0adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08max_grad_norm: 1.0num_train_epochs: 3max_steps: -1lr_scheduler_type: linearlr_scheduler_kwargs: Nonewarmup_ratio: Nonewarmup_steps: 0.1log_level: passivelog_level_replica: warninglog_on_each_node: Truelogging_nan_inf_filter: Trueenable_jit_checkpoint: Falsesave_on_each_node: Falsesave_only_model: Falserestore_callback_states_from_checkpoint: Falseuse_cpu: Falseseed: 42data_seed: 42bf16: Falsefp16: Falsebf16_full_eval: Falsefp16_full_eval: Falsetf32: Nonelocal_rank: -1ddp_backend: Nonedebug: []dataloader_drop_last: Falsedataloader_num_workers: 0dataloader_prefetch_factor: Nonedisable_tqdm: Falseremove_unused_columns: Truelabel_names: Noneload_best_model_at_end: Falseignore_data_skip: Falsefsdp: []fsdp_config: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}accelerator_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: Nonegroup_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: Truepush_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_for_metrics: []eval_do_concat_batches: Trueauto_find_batch_size: Falsefull_determinism: Falseddp_timeout: 1800torch_compile: Falsetorch_compile_backend: Nonetorch_compile_mode: Noneinclude_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: Trueuse_cache: Falseprompts: Nonebatch_sampler: no_duplicatesmulti_dataset_batch_sampler: proportionalrouter_mapping: {}learning_rate_mapping: {}| Epoch | Step | Training Loss | Validation Loss |
|---|---|---|---|
| 0.3521 | 25 | 4.0006 | - |
| 0.7042 | 50 | 3.4527 | - |
| 1.0 | 71 | - | 3.5100 |
| 1.0563 | 75 | 3.2057 | - |
| 1.4085 | 100 | 3.0174 | - |
| 1.7606 | 125 | 2.9600 | - |
| 2.0 | 142 | - | 2.7478 |
| 2.1127 | 150 | 3.0995 | - |
| 2.4648 | 175 | 2.9674 | - |
| 2.8169 | 200 | 2.7930 | - |
| 3.0 | 213 | - | 2.6887 |
@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",
}
@article{10531646,
author={Huang, Xiang and Peng, Hao and Zou, Dongcheng and Liu, Zhiwei and Li, Jianxin and Liu, Kay and Wu, Jia and Su, Jianlin and Yu, Philip S.},
journal={IEEE/ACM Transactions on Audio, Speech, and Language Processing},
title={CoSENT: Consistent Sentence Embedding via Similarity Ranking},
year={2024},
doi={10.1109/TASLP.2024.3402087}
}
Base model
intfloat/multilingual-e5-small