README.md

---
tags:
- sentence-transformers
- sentence-similarity
- feature-extraction
- generated_from_trainer
- dataset_size:10000
- loss:CosineSimilarityLoss
base_model: Alibaba-NLP/gte-multilingual-base
widget:
- source_sentence: چگونه ساختار خانواده بر توسعه اجتماعی تأثیر می‌گذارد؟
  sentences:
  - انتخاب‌های سبک زندگی مانند سیگار کشیدن، رژیم غذایی نامناسب و عدم فعالیت بدنی می‌توانند
    به شرایط مختلف قلبی منجر شوند.
  - ساختار خانواده می‌تواند به طور قابل توجهی بر توسعه اجتماعی کودک تأثیر بگذارد با
    ارائه سطوح مختلف حمایت عاطفی، فرصت‌های اجتماعی و الگوهای رفتاری.
  - صنعت فیلم به خاطر کمبود تنوع و نمایندگی مورد انتقاد قرار گرفته است.
- source_sentence: عوامل اصلی که بر تورم تأثیر می‌گذارند چیستند؟
  sentences:
  - تورم می‌تواند موضوع چالش‌برانگیزی برای سیاستگذاران باشد.
  - اکوسیستم‌های بیابانی با بارش کم و دماهای بالا مشخص می‌شوند، که شرایط زندگی چالش‌برانگیزی
    برای گیاهان و جانوران ایجاد می‌کند.
  - امتیازهای Z در توزیع‌های نرمال استاندارد استفاده می‌شوند، در حالی که امتیازهای
    t زمانی استفاده می‌شوند که اندازه نمونه کوچک باشد و انحراف معیار جمعیت نامشخص
    باشد.
- source_sentence: آنتی‌بیوتیک‌ها چگونه در سطح سلولی کار می‌کنند؟
  sentences:
  - برخی از گیاهان گوشت‌خوار، مانند تله ونیس، دارای حرکات سریع برای به‌دام‌اندازی
    طعمه‌های خود هستند.
  - آنتی‌بیوتیک‌ها نوعی دارو هستند که می‌توانند توسط پزشکان برای درمان عفونت‌ها تجویز
    شوند.
  - نرخ تورم می‌تواند با استفاده از شاخص‌های مختلفی اندازه‌گیری شود، مانند شاخص قیمت
    مصرف‌کننده (CPI) و شاخص قیمت تولیدکننده (PPI).
- source_sentence: چگونه سری کتاب‌های «هری پاتر» ج.ک. رولینگ بر ادبیات مدرن تأثیر
    گذاشته است؟
  sentences:
  - جی.کی. رولینگ کتاب‌های دیگری تحت نام مستعار رابرت گالبریت نوشته است که رمان‌های
    جنایی هستند.
  - رنگ آکریلیک به طور معمول در هنر مدرن استفاده می‌شود، در حالی که رنگ روغن قرن‌هاست
    که در هنر کلاسیک به کار می‌رود.
  - ماهی‌های اعماق دریا دارای سازگاری‌هایی مانند بیولومینسانس، بدن‌های مقاوم به فشار
    و مکانیزم‌های تغذیه خاص هستند تا در شرایط شدید sobrevivir کنند.
- source_sentence: تفاوت بین کشاورزی ارگانیک و کشاورزی سنتی چیست؟
  sentences:
  - در حالی که بازه‌های اطمینان مفید هستند، در صورت عدم رعایت فرضیات زیرین، ممکن است
    به اشتباه تفسیر شوند.
  - تاریخ حفظ آب به تمدن‌های باستانی برمی‌گردد که سیستم‌های آبیاری را توسعه دادند.
  - بازارهای کشاورزان مکان‌های محبوبی برای خرید محصولات ارگانیک به طور مستقیم از کشاورزان
    محلی هستند.
datasets:
- xmanii/maux-gte-10k-public
pipeline_tag: sentence-similarity
library_name: sentence-transformers
metrics:
- pearson_cosine
- spearman_cosine
model-index:
- name: SentenceTransformer based on Alibaba-NLP/gte-multilingual-base
  results:
  - task:
      type: semantic-similarity
      name: Semantic Similarity
    dataset:
      name: Unknown
      type: unknown
    metrics:
    - type: pearson_cosine
      value: 0.9487949766869277
      name: Pearson Cosine
    - type: spearman_cosine
      value: 0.947885967258665
      name: Spearman Cosine
---

# SentenceTransformer based on Alibaba-NLP/gte-multilingual-base

This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [Alibaba-NLP/gte-multilingual-base](https://huggingface.co./Alibaba-NLP/gte-multilingual-base) on the [maux-gte-10k-public](https://huggingface.co./datasets/xmanii/maux-gte-10k-public) dataset. 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:** [Alibaba-NLP/gte-multilingual-base](https://huggingface.co./Alibaba-NLP/gte-multilingual-base) <!-- at revision ade1467d6266ae07e6f74aae34d56bf3b8acf3f7 -->
- **Maximum Sequence Length:** 8192 tokens
- **Output Dimensionality:** 768 dimensions
- **Similarity Function:** Cosine Similarity
- **Training Dataset:**
    - [maux-gte-10k-public](https://huggingface.co./datasets/xmanii/maux-gte-10k-public)
<!-- - **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': 8192, 'do_lower_case': False}) with Transformer model: NewModel 
  (1): Pooling({'word_embedding_dimension': 768, 'pooling_mode_cls_token': True, 'pooling_mode_mean_tokens': False, '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("xmanii/maux-gte-persian-v2")
# Run inference
sentences = [
    'تفاوت بین کشاورزی ارگانیک و کشاورزی سنتی چیست؟',
    'بازارهای کشاورزان مکان\u200cهای محبوبی برای خرید محصولات ارگانیک به طور مستقیم از کشاورزان محلی هستند.',
    'تاریخ حفظ آب به تمدن\u200cهای باستانی برمی\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.*
-->

## Evaluation

### Metrics

#### Semantic Similarity

* Evaluated with [<code>EmbeddingSimilarityEvaluator</code>](https://sbert.net/docs/package_reference/sentence_transformer/evaluation.html#sentence_transformers.evaluation.EmbeddingSimilarityEvaluator)

| Metric              | Value      |
|:--------------------|:-----------|
| pearson_cosine      | 0.9488     |
| **spearman_cosine** | **0.9479** |

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

#### maux-gte-10k-public

* Dataset: [maux-gte-10k-public](https://huggingface.co./datasets/xmanii/maux-gte-10k-public) at [e20c689](https://huggingface.co./datasets/xmanii/maux-gte-10k-public/tree/e20c689e4915c4689dd54dd621ff57d5704cfaa5)
* Size: 10,000 training samples
* Columns: <code>persian_question</code>, <code>persian_answer</code>, and <code>score</code>
* Approximate statistics based on the first 1000 samples:
  |         | persian_question                                                                 | persian_answer                                                                     | score                                                           |
  |:--------|:---------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------|:----------------------------------------------------------------|
  | type    | string                                                                           | string                                                                             | float                                                           |
  | details | <ul><li>min: 6 tokens</li><li>mean: 14.7 tokens</li><li>max: 32 tokens</li></ul> | <ul><li>min: 13 tokens</li><li>mean: 29.01 tokens</li><li>max: 78 tokens</li></ul> | <ul><li>min: 0.02</li><li>mean: 0.52</li><li>max: 1.0</li></ul> |
* Samples:
  | persian_question                                                       | persian_answer                                                                                                                                 | score                            |
  |:-----------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------|
  | <code>آیا می‌توانید فرآیند برنامه‌ریزی مسیر ربات را توضیح دهید؟</code> | <code>ربات‌ها می‌توانند برنامه‌نویسی شوند تا مجموعه‌ای از وظایف را انجام دهند، از اقدام‌های تکراری ساده تا فرآیندهای پیچیده تصمیم‌گیری.</code> | <code>0.27999999999999997</code> |
  | <code>آیا انسان‌ها می‌توانند در مریخ زندگی کنند؟</code>                | <code>مریخ چهارمین سیاره از خورشید است و به دلیل ظاهر سرخش اغلب به سیاره سرخ معروف است.</code>                                                 | <code>0.16</code>                |
  | <code>عناصر کلیدی ترکیب در هنر انتزاعی چیست؟</code>                    | <code>تاریخ هنر انتزاعی به اوایل قرن بیستم برمی‌گردد، با پیشگامانی مانند واسیلی کاندینسکی و پیت موندریان.</code>                               | <code>0.36</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"
  }
  ```

### Evaluation Dataset

#### maux-gte-10k-public

* Dataset: [maux-gte-10k-public](https://huggingface.co./datasets/xmanii/maux-gte-10k-public) at [e20c689](https://huggingface.co./datasets/xmanii/maux-gte-10k-public/tree/e20c689e4915c4689dd54dd621ff57d5704cfaa5)
* Size: 10,000 evaluation samples
* Columns: <code>persian_question</code>, <code>persian_answer</code>, and <code>score</code>
* Approximate statistics based on the first 1000 samples:
  |         | persian_question                                                                 | persian_answer                                                                     | score                                                           |
  |:--------|:---------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------|:----------------------------------------------------------------|
  | type    | string                                                                           | string                                                                             | float                                                           |
  | details | <ul><li>min: 6 tokens</li><li>mean: 14.7 tokens</li><li>max: 32 tokens</li></ul> | <ul><li>min: 13 tokens</li><li>mean: 29.01 tokens</li><li>max: 78 tokens</li></ul> | <ul><li>min: 0.02</li><li>mean: 0.52</li><li>max: 1.0</li></ul> |
* Samples:
  | persian_question                                                       | persian_answer                                                                                                                                 | score                            |
  |:-----------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------|
  | <code>آیا می‌توانید فرآیند برنامه‌ریزی مسیر ربات را توضیح دهید؟</code> | <code>ربات‌ها می‌توانند برنامه‌نویسی شوند تا مجموعه‌ای از وظایف را انجام دهند، از اقدام‌های تکراری ساده تا فرآیندهای پیچیده تصمیم‌گیری.</code> | <code>0.27999999999999997</code> |
  | <code>آیا انسان‌ها می‌توانند در مریخ زندگی کنند؟</code>                | <code>مریخ چهارمین سیاره از خورشید است و به دلیل ظاهر سرخش اغلب به سیاره سرخ معروف است.</code>                                                 | <code>0.16</code>                |
  | <code>عناصر کلیدی ترکیب در هنر انتزاعی چیست؟</code>                    | <code>تاریخ هنر انتزاعی به اوایل قرن بیستم برمی‌گردد، با پیشگامانی مانند واسیلی کاندینسکی و پیت موندریان.</code>                               | <code>0.36</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
- `learning_rate`: 2e-05
- `num_train_epochs`: 5
- `warmup_ratio`: 0.1
- `fp16`: True
- `load_best_model_at_end`: True

#### 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`: 2e-05
- `weight_decay`: 0.0
- `adam_beta1`: 0.9
- `adam_beta2`: 0.999
- `adam_epsilon`: 1e-08
- `max_grad_norm`: 1.0
- `num_train_epochs`: 5
- `max_steps`: -1
- `lr_scheduler_type`: linear
- `lr_scheduler_kwargs`: {}
- `warmup_ratio`: 0.1
- `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`: True
- `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`: batch_sampler
- `multi_dataset_batch_sampler`: proportional

</details>

### Training Logs
| Epoch      | Step     | Training Loss | Validation Loss | spearman_cosine |
|:----------:|:--------:|:-------------:|:---------------:|:---------------:|
| 0.1597     | 50       | 0.0663        | -               | -               |
| 0.3195     | 100      | 0.0409        | 0.0298          | 0.7983          |
| 0.4792     | 150      | 0.0342        | -               | -               |
| 0.6390     | 200      | 0.0294        | 0.0230          | 0.8464          |
| 0.7987     | 250      | 0.0296        | -               | -               |
| 0.9585     | 300      | 0.0298        | 0.0220          | 0.8610          |
| 1.1182     | 350      | 0.0249        | -               | -               |
| 1.2780     | 400      | 0.0237        | 0.0230          | 0.8745          |
| 1.4377     | 450      | 0.0241        | -               | -               |
| 1.5974     | 500      | 0.0218        | 0.0166          | 0.8900          |
| 1.7572     | 550      | 0.0227        | -               | -               |
| 1.9169     | 600      | 0.0231        | 0.0148          | 0.9045          |
| 2.0767     | 650      | 0.0196        | -               | -               |
| 2.2364     | 700      | 0.0173        | 0.0131          | 0.9179          |
| 2.3962     | 750      | 0.0172        | -               | -               |
| 2.5559     | 800      | 0.0172        | 0.0119          | 0.9231          |
| 2.7157     | 850      | 0.0167        | -               | -               |
| 2.8754     | 900      | 0.0172        | 0.0120          | 0.9291          |
| 3.0351     | 950      | 0.0175        | -               | -               |
| 3.1949     | 1000     | 0.013         | 0.0100          | 0.9362          |
| 3.3546     | 1050     | 0.0128        | -               | -               |
| 3.5144     | 1100     | 0.0129        | 0.0101          | 0.9390          |
| 3.6741     | 1150     | 0.0134        | -               | -               |
| 3.8339     | 1200     | 0.0137        | 0.0095          | 0.9430          |
| 3.9936     | 1250     | 0.0133        | -               | -               |
| 4.1534     | 1300     | 0.0109        | 0.0096          | 0.9449          |
| 4.3131     | 1350     | 0.0114        | -               | -               |
| **4.4728** | **1400** | **0.0111**    | **0.0083**      | **0.9479**      |
| 4.6326     | 1450     | 0.0107        | -               | -               |
| 4.7923     | 1500     | 0.0122        | 0.0085          | 0.9479          |
| 4.9521     | 1550     | 0.0112        | -               | -               |

* The bold row denotes the saved checkpoint.

### Framework Versions
- Python: 3.10.8
- Sentence Transformers: 3.3.1
- Transformers: 4.47.1
- PyTorch: 2.5.1+cu124
- Accelerate: 1.2.1
- Datasets: 3.2.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",
}
```

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