Sentence Similarity
sentence-transformers
Safetensors
bert
feature-extraction
Generated from Trainer
dataset_size:6577
loss:CosineSimilarityLoss
Eval Results (legacy)
text-embeddings-inference
Instructions to use Data-Lab/multilingual-e5-small-cross-encoder-v0.1 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- sentence-transformers
How to use Data-Lab/multilingual-e5-small-cross-encoder-v0.1 with sentence-transformers:
from sentence_transformers import SentenceTransformer model = SentenceTransformer("Data-Lab/multilingual-e5-small-cross-encoder-v0.1") sentences = [ "query: алерана бальзам", "passage: Мороженое \"Джиандуйя\" фундучно-шоколад.; Шоколадный пломбир с фундуком в шоколаде. Нежная сливочная текстура.; Мороженое; Цена: 138.0; Рейтинг: 4.9", "passage: Нюда спрей д/местного применения педикулицидный 50мл; Средство с физическим принципом действия для уничтожения головных вшей, личинок и гнид; Лекарственные средства; Цена: 1136.0; Рейтинг: 0.0", "passage: АнвиМакс Мед-Лимон пор.д/приг.р-ра д/приема внутрь пак.№12; Препарат для лечения гриппа и ОРВИ. Комбинирует противовирусное и симптоматическое действие.; Лекарственные средства; Цена: 806.0; Рейтинг: 0.0" ] embeddings = model.encode(sentences) similarities = model.similarity(embeddings, embeddings) print(similarities.shape) # [4, 4] - Notebooks
- Google Colab
- Kaggle
| base_model: intfloat/multilingual-e5-small | |
| library_name: sentence-transformers | |
| metrics: | |
| - pearson_cosine | |
| - spearman_cosine | |
| - pearson_manhattan | |
| - spearman_manhattan | |
| - pearson_euclidean | |
| - spearman_euclidean | |
| - pearson_dot | |
| - spearman_dot | |
| - pearson_max | |
| - spearman_max | |
| pipeline_tag: sentence-similarity | |
| tags: | |
| - sentence-transformers | |
| - sentence-similarity | |
| - feature-extraction | |
| - generated_from_trainer | |
| - dataset_size:6577 | |
| - loss:CosineSimilarityLoss | |
| widget: | |
| - source_sentence: 'query: алерана бальзам' | |
| sentences: | |
| - 'passage: Мороженое "Джиандуйя" фундучно-шоколад.; Шоколадный пломбир с фундуком | |
| в шоколаде. Нежная сливочная текстура.; Мороженое; Цена: 138.0; Рейтинг: 4.9' | |
| - 'passage: Нюда спрей д/местного применения педикулицидный 50мл; Средство с физическим | |
| принципом действия для уничтожения головных вшей, личинок и гнид; Лекарственные | |
| средства; Цена: 1136.0; Рейтинг: 0.0' | |
| - 'passage: АнвиМакс Мед-Лимон пор.д/приг.р-ра д/приема внутрь пак.№12; Препарат | |
| для лечения гриппа и ОРВИ. Комбинирует противовирусное и симптоматическое действие.; | |
| Лекарственные средства; Цена: 806.0; Рейтинг: 0.0' | |
| - source_sentence: 'query: тунец' | |
| sentences: | |
| - 'passage: Мармелад жевательный "Ассорти"; Жевательный мармелад с насыщенным фруктовым | |
| вкусом. ; Мармелад, халва, зефир, восточные сладости; Цена: 106.0; Рейтинг: 4.9' | |
| - 'passage: Фаритол сироп 150мл Подорожник/Алтей/Чабрец; Сироп подорожника, алтея | |
| и чабреца для детей с 3-х лет и взрослых. ЭКСТРАКТ ЛИСТЬЕВ ПОДОРОЖНИКА обладает | |
| успокаивающим действием на горло и голосовые связки. Оказывает отхаркивающее действие | |
| и способствует более быстрому выведению мокроты из бронхов. ЭКСТРАКТ ЧАБРЕЦА обладает | |
| бактерицидным, противовоспалительным, отхаркивающим свойствами. Оказывает успокаивающее | |
| и смягчающее действие на слизистые. Способствует снижению вязкости мокроты, разрыхлению | |
| воспалительных налетов, ускоряя выведение из организма продуктов воспаления и | |
| слизистых масс. ЭКСТРАКТ КОРНЕЙ АЛТЕЯ мягко обволакивая слизистые оболочки, препятствует | |
| их раздражению и обладает смягчающим и увлажняющим свойствами. Активизируя двигательную | |
| активность реснитчатого эпителия верхних дыхательных путей, способствует разжижению | |
| слизи, стимулирует высвобождение дыхательных каналов от мокроты.; Витамины, БАДы; | |
| Цена: 278.0; Рейтинг: 0.0' | |
| - 'passage: Батончик протеиновый Snaq Fabriq Арахис и карамель 50 г; Протеиновый | |
| батончик с натуральными ингредиентами, без сахара и глютена.; Батончики; Цена: | |
| 99.0; Рейтинг: 4.9' | |
| - source_sentence: 'query: вареники сулугуни' | |
| sentences: | |
| - 'passage: Чипсы Naitori из морских водорослей 3 г; Хрустящие чипсы из водорослей | |
| нори, обжаренные на оливковом масле с солью. ; Снеки; Цена: 55.0; Рейтинг: 4.9' | |
| - 'passage: Вареники с вишневой начинкой, 500 г; Постные вареники с вишней, тонким | |
| тестом; Пельмени, вареники и манты; Цена: 336.0; Рейтинг: 4.7' | |
| - 'passage: Протеин сывороточный "Ваниль"; Сывороточный протеин с ванильным вкусом; | |
| Протеин; Цена: 1464.0; Рейтинг: 4.9' | |
| - source_sentence: 'query: каша молочно' | |
| sentences: | |
| - 'passage: Вишня сушеная, 1 кг; Спелая, сочная вишня, высушена, чтобы сохранить | |
| цвет и вкус; Орехи, сухофрукты; Цена: 3000.0; Рейтинг: 4.6' | |
| - 'passage: Крем для тела с кислотами Acid Cloud, 250 мл; Крем с энзимами и кислотами | |
| для красоты и здоровья кожи. Борется с высыпаниями, шелушениями и постакне, возвращает | |
| мягкость коже.; Кремы косметические; Цена: 1792.0; Рейтинг: 5.0' | |
| - 'passage: Шоколад ремесленный горький 74%; Ремесленный шоколад из перуанских и | |
| колумбийских какао-бобов; Шоколад; Цена: 310.0; Рейтинг: 4.9' | |
| - source_sentence: 'query: хачапури по аджарски' | |
| sentences: | |
| - 'passage: Напиток на чайном грибе с цветами липы и чабрецом, 350 мл; Тонизирующий | |
| напиток природного брожения. Приготовлен на чистой культуре чайного гриба с цветами | |
| липы, чабрецом и иван-чаем. Вкус: кислинка и терпкость трав.; Квас; Цена: 98.0; | |
| Рейтинг: 4.7' | |
| - 'passage: Дезодорант-антиперспирант Nivea Men Серебряная защита 50 мл; Антибактериальный | |
| дезодорант с ионами серебра для защиты от пота и запаха на 99,9%. Успокаивает | |
| кожу и имеет свежий мужской аромат. Не содержит спирта.; Дезодоранты; Цена: 395.0; | |
| Рейтинг: 4.9' | |
| - 'passage: Икра трески, 240 г; Нежная подсоленная икра тихоокеанской трески. С | |
| узнаваемым, чуть сладковатым вкусом и зернистой текстурой. Идеально подходит для | |
| сэндвичей, канапе и салатов.; Икра; Цена: 207.0; Рейтинг: 4.8' | |
| model-index: | |
| - name: SentenceTransformer based on intfloat/multilingual-e5-small | |
| results: | |
| - task: | |
| type: semantic-similarity | |
| name: Semantic Similarity | |
| dataset: | |
| name: dev | |
| type: dev | |
| metrics: | |
| - type: pearson_cosine | |
| value: 0.8058103374607081 | |
| name: Pearson Cosine | |
| - type: spearman_cosine | |
| value: 0.8022089220262975 | |
| name: Spearman Cosine | |
| - type: pearson_manhattan | |
| value: 0.7663931903358694 | |
| name: Pearson Manhattan | |
| - type: spearman_manhattan | |
| value: 0.8007955322402943 | |
| name: Spearman Manhattan | |
| - type: pearson_euclidean | |
| value: 0.7686449116883721 | |
| name: Pearson Euclidean | |
| - type: spearman_euclidean | |
| value: 0.8022089220262975 | |
| name: Spearman Euclidean | |
| - type: pearson_dot | |
| value: 0.8058103383272679 | |
| name: Pearson Dot | |
| - type: spearman_dot | |
| value: 0.8022089220262975 | |
| name: Spearman Dot | |
| - type: pearson_max | |
| value: 0.8058103383272679 | |
| name: Pearson Max | |
| - type: spearman_max | |
| value: 0.8022089220262975 | |
| name: Spearman Max | |
| # SentenceTransformer based on intfloat/multilingual-e5-small | |
| This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [intfloat/multilingual-e5-small](https://huggingface.co/intfloat/multilingual-e5-small). 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. | |
| ## Model Details | |
| ### Model Description | |
| - **Model Type:** Sentence Transformer | |
| - **Base model:** [intfloat/multilingual-e5-small](https://huggingface.co/intfloat/multilingual-e5-small) <!-- at revision fd1525a9fd15316a2d503bf26ab031a61d056e98 --> | |
| - **Maximum Sequence Length:** 256 tokens | |
| - **Output Dimensionality:** 384 tokens | |
| - **Similarity Function:** Cosine Similarity | |
| <!-- - **Training Dataset:** Unknown --> | |
| <!-- - **Language:** Unknown --> | |
| <!-- - **License:** Unknown --> | |
| ### Model Sources | |
| - **Documentation:** [Sentence Transformers Documentation](https://sbert.net) | |
| - **Repository:** [Sentence Transformers on GitHub](https://github.com/UKPLab/sentence-transformers) | |
| - **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers) | |
| ### Full Model Architecture | |
| ``` | |
| SentenceTransformer( | |
| (0): Transformer({'max_seq_length': 256, 'do_lower_case': False}) with Transformer model: 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() | |
| ) | |
| ``` | |
| ## Usage | |
| ### Direct Usage (Sentence Transformers) | |
| First install the Sentence Transformers library: | |
| ```bash | |
| pip install -U sentence-transformers | |
| ``` | |
| Then you can load this model and run inference. | |
| ```python | |
| from sentence_transformers import SentenceTransformer | |
| # Download from the 🤗 Hub | |
| model = SentenceTransformer("Data-Lab/multilingual-e5-small-cross-encoder-v0.1") | |
| # Run inference | |
| sentences = [ | |
| 'query: хачапури по аджарски', | |
| 'passage: Напиток на чайном грибе с цветами липы и чабрецом, 350 мл; Тонизирующий напиток природного брожения. Приготовлен на чистой культуре чайного гриба с цветами липы, чабрецом и иван-чаем. Вкус: кислинка и терпкость трав.; Квас; Цена: 98.0; Рейтинг: 4.7', | |
| 'passage: Икра трески, 240 г; Нежная подсоленная икра тихоокеанской трески. С узнаваемым, чуть сладковатым вкусом и зернистой текстурой. Идеально подходит для сэндвичей, канапе и салатов.; Икра; Цена: 207.0; Рейтинг: 4.8', | |
| ] | |
| embeddings = model.encode(sentences) | |
| print(embeddings.shape) | |
| # [3, 384] | |
| # Get the similarity scores for the embeddings | |
| similarities = model.similarity(embeddings, embeddings) | |
| print(similarities.shape) | |
| # [3, 3] | |
| ``` | |
| <!-- | |
| ### Direct Usage (Transformers) | |
| <details><summary>Click to see the direct usage in Transformers</summary> | |
| </details> | |
| --> | |
| <!-- | |
| ### Downstream Usage (Sentence Transformers) | |
| You can finetune this model on your own dataset. | |
| <details><summary>Click to expand</summary> | |
| </details> | |
| --> | |
| <!-- | |
| ### Out-of-Scope Use | |
| *List how the model may foreseeably be misused and address what users ought not to do with the model.* | |
| --> | |
| ## Evaluation | |
| ### Metrics | |
| #### Semantic Similarity | |
| * Dataset: `dev` | |
| * Evaluated with [<code>EmbeddingSimilarityEvaluator</code>](https://sbert.net/docs/package_reference/sentence_transformer/evaluation.html#sentence_transformers.evaluation.EmbeddingSimilarityEvaluator) | |
| | Metric | Value | | |
| |:-------------------|:-----------| | |
| | pearson_cosine | 0.8058 | | |
| | spearman_cosine | 0.8022 | | |
| | pearson_manhattan | 0.7664 | | |
| | spearman_manhattan | 0.8008 | | |
| | pearson_euclidean | 0.7686 | | |
| | spearman_euclidean | 0.8022 | | |
| | pearson_dot | 0.8058 | | |
| | spearman_dot | 0.8022 | | |
| | pearson_max | 0.8058 | | |
| | **spearman_max** | **0.8022** | | |
| <!-- | |
| ## Bias, Risks and Limitations | |
| *What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.* | |
| --> | |
| <!-- | |
| ### Recommendations | |
| *What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.* | |
| --> | |
| ## Training Details | |
| ### Training Dataset | |
| #### Unnamed Dataset | |
| * Size: 6,577 training samples | |
| * Columns: <code>sentence_0</code>, <code>sentence_1</code>, and <code>label</code> | |
| * Approximate statistics based on the first 1000 samples: | |
| | | sentence_0 | sentence_1 | label | | |
| |:--------|:---------------------------------------------------------------------------------|:------------------------------------------------------------------------------------|:--------------------------------------------------------------| | |
| | type | string | string | float | | |
| | details | <ul><li>min: 6 tokens</li><li>mean: 8.99 tokens</li><li>max: 18 tokens</li></ul> | <ul><li>min: 34 tokens</li><li>mean: 67.08 tokens</li><li>max: 256 tokens</li></ul> | <ul><li>min: 0.0</li><li>mean: 0.5</li><li>max: 1.0</li></ul> | | |
| * Samples: | |
| | sentence_0 | sentence_1 | label | | |
| |:------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------| | |
| | <code>query: ополаскиватель для рта</code> | <code>passage: Блин сырный по-голландски; Голландский сырный блинчик с пикантным чесноком и домашним майонезом; Блины; Цена: 218.0; Рейтинг: 4.8</code> | <code>0.0</code> | | |
| | <code>query: таблетки для посудомоечной машины</code> | <code>passage: Десерт многослойный с фруктовым соком; Сочное желе из натуральных соков с фруктозно-глюкозным сиропом. Кисло-сладкий десерт.; Пирожные, муссы, суфле; Цена: 75.0; Рейтинг: 4.8</code> | <code>0.0</code> | | |
| | <code>query: пельмени с индейкой мини</code> | <code>passage: Кумин молотый Золото Индии; Сильный сладковато-горький вкус. Идеально с рыбой, молочными продуктами и овощами.; Специи и приправы; Цена: 137.0; Рейтинг: 4.9</code> | <code>0.0</code> | | |
| * Loss: [<code>CosineSimilarityLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#cosinesimilarityloss) with these parameters: | |
| ```json | |
| { | |
| "loss_fct": "torch.nn.modules.loss.MSELoss" | |
| } | |
| ``` | |
| ### Training Hyperparameters | |
| #### Non-Default Hyperparameters | |
| - `eval_strategy`: steps | |
| - `per_device_train_batch_size`: 32 | |
| - `per_device_eval_batch_size`: 32 | |
| - `fp16`: True | |
| - `multi_dataset_batch_sampler`: round_robin | |
| #### All Hyperparameters | |
| <details><summary>Click to expand</summary> | |
| - `overwrite_output_dir`: False | |
| - `do_predict`: False | |
| - `eval_strategy`: steps | |
| - `prediction_loss_only`: True | |
| - `per_device_train_batch_size`: 32 | |
| - `per_device_eval_batch_size`: 32 | |
| - `per_gpu_train_batch_size`: None | |
| - `per_gpu_eval_batch_size`: None | |
| - `gradient_accumulation_steps`: 1 | |
| - `eval_accumulation_steps`: None | |
| - `torch_empty_cache_steps`: None | |
| - `learning_rate`: 5e-05 | |
| - `weight_decay`: 0.0 | |
| - `adam_beta1`: 0.9 | |
| - `adam_beta2`: 0.999 | |
| - `adam_epsilon`: 1e-08 | |
| - `max_grad_norm`: 1 | |
| - `num_train_epochs`: 3 | |
| - `max_steps`: -1 | |
| - `lr_scheduler_type`: linear | |
| - `lr_scheduler_kwargs`: {} | |
| - `warmup_ratio`: 0.0 | |
| - `warmup_steps`: 0 | |
| - `log_level`: passive | |
| - `log_level_replica`: warning | |
| - `log_on_each_node`: True | |
| - `logging_nan_inf_filter`: True | |
| - `save_safetensors`: True | |
| - `save_on_each_node`: False | |
| - `save_only_model`: False | |
| - `restore_callback_states_from_checkpoint`: False | |
| - `no_cuda`: False | |
| - `use_cpu`: False | |
| - `use_mps_device`: False | |
| - `seed`: 42 | |
| - `data_seed`: None | |
| - `jit_mode_eval`: False | |
| - `use_ipex`: False | |
| - `bf16`: False | |
| - `fp16`: True | |
| - `fp16_opt_level`: O1 | |
| - `half_precision_backend`: auto | |
| - `bf16_full_eval`: False | |
| - `fp16_full_eval`: False | |
| - `tf32`: None | |
| - `local_rank`: 0 | |
| - `ddp_backend`: None | |
| - `tpu_num_cores`: None | |
| - `tpu_metrics_debug`: False | |
| - `debug`: [] | |
| - `dataloader_drop_last`: False | |
| - `dataloader_num_workers`: 0 | |
| - `dataloader_prefetch_factor`: None | |
| - `past_index`: -1 | |
| - `disable_tqdm`: False | |
| - `remove_unused_columns`: True | |
| - `label_names`: None | |
| - `load_best_model_at_end`: False | |
| - `ignore_data_skip`: False | |
| - `fsdp`: [] | |
| - `fsdp_min_num_params`: 0 | |
| - `fsdp_config`: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False} | |
| - `fsdp_transformer_layer_cls_to_wrap`: None | |
| - `accelerator_config`: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None} | |
| - `deepspeed`: None | |
| - `label_smoothing_factor`: 0.0 | |
| - `optim`: adamw_torch | |
| - `optim_args`: None | |
| - `adafactor`: False | |
| - `group_by_length`: False | |
| - `length_column_name`: length | |
| - `ddp_find_unused_parameters`: None | |
| - `ddp_bucket_cap_mb`: None | |
| - `ddp_broadcast_buffers`: False | |
| - `dataloader_pin_memory`: True | |
| - `dataloader_persistent_workers`: False | |
| - `skip_memory_metrics`: True | |
| - `use_legacy_prediction_loop`: False | |
| - `push_to_hub`: False | |
| - `resume_from_checkpoint`: None | |
| - `hub_model_id`: None | |
| - `hub_strategy`: every_save | |
| - `hub_private_repo`: False | |
| - `hub_always_push`: False | |
| - `gradient_checkpointing`: False | |
| - `gradient_checkpointing_kwargs`: None | |
| - `include_inputs_for_metrics`: False | |
| - `eval_do_concat_batches`: True | |
| - `fp16_backend`: auto | |
| - `push_to_hub_model_id`: None | |
| - `push_to_hub_organization`: None | |
| - `mp_parameters`: | |
| - `auto_find_batch_size`: False | |
| - `full_determinism`: False | |
| - `torchdynamo`: None | |
| - `ray_scope`: last | |
| - `ddp_timeout`: 1800 | |
| - `torch_compile`: False | |
| - `torch_compile_backend`: None | |
| - `torch_compile_mode`: None | |
| - `dispatch_batches`: None | |
| - `split_batches`: None | |
| - `include_tokens_per_second`: False | |
| - `include_num_input_tokens_seen`: False | |
| - `neftune_noise_alpha`: None | |
| - `optim_target_modules`: None | |
| - `batch_eval_metrics`: False | |
| - `eval_on_start`: False | |
| - `eval_use_gather_object`: False | |
| - `batch_sampler`: batch_sampler | |
| - `multi_dataset_batch_sampler`: round_robin | |
| </details> | |
| ### Training Logs | |
| | Epoch | Step | dev_spearman_max | | |
| |:-----:|:----:|:----------------:| | |
| | 1.0 | 103 | 0.8078 | | |
| | 2.0 | 206 | 0.8052 | | |
| | 3.0 | 309 | 0.8022 | | |
| ### Framework Versions | |
| - Python: 3.10.12 | |
| - Sentence Transformers: 3.2.0 | |
| - Transformers: 4.44.0 | |
| - PyTorch: 2.3.1+cu121 | |
| - Accelerate: 0.31.0 | |
| - Datasets: 2.20.0 | |
| - Tokenizers: 0.19.1 | |
| ## Citation | |
| ### BibTeX | |
| #### Sentence Transformers | |
| ```bibtex | |
| @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", | |
| } | |
| ``` | |
| <!-- | |
| ## Glossary | |
| *Clearly define terms in order to be accessible across audiences.* | |
| --> | |
| <!-- | |
| ## Model Card Authors | |
| *Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.* | |
| --> | |
| <!-- | |
| ## Model Card Contact | |
| *Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.* | |
| --> |