|
|
--- |
|
|
tags: |
|
|
- sentence-transformers |
|
|
- sentence-similarity |
|
|
- feature-extraction |
|
|
- dense |
|
|
- generated_from_trainer |
|
|
- dataset_size:903776 |
|
|
- loss:MultipleNegativesSymmetricRankingLoss |
|
|
base_model: sentence-transformers/all-MiniLM-L6-v2 |
|
|
widget: |
|
|
- source_sentence: pink n' yellow |
|
|
sentences: |
|
|
- mirror |
|
|
- pink mirror |
|
|
- cups set of 3 |
|
|
- source_sentence: uniq hybrid iphone 14 plus magclick charging transforma - electric |
|
|
(blue) |
|
|
sentences: |
|
|
- electronic accessory |
|
|
- iphone accessories. |
|
|
- black rustic sk on a stand |
|
|
- source_sentence: suhana garam masala spices |
|
|
sentences: |
|
|
- ilou good france bulmat korean dressing |
|
|
- ' garam spices masala' |
|
|
- grain |
|
|
- source_sentence: seaboat-5 240/2 sea fishing combo |
|
|
sentences: |
|
|
- fishing |
|
|
- cork handle fishing rod |
|
|
- camping bed basic camp bed 60 cm 1 person |
|
|
- source_sentence: ouzi veal meat pieces with basmati rice |
|
|
sentences: |
|
|
- new crunchy |
|
|
- deli |
|
|
- ouzi veal meat basmati rice |
|
|
pipeline_tag: sentence-similarity |
|
|
library_name: sentence-transformers |
|
|
metrics: |
|
|
- cosine_accuracy |
|
|
model-index: |
|
|
- name: SentenceTransformer based on sentence-transformers/all-MiniLM-L6-v2 |
|
|
results: |
|
|
- task: |
|
|
type: triplet |
|
|
name: Triplet |
|
|
dataset: |
|
|
name: Unknown |
|
|
type: unknown |
|
|
metrics: |
|
|
- type: cosine_accuracy |
|
|
value: 0.9757025241851807 |
|
|
name: Cosine Accuracy |
|
|
--- |
|
|
|
|
|
# SentenceTransformer based on sentence-transformers/all-MiniLM-L6-v2 |
|
|
|
|
|
This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [sentence-transformers/all-MiniLM-L6-v2](https://huggingface.co/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. |
|
|
|
|
|
## Model Details |
|
|
|
|
|
### Model Description |
|
|
- **Model Type:** Sentence Transformer |
|
|
- **Base model:** [sentence-transformers/all-MiniLM-L6-v2](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2) <!-- at revision c9745ed1d9f207416be6d2e6f8de32d1f16199bf --> |
|
|
- **Maximum Sequence Length:** 256 tokens |
|
|
- **Output Dimensionality:** 384 dimensions |
|
|
- **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/huggingface/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, '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() |
|
|
) |
|
|
``` |
|
|
|
|
|
## 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("LamaDiab/MiniLM-v34-SemanticEngine") |
|
|
# Run inference |
|
|
sentences = [ |
|
|
'ouzi veal meat pieces with basmati rice', |
|
|
'ouzi veal meat basmati rice', |
|
|
'new crunchy', |
|
|
] |
|
|
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.9571, 0.1985], |
|
|
# [0.9571, 1.0000, 0.1760], |
|
|
# [0.1985, 0.1760, 1.0000]]) |
|
|
``` |
|
|
|
|
|
<!-- |
|
|
### 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 |
|
|
|
|
|
#### Triplet |
|
|
|
|
|
* Evaluated with [<code>TripletEvaluator</code>](https://sbert.net/docs/package_reference/sentence_transformer/evaluation.html#sentence_transformers.evaluation.TripletEvaluator) |
|
|
|
|
|
| Metric | Value | |
|
|
|:--------------------|:-----------| |
|
|
| **cosine_accuracy** | **0.9757** | |
|
|
|
|
|
<!-- |
|
|
## 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: 903,776 training samples |
|
|
* Columns: <code>anchor</code>, <code>positive</code>, and <code>itemCategory</code> |
|
|
* Approximate statistics based on the first 1000 samples: |
|
|
| | anchor | positive | itemCategory | |
|
|
|:--------|:----------------------------------------------------------------------------------|:---------------------------------------------------------------------------------|:--------------------------------------------------------------------------------| |
|
|
| type | string | string | string | |
|
|
| details | <ul><li>min: 3 tokens</li><li>mean: 10.14 tokens</li><li>max: 30 tokens</li></ul> | <ul><li>min: 3 tokens</li><li>mean: 5.35 tokens</li><li>max: 17 tokens</li></ul> | <ul><li>min: 3 tokens</li><li>mean: 4.02 tokens</li><li>max: 9 tokens</li></ul> | |
|
|
* Samples: |
|
|
| anchor | positive | itemCategory | |
|
|
|:-------------------------------------------------------------------------------------|:----------------------------------------|:---------------------------------------| |
|
|
| <code>leather hikng insole - hike 550</code> | <code>hiking insole leather hike</code> | <code>hiking</code> | |
|
|
| <code>thermal food bag nasturtium high dark grey 5 l 1 zipper 11808 red space</code> | <code>school supply accessories</code> | <code>school supply accessories</code> | |
|
|
| <code>cleo eye moisturizer</code> | <code>eye treatment</code> | <code>eye treatment</code> | |
|
|
* Loss: [<code>MultipleNegativesSymmetricRankingLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#multiplenegativessymmetricrankingloss) with these parameters: |
|
|
```json |
|
|
{ |
|
|
"scale": 20.0, |
|
|
"similarity_fct": "cos_sim", |
|
|
"gather_across_devices": false |
|
|
} |
|
|
``` |
|
|
|
|
|
### Evaluation Dataset |
|
|
|
|
|
#### Unnamed Dataset |
|
|
|
|
|
* Size: 9,466 evaluation samples |
|
|
* Columns: <code>anchor</code>, <code>positive</code>, <code>negative</code>, and <code>itemCategory</code> |
|
|
* Approximate statistics based on the first 1000 samples: |
|
|
| | anchor | positive | negative | itemCategory | |
|
|
|:--------|:---------------------------------------------------------------------------------|:----------------------------------------------------------------------------------|:---------------------------------------------------------------------------------|:--------------------------------------------------------------------------------| |
|
|
| type | string | string | string | string | |
|
|
| details | <ul><li>min: 3 tokens</li><li>mean: 9.65 tokens</li><li>max: 32 tokens</li></ul> | <ul><li>min: 3 tokens</li><li>mean: 5.78 tokens</li><li>max: 131 tokens</li></ul> | <ul><li>min: 3 tokens</li><li>mean: 9.17 tokens</li><li>max: 33 tokens</li></ul> | <ul><li>min: 3 tokens</li><li>mean: 3.82 tokens</li><li>max: 9 tokens</li></ul> | |
|
|
* Samples: |
|
|
| anchor | positive | negative | itemCategory | |
|
|
|:-------------------------------------------------------|:-----------------------------|:---------------------------------------------|:----------------------| |
|
|
| <code>extra bubblemint sugar free chewing gum</code> | <code>bubbly gum</code> | <code>peeled baby pineapple, thailand</code> | <code>sweet</code> | |
|
|
| <code>golden pothos</code> | <code>evergreen plant</code> | <code>cleansing hand gel 75ml</code> | <code>plant</code> | |
|
|
| <code>effortless style slit linen pants - beige</code> | <code>beige pants</code> | <code>antidote microfiber towel</code> | <code>trousers</code> | |
|
|
* Loss: [<code>MultipleNegativesSymmetricRankingLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#multiplenegativessymmetricrankingloss) with these parameters: |
|
|
```json |
|
|
{ |
|
|
"scale": 20.0, |
|
|
"similarity_fct": "cos_sim", |
|
|
"gather_across_devices": false |
|
|
} |
|
|
``` |
|
|
|
|
|
### Training Hyperparameters |
|
|
#### Non-Default Hyperparameters |
|
|
|
|
|
- `eval_strategy`: steps |
|
|
- `per_device_train_batch_size`: 256 |
|
|
- `per_device_eval_batch_size`: 256 |
|
|
- `learning_rate`: 3e-05 |
|
|
- `weight_decay`: 0.001 |
|
|
- `num_train_epochs`: 4 |
|
|
- `warmup_ratio`: 0.2 |
|
|
- `fp16`: True |
|
|
- `dataloader_num_workers`: 1 |
|
|
- `dataloader_prefetch_factor`: 2 |
|
|
- `dataloader_persistent_workers`: True |
|
|
- `push_to_hub`: True |
|
|
- `hub_model_id`: LamaDiab/MiniLM-v34-SemanticEngine |
|
|
- `hub_strategy`: all_checkpoints |
|
|
|
|
|
#### 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`: 256 |
|
|
- `per_device_eval_batch_size`: 256 |
|
|
- `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`: 3e-05 |
|
|
- `weight_decay`: 0.001 |
|
|
- `adam_beta1`: 0.9 |
|
|
- `adam_beta2`: 0.999 |
|
|
- `adam_epsilon`: 1e-08 |
|
|
- `max_grad_norm`: 1.0 |
|
|
- `num_train_epochs`: 4 |
|
|
- `max_steps`: -1 |
|
|
- `lr_scheduler_type`: linear |
|
|
- `lr_scheduler_kwargs`: {} |
|
|
- `warmup_ratio`: 0.2 |
|
|
- `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`: 1 |
|
|
- `dataloader_prefetch_factor`: 2 |
|
|
- `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`: True |
|
|
- `skip_memory_metrics`: True |
|
|
- `use_legacy_prediction_loop`: False |
|
|
- `push_to_hub`: True |
|
|
- `resume_from_checkpoint`: None |
|
|
- `hub_model_id`: LamaDiab/MiniLM-v34-SemanticEngine |
|
|
- `hub_strategy`: all_checkpoints |
|
|
- `hub_private_repo`: None |
|
|
- `hub_always_push`: False |
|
|
- `hub_revision`: None |
|
|
- `gradient_checkpointing`: False |
|
|
- `gradient_checkpointing_kwargs`: None |
|
|
- `include_inputs_for_metrics`: False |
|
|
- `include_for_metrics`: [] |
|
|
- `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 |
|
|
- `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 |
|
|
- `use_liger_kernel`: False |
|
|
- `liger_kernel_config`: None |
|
|
- `eval_use_gather_object`: False |
|
|
- `average_tokens_across_devices`: False |
|
|
- `prompts`: None |
|
|
- `batch_sampler`: batch_sampler |
|
|
- `multi_dataset_batch_sampler`: proportional |
|
|
- `router_mapping`: {} |
|
|
- `learning_rate_mapping`: {} |
|
|
|
|
|
</details> |
|
|
|
|
|
### Training Logs |
|
|
| Epoch | Step | Training Loss | Validation Loss | cosine_accuracy | |
|
|
|:------:|:-----:|:-------------:|:---------------:|:---------------:| |
|
|
| 0.0003 | 1 | 2.7345 | - | - | |
|
|
| 0.2832 | 1000 | 2.3628 | 1.1045 | 0.9550 | |
|
|
| 0.5664 | 2000 | 1.8255 | 1.0202 | 0.9660 | |
|
|
| 0.8496 | 3000 | 1.6176 | 0.9256 | 0.9693 | |
|
|
| 1.1327 | 4000 | 1.9619 | 0.8905 | 0.9714 | |
|
|
| 1.4158 | 5000 | 1.4568 | 0.8822 | 0.9725 | |
|
|
| 1.6988 | 6000 | 1.3739 | 0.8738 | 0.9725 | |
|
|
| 1.9819 | 7000 | 1.3245 | 0.8641 | 0.9744 | |
|
|
| 2.2649 | 8000 | 1.2634 | 0.8607 | 0.9750 | |
|
|
| 2.5480 | 9000 | 1.246 | 0.8551 | 0.9744 | |
|
|
| 2.8310 | 10000 | 1.2144 | 0.8519 | 0.9755 | |
|
|
| 3.1141 | 11000 | 1.1947 | 0.8548 | 0.9755 | |
|
|
| 3.3971 | 12000 | 1.1763 | 0.8565 | 0.9757 | |
|
|
| 3.6802 | 13000 | 1.1602 | 0.8564 | 0.9755 | |
|
|
| 3.9632 | 14000 | 1.1548 | 0.8540 | 0.9757 | |
|
|
|
|
|
|
|
|
### Framework Versions |
|
|
- Python: 3.11.13 |
|
|
- Sentence Transformers: 5.1.2 |
|
|
- Transformers: 4.53.3 |
|
|
- PyTorch: 2.6.0+cu124 |
|
|
- Accelerate: 1.9.0 |
|
|
- Datasets: 4.4.1 |
|
|
- Tokenizers: 0.21.2 |
|
|
|
|
|
## 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.* |
|
|
--> |
