README.md

---
tags:
- sentence-transformers
- sentence-similarity
- feature-extraction
- generated_from_trainer
- dataset_size:126423
- loss:MultipleNegativesRankingLoss
base_model: intfloat/multilingual-e5-base
widget:
- source_sentence: چگونه باید درست از سال اول آماده شوم تا Google Summer of Code را
    ترک کنم؟
  sentences:
  - یک پروژه ترم خوب برای یک دوره تجزیه و تحلیل مدار چیست؟
  - چگونه می توانم تابستان کد GSOC-Google را ترک کنم؟
  - یک بازیکن فوتبال در حال پوشیدن بازوبندهای مشکی است
- source_sentence: چه معنایی دارد وقتی یک دختر یک روز برای پاسخ به متن شما می رود؟
  sentences:
  - وقتی دختران یک روز بعد به یک متن پاسخ می دهند چیست؟
  - چه کسی باید در سال 2017 به عنوان رئیس جمهور هند انتخاب شود؟
  - دریافت تابش از لپ تاپ من چقدر مضر است؟
- source_sentence: اقدامات احتیاطی ایمنی در مورد استفاده از اسلحه های پیشنهادی NRA
    در ماساچوست چیست؟
  sentences:
  - چه کسی بیشترین پیروان را در Quora دارد؟
  - اقدامات احتیاطی ایمنی در مورد استفاده از اسلحه های پیشنهادی NRA در نیوجرسی چیست؟
  - خواهرم عادت عجیبی دارد که در محل کار خود بخوابد.او چه کاری باید انجام دهد؟
- source_sentence: چگونه می توانم انگلیسی شفاهی را به خوبی یاد بگیرم؟
  sentences:
  - چه کاری انجام می دهم اگر من انگلیسی را خوب یاد بگیرم؟
  - چگونه می توانم مکانیک کوانتومی را درک کنم؟
  - بهترین راه برای تمیز کردن مانیتورهای LCD چیست؟
- source_sentence: من می خواهم آماده سازی برای امتحان IAS را شروع کنم ، چگونه باید
    ادامه دهم؟
  sentences:
  - کشورهایی را که ایالت اسرائیل را به رسمیت نمی شناسند نامگذاری کنید؟
  - چگونه می توانم آماده سازی برای آزمون UPSC را شروع کنم؟
  - یک کوهنورد یک صخره را می‌گیرد و مرد دیگر یک دیوار را با طناب می‌بندد
pipeline_tag: sentence-similarity
library_name: sentence-transformers
---

# SentenceTransformer based on intfloat/multilingual-e5-base

This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [intfloat/multilingual-e5-base](https://huggingface.co/intfloat/multilingual-e5-base). It maps sentences & paragraphs to a 768-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-base](https://huggingface.co/intfloat/multilingual-e5-base) <!-- at revision 835193815a3936a24a0ee7dc9e3d48c1fbb19c55 -->
- **Maximum Sequence Length:** 512 tokens
- **Output Dimensionality:** 768 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/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': 512, 'do_lower_case': False}) with Transformer model: XLMRobertaModel 
  (1): Pooling({'word_embedding_dimension': 768, '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("codersan/newfa_e5base")
# Run inference
sentences = [
    'من می خواهم آماده سازی برای امتحان IAS را شروع کنم ، چگونه باید ادامه دهم؟',
    'چگونه می توانم آماده سازی برای آزمون UPSC را شروع کنم؟',
    'یک کوهنورد یک صخره را می\u200cگیرد و مرد دیگر یک دیوار را با طناب می\u200cبندد',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 768]

# 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.*
-->

<!--
## 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: 126,423 training samples
* Columns: <code>anchor</code> and <code>positive</code>
* Approximate statistics based on the first 1000 samples:
  |         | anchor                                                                             | positive                                                                          |
  |:--------|:-----------------------------------------------------------------------------------|:----------------------------------------------------------------------------------|
  | type    | string                                                                             | string                                                                            |
  | details | <ul><li>min: 5 tokens</li><li>mean: 17.43 tokens</li><li>max: 109 tokens</li></ul> | <ul><li>min: 6 tokens</li><li>mean: 16.34 tokens</li><li>max: 59 tokens</li></ul> |
* Samples:
  | anchor                                                                                                                                                                         | positive                                                                                 |
  |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------|
  | <code>خانواده در حال تماشای یک پسر کوچک است که به توپ بیسبال ضربه می‌زند</code>                                                                                                | <code>خانواده در حال تماشای پسری است که به توپ بیسبال ضربه می‌زند</code>                 |
  | <code>چرا هند باید محصولات چین را خریداری کند اگر آنها محصولات ما را خریداری نکنند؟ و بیشتر از آن در برابر هند است از هر جنبه ای. آیا ما محصولات چینی را تحریم می کنیم؟</code> | <code>اگر چین خیلی مخالف هند است ، چرا هندی ها از خرید محصولات چینی دست نمی کشند؟</code> |
  | <code>چه تفاوتی بین همه جانبه و قادر مطلق وجود دارد؟</code>                                                                                                                    | <code>تفاوت های بین همه چیز و قادر مطلق چیست؟</code>                                     |
* Loss: [<code>MultipleNegativesRankingLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#multiplenegativesrankingloss) with these parameters:
  ```json
  {
      "scale": 20.0,
      "similarity_fct": "cos_sim"
  }
  ```

### Training Hyperparameters
#### Non-Default Hyperparameters

- `per_device_train_batch_size`: 32
- `learning_rate`: 2e-05
- `weight_decay`: 0.01
- `num_train_epochs`: 1
- `batch_sampler`: no_duplicates

#### All Hyperparameters
<details><summary>Click to expand</summary>

- `overwrite_output_dir`: False
- `do_predict`: False
- `eval_strategy`: no
- `prediction_loss_only`: True
- `per_device_train_batch_size`: 32
- `per_device_eval_batch_size`: 8
- `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`: 2e-05
- `weight_decay`: 0.01
- `adam_beta1`: 0.9
- `adam_beta2`: 0.999
- `adam_epsilon`: 1e-08
- `max_grad_norm`: 1.0
- `num_train_epochs`: 1
- `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`: False
- `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`: None
- `hub_always_push`: False
- `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
- `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
- `use_liger_kernel`: False
- `eval_use_gather_object`: False
- `average_tokens_across_devices`: False
- `prompts`: None
- `batch_sampler`: no_duplicates
- `multi_dataset_batch_sampler`: proportional

</details>

### Training Logs
| Epoch  | Step | Training Loss |
|:------:|:----:|:-------------:|
| 0.0253 | 100  | 0.1051        |
| 0.0506 | 200  | 0.0588        |
| 0.0759 | 300  | 0.0628        |
| 0.1012 | 400  | 0.0388        |
| 0.1266 | 500  | 0.0464        |
| 0.1519 | 600  | 0.0437        |
| 0.1772 | 700  | 0.0456        |
| 0.2025 | 800  | 0.0411        |
| 0.2278 | 900  | 0.0425        |
| 0.2531 | 1000 | 0.0472        |
| 0.2784 | 1100 | 0.05          |
| 0.3037 | 1200 | 0.0381        |
| 0.3290 | 1300 | 0.0458        |
| 0.3543 | 1400 | 0.0387        |
| 0.3797 | 1500 | 0.0472        |
| 0.4050 | 1600 | 0.052         |
| 0.4303 | 1700 | 0.0432        |
| 0.4556 | 1800 | 0.0415        |
| 0.4809 | 1900 | 0.0311        |
| 0.5062 | 2000 | 0.0375        |
| 0.5315 | 2100 | 0.0436        |
| 0.5568 | 2200 | 0.0392        |
| 0.5821 | 2300 | 0.0338        |
| 0.6074 | 2400 | 0.033         |
| 0.6328 | 2500 | 0.0389        |
| 0.6581 | 2600 | 0.032         |
| 0.6834 | 2700 | 0.0355        |
| 0.7087 | 2800 | 0.0378        |
| 0.7340 | 2900 | 0.0372        |
| 0.7593 | 3000 | 0.0426        |
| 0.7846 | 3100 | 0.0396        |
| 0.8099 | 3200 | 0.0382        |
| 0.8352 | 3300 | 0.0368        |
| 0.8605 | 3400 | 0.0446        |
| 0.8859 | 3500 | 0.0342        |
| 0.9112 | 3600 | 0.0367        |
| 0.9365 | 3700 | 0.0343        |
| 0.9618 | 3800 | 0.0408        |
| 0.9871 | 3900 | 0.0315        |


### Framework Versions
- Python: 3.10.12
- Sentence Transformers: 3.3.1
- Transformers: 4.47.0
- PyTorch: 2.5.1+cu121
- Accelerate: 1.2.1
- Datasets: 4.0.0
- Tokenizers: 0.21.0

## 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",
}
```

#### MultipleNegativesRankingLoss
```bibtex
@misc{henderson2017efficient,
    title={Efficient Natural Language Response Suggestion for Smart Reply},
    author={Matthew Henderson and Rami Al-Rfou and Brian Strope and Yun-hsuan Sung and Laszlo Lukacs and Ruiqi Guo and Sanjiv Kumar and Balint Miklos and Ray Kurzweil},
    year={2017},
    eprint={1705.00652},
    archivePrefix={arXiv},
    primaryClass={cs.CL}
}
```

<!--
## 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.*
-->