File size: 19,534 Bytes
35c4781
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
---
base_model: HooshvareLab/bert-base-parsbert-uncased
library_name: sentence-transformers
pipeline_tag: sentence-similarity
tags:
- sentence-transformers
- sentence-similarity
- feature-extraction
- generated_from_trainer
- dataset_size:941951
- loss:CoSENTLoss
widget:
- source_sentence: تماشاگران سینما نام او و جسارت افسانه ای او را می دانستند.
  sentences:
  - HCFA نظراتی را درخواست و ارزیابی کرد که بسیار بحث برانگیز بود.
  - زنی در اسکله قدم می زند.
  - او خجالتی و ترسو است و دوست ندارد ریسک کند.
- source_sentence: یک ماشین مسابقه آبی در پیست مسابقه با عدد 90 مشخص شده است.
  sentences:
  - من در گذاشتن خیلی خوب هستم.
  - کارشناسان مافیا گیج شده اند.
  - یک ماشین مسابقه دارای شماره 90 است.
- source_sentence: دوازده کودک در یک مکان گرمسیری در فضای باز جمع می شوند.
  sentences:
  - گل زرد در موهای زن است.
  - گروهی از دانش آموزان در جزیره ای در حال تعطیلات هستند.
  - تیم های لیگ کوچک مجبور نیستند بازیکنان خود را به تیم های لیگ برتر واگذار کنند.
- source_sentence: کارگرانی که در امتداد یک راه آهن شن می چینند.
  sentences:
  - آنها روی خط راه آهن کار می کردند.
  - بسیاری از زنان در انبوهی از مالچ کشتی می گیرند.
  - سربازان با لباس های جنگ جهانی دوم در حال رژه هستند و یک گروه موسیقی پشت سر آنها
    رژه می روند.
- source_sentence: یک دختر جوان بلوند با پیراهن صورتی به آخوندکی بزرگ در حال نماز
    روی بازوی خود نگاه می کند.
  sentences:
  - مربیان عالی بودند و حتی یکی دو چیز را به بچه ها یاد دادند.
  - دختر جوانی یک آخوندک نمازگزار روی بازوی خود دارد.
  - کاخ هنرهای زیبا آثار سوررئالیستی زیادی دارد.
---

# SentenceTransformer based on HooshvareLab/bert-base-parsbert-uncased

This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [HooshvareLab/bert-base-parsbert-uncased](https://huggingface.co/HooshvareLab/bert-base-parsbert-uncased) on the csv 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:** [HooshvareLab/bert-base-parsbert-uncased](https://huggingface.co/HooshvareLab/bert-base-parsbert-uncased) <!-- at revision d73a0e2c7492c33bd5819bcdb23eba207404dd19 -->
- **Maximum Sequence Length:** 512 tokens
- **Output Dimensionality:** 768 tokens
- **Similarity Function:** Cosine Similarity
- **Training Dataset:**
    - csv
<!-- - **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: BertModel 
  (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})
)
```

## 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("sentence_transformers_model_id")
# Run inference
sentences = [
    'یک دختر جوان بلوند با پیراهن صورتی به آخوندکی بزرگ در حال نماز روی بازوی خود نگاه می کند.',
    'دختر جوانی یک آخوندک نمازگزار روی بازوی خود دارد.',
    'کاخ هنرهای زیبا آثار سوررئالیستی زیادی دارد.',
]
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

#### csv

* Dataset: csv
* Size: 941,951 training samples
* Columns: <code>premise</code>, <code>hypothesis</code>, and <code>score</code>
* Approximate statistics based on the first 1000 samples:
  |         | premise                                                                           | hypothesis                                                                       | score                                                         |
  |:--------|:----------------------------------------------------------------------------------|:---------------------------------------------------------------------------------|:--------------------------------------------------------------|
  | type    | string                                                                            | string                                                                           | float                                                         |
  | details | <ul><li>min: 4 tokens</li><li>mean: 20.6 tokens</li><li>max: 125 tokens</li></ul> | <ul><li>min: 3 tokens</li><li>mean: 12.1 tokens</li><li>max: 38 tokens</li></ul> | <ul><li>min: 0.0</li><li>mean: 0.5</li><li>max: 1.0</li></ul> |
* Samples:
  | premise                                                                                                                         | hypothesis                                                             | score            |
  |:--------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|:-----------------|
  | <code>موارد پیکربندی پس از استقرار رسمی</code>                                                                                  | <code>آیتم ها پس از ایجاد رسمی پیکربندی می شوند.</code>                | <code>1.0</code> |
  | <code>به همان خوبی که در دنیای من انجام شده است.  سر پرث، موقتاً از خودش راضی بود، رفت و هانسون ایستاد و به مدل خیره شد.</code> | <code>هانسون از خیره شدن به مدل دست کشید و سر پرث را دنبال کرد.</code> | <code>0.0</code> |
  | <code>به نظر می رسد شما قبلاً رفته اید.</code>                                                                                  | <code>انگار رفتی</code>                                                | <code>1.0</code> |
* Loss: [<code>CoSENTLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#cosentloss) with these parameters:
  ```json
  {
      "scale": 20.0,
      "similarity_fct": "pairwise_cos_sim"
  }
  ```

### Evaluation Dataset

#### csv

* Dataset: csv
* Size: 941,951 evaluation samples
* Columns: <code>premise</code>, <code>hypothesis</code>, and <code>score</code>
* Approximate statistics based on the first 1000 samples:
  |         | premise                                                                            | hypothesis                                                                       | score                                                         |
  |:--------|:-----------------------------------------------------------------------------------|:---------------------------------------------------------------------------------|:--------------------------------------------------------------|
  | type    | string                                                                             | string                                                                           | float                                                         |
  | details | <ul><li>min: 4 tokens</li><li>mean: 21.56 tokens</li><li>max: 115 tokens</li></ul> | <ul><li>min: 4 tokens</li><li>mean: 12.3 tokens</li><li>max: 42 tokens</li></ul> | <ul><li>min: 0.0</li><li>mean: 0.5</li><li>max: 1.0</li></ul> |
* Samples:
  | premise                                                                                                                                                                                                                                                                                                                                                               | hypothesis                                                                | score            |
  |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------|:-----------------|
  | <code>آنها سوار بر همدیگر شده بودند و کتک خورده بودند تا اینکه اهمیتی ندادند.</code>                                                                                                                                                                                                                                                                                  | <code>مردم مجروح شده بودند.</code>                                        | <code>1.0</code> |
  | <code>در منطقه چمن نگه داشتن چمن در مناطق خاص به نوعی سخت است و من واقعاً هرگز به آن فکر نکرده بودم، اما ما تقریباً در بالای این تپه کوچک هستیم و تمام رواناب های حاصل از بتن، اوه خرید مرکز نزدیک ما و کوچه همه چیزهایی که به سمت همسایه‌های ما می‌رود، بنابراین این یک چیز کوچکی بود که من واقعاً هرگز به آن فکر نمی‌کردم و خوشبختانه به این ترتیب انجام شد.</code> | <code>ما روی تپه ای هستیم و آب در نزدیکی همسایه هایمان جمع می شود.</code> | <code>1.0</code> |
  | <code>زنی با چتر در ایستگاهی نشسته و آگهی تبلیغاتی Aquos روی دیوار دارد.</code>                                                                                                                                                                                                                                                                                       | <code>زنی روی مبل اتاق نشیمنش نشسته است.</code>                           | <code>0.0</code> |
* Loss: [<code>CoSENTLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#cosentloss) with these parameters:
  ```json
  {
      "scale": 20.0,
      "similarity_fct": "pairwise_cos_sim"
  }
  ```

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

- `eval_strategy`: steps
- `per_device_train_batch_size`: 48
- `per_device_eval_batch_size`: 32
- `learning_rate`: 2e-05
- `num_train_epochs`: 1
- `warmup_ratio`: 0.1
- `fp16`: True
- `push_to_hub`: True
- `hub_private_repo`: True
- `batch_sampler`: no_duplicates

#### 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`: 48
- `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`: 1
- `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`: 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`: True
- `resume_from_checkpoint`: None
- `hub_model_id`: None
- `hub_strategy`: every_save
- `hub_private_repo`: True
- `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`: no_duplicates
- `multi_dataset_batch_sampler`: proportional

</details>

### Training Logs
| Epoch  | Step  | Training Loss | loss   |
|:------:|:-----:|:-------------:|:------:|
| 0.0271 | 500   | 7.0257        | -      |
| 0.0542 | 1000  | 6.3955        | -      |
| 0.0813 | 1500  | 6.3502        | -      |
| 0.1084 | 2000  | 6.3209        | -      |
| 0.1355 | 2500  | 6.292         | -      |
| 0.1626 | 3000  | 6.2518        | 5.3943 |
| 0.1897 | 3500  | 6.2469        | -      |
| 0.2168 | 4000  | 6.2352        | -      |
| 0.2439 | 4500  | 6.2095        | -      |
| 0.2710 | 5000  | 6.2006        | -      |
| 0.2982 | 5500  | 6.1951        | -      |
| 0.3253 | 6000  | 6.1945        | 5.2832 |
| 0.3524 | 6500  | 6.1681        | -      |
| 0.3795 | 7000  | 6.167         | -      |
| 0.4066 | 7500  | 6.1474        | -      |
| 0.4337 | 8000  | 6.1506        | -      |
| 0.4608 | 8500  | 6.1506        | -      |
| 0.4879 | 9000  | 6.15          | 5.2294 |
| 0.5150 | 9500  | 6.1512        | -      |
| 0.5421 | 10000 | 6.149         | -      |
| 0.5692 | 10500 | 6.1218        | -      |
| 0.5963 | 11000 | 6.1312        | -      |
| 0.6234 | 11500 | 6.1233        | -      |
| 0.6505 | 12000 | 6.1053        | 5.1807 |
| 0.6776 | 12500 | 6.1209        | -      |
| 0.7047 | 13000 | 6.1088        | -      |
| 0.7318 | 13500 | 6.0944        | -      |
| 0.7589 | 14000 | 6.1089        | -      |
| 0.7860 | 14500 | 6.1062        | -      |
| 0.8131 | 15000 | 6.0975        | 5.1374 |
| 0.8402 | 15500 | 6.1009        | -      |
| 0.8673 | 16000 | 6.086         | -      |
| 0.8945 | 16500 | 6.0687        | -      |
| 0.9216 | 17000 | 6.0804        | -      |
| 0.9487 | 17500 | 6.0981        | -      |
| 0.9758 | 18000 | 6.0895        | 5.1153 |


### Framework Versions
- Python: 3.10.12
- Sentence Transformers: 3.1.1
- Transformers: 4.44.2
- PyTorch: 2.4.1+cu121
- Accelerate: 0.34.2
- Datasets: 3.0.1
- 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",
}
```

#### CoSENTLoss
```bibtex
@online{kexuefm-8847,
    title={CoSENT: A more efficient sentence vector scheme than Sentence-BERT},
    author={Su Jianlin},
    year={2022},
    month={Jan},
    url={https://kexue.fm/archives/8847},
}
```

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