Update README.md

README.md

@@ -1,5 +1,6 @@
 ---
-language: []
+language:
+- fa
 library_name: sentence-transformers
 tags:
 - sentence-transformers
@@ -9,14 +10,40 @@ tags:
 - dataset_size:96546
 - loss:SoftmaxLoss
 base_model: HooshvareLab/bert-base-parsbert-uncased
-datasets: []
+datasets:
+- Gholamreza/pquad
 widget:
-- source_sentence: 'اسب‌های سنگین با اندامی عضلانی را چه می‌نامند؟'
+- source_sentence: اسب‌های سنگین با اندامی عضلانی را چه می‌نامند؟
   sentences:
-  - خرطوم فیل‌ها حاصل اتصال بینی و لب بالایی است. این عضو، استخوان ندارد و دارای مقدار کمی چربی و حدود ۱۵۰۰۰۰ دسته ماهیچه‌ای است. یک یا دو لب انگشت در نوک آن وجود دارد. خرطوم این پستاندار تقریباً ۱٫۸ متر رشد می‌کند و وزنی حدود ۱۴۰ کیلوگرم دارد. این جانوران از خرطوم دراز خود به عنوان دست استفاده می‌کنند و با آن غذا و آب را در دهان خود می‌گذارند. فیل‌ها با استفاده از خرطوم خود می‌توانند حداکثر تا ۳۵۰کیلوگرم بار را برداشته و جابجا کنند. از دیگر کاربردهای خرطوم فیل‌ها احساس بویایی و همچنین تولید صدا است.	
-  - اسب‌های سنگین با اندامی عضلانی را به عنوان «اسب‌های خونسرد» می‌شناسند. آن‌ها را به دلیل توان ماهیچه‌ای و خوی آرام و صبورشان پرورش می‌دهند. مردم با کمک آن‌ها بارهای سنگین را جابجا می‌کردند. گاهی به این اسب‌های «غول‌های نجیب» هم گفته می‌شود. از جمله اسب‌های باری می‌توان به نژاد بلژیکی و کلایدزدیل اشاره کرد. برخی از این اسب‌ها مانند پرچرون سبک‌تر و چابک ترند و درکشیدن بار یا شخم زدن زمین در اقلیم خشک به کار می‌آیند. دیگران مانند شایر آرام‌تر و نیرومندترند و برای شخم زدن خاک‌های رسی کاربرد دارند. برخی اسبچهها هم در دستهٔ خونسردها جای می‌گیرند.	
-  - بدنهٔ اسکلتی یا خرپا (Truss) در هواپیماهای اولیه تا جنگ جهانی اول بسیار استفاده می‌شد. هم‌اکنون در هواپیماهای دست‌ساز و نیز هواپیماهای مدل از این نوع بدنه استفاده زیادی می‌شود چرا که ساده، سبک و مقاوم بوده و با تیرک‌های چوبی قابل ساخت هستند. در این نوع بدنه اغلب نیروها و تنش‌های وارده توسط سازه اصلی تحمل شده و از پوسته برای ایجاد شکل آیرودینامیکی به سازه استفاده می‌شود. سازهٔ اصلی از تیرک‌های طولی، تیرک‌های مورب، قاب‌های عرضی و کابل‌های نگهدارنده تشکیل شده‌است. برادران رایت که اولین هواپیماهای قابل کنترل را ساختند از این حالت در ساختار بدنهٔ هواپیماهایشان استفاده می‌کردند.	
+  - >-
+    بیتلز با فروش تخمینی ۶۰۰ میلیون نسخه از کارهایشان در سراسر جهان پرفروش ترین
+    هنرمند موسیقی در تمام دوران‌هاست. این گروه در سال ۱۹۸۸ به تالار مشاهیر راک
+    اند رول وارد شد و هر چهار عضو اصلی نیز بین سالهای ۱۹۹۴ تا ۲۰۱۵ به صورت
+    جداگانه به تالار وارد شدند. این گروه هفت جایزه گرمی، چهار جایزه بریت، یک
+    جایزه اسکار (جایزه اسکار بهترین موسیقی فیلم برای فیلم بگذار باشد (۱۹۷۰)) و
+    پانزده جایزه آیور نوولو دریافت کرد. مجله تایم آنها را در میان ۱۰۰ شخصیت
+    برجسته قرن بیستم و رولینگ استون آنها را در لیست ۱۰۰ هنرمند برتر خود در رتبه
+    اول قرار داد.
+  - >-
+    اسب‌های سنگین با اندامی عضلانی را به عنوان «اسب‌های خونسرد» می‌شناسند.
+    آن‌ها را به دلیل توان ماهیچه‌ای و خوی آرام و صبورشان پرورش می‌دهند. مردم
+    با کمک آن‌ها بارهای سنگین را جابجا می‌کردند. گاهی به این اسب‌های «غول‌های
+    نجیب» هم گفته می‌شود. از جمله اسب‌های باری می‌توان به نژاد بلژیکی و
+    کلاید��دیل اشاره کرد. برخی از این اسب‌ها مانند پرچرون سبک‌تر و چابک ترند و
+    درکشیدن بار یا شخم زدن زمین در اقلیم خشک به کار می‌آیند. دیگران مانند شایر
+    آرام‌تر و نیرومندترند و برای شخم زدن خاک‌های رسی کاربرد دارند. برخی اسبچهها
+    هم در دستهٔ خونسردها جای می‌گیرند.
+  - >-
+    بدنهٔ اسکلتی یا خرپا (Truss) در هواپیماهای اولیه تا جنگ جهانی اول بسیار
+    استفاده می‌شد. هم‌اکنون در هواپیماهای دست‌ساز و نیز هواپیماهای مدل از این
+    نوع بدنه استفاده زیادی می‌شود چرا که ساده، سبک و مقاوم بوده و با تیرک‌های
+    چوبی قابل ساخت هستند. در این نوع بدنه اغلب نیروها و تنش‌های وارده توسط سازه
+    اصلی تحمل شده و از پوسته برای ایجاد شکل آیرودینامیکی به سازه استفاده
+    می‌شود. سازهٔ اصلی از تیرک‌های طولی، تیرک‌های مورب، قاب‌های عرضی و کابل‌های
+    نگهدارنده تشکیل شده‌است. برادران رایت که اولین هواپیماهای قابل کنترل را
+    ساختند از این حالت در ساختار بدنهٔ هواپیماهایشان استفاده می‌کردند.
 pipeline_tag: sentence-similarity
+license: apache-2.0
 ---
 
 # SentenceTransformer based on HooshvareLab/bert-base-parsbert-uncased
@@ -31,15 +58,6 @@ This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [H
 - **Maximum Sequence Length:** 512 tokens
 - **Output Dimensionality:** 768 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
 
@@ -82,207 +100,6 @@ 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: 96,546 training samples
-* Columns: <code>anchor</code>, <code>positive</code>, and <code>label</code>
-* Approximate statistics based on the first 1000 samples:
-  |         | anchor                                                                               | positive                                                                          | label                                           |
-  |:--------|:-------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------|:------------------------------------------------|
-  | type    | string                                                                               | string                                                                            | int                                             |
-  | details | <ul><li>min: 14 tokens</li><li>mean: 151.98 tokens</li><li>max: 283 tokens</li></ul> | <ul><li>min: 5 tokens</li><li>mean: 15.24 tokens</li><li>max: 90 tokens</li></ul> | <ul><li>0: ~50.50%</li><li>1: ~49.50%</li></ul> |
-* Samples:
-  | anchor                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | positive                                                    | label          |
-  |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------|:---------------|
-  | <code>پاستل یک محیط نقاشی به شکل چوب است که از رنگدانه‌های پودری خالص و چسب تشکیل شده‌است. رنگدانه‌های مورد استفاده در پاستل همانهایی هستند که برای تولید همه محیط‌های هنری رنگی از جمله رنگ روغن استفاده می‌شود. چسب دارای رنگ خنثی و اشباع کم است. اثر رنگی پاستیل بیش از هر فرایند به رنگدانه‌های خشک طبیعی نزدیکتر است. از آنجا که سطح یک نقاشی پاستلی شکننده است و به راحتی لکه دار می‌شود، حفظ آن نیاز به اقدامات محافظتی مانند قاب‌بندی زیر شیشه دارد. همچنین ممکن است با ماده ثابت کننده اسپری شود. با این وجود، وقتی با رنگدانه‌های دائمی ساخته می‌شود و از آنها به درستی مراقبت می‌شود، ممکن است نقاشی پاستلی قرن‌ها بدون تغییر باقی بماند. پاستل‌ها، همان‌طور که نقاشی‌های ساخته شده با یک محیط مایع، در برابر ترک خوردگی و تغییر رنگ که در اثر تغییر در رنگ، تیرگی یا ابعاد محیط خشک می‌شود، حساس نیستند.</code> | <code>پاستل از چه چیزهایی تشکیل شده است؟</code>             | <code>1</code> |
-  | <code>یک روش تغذیه و زندگی است که هدف آن حذف هر نوع محصول حیوانی چه در غذا و چه در مواد مصرفی است. مهم‌ترین دلایل گرایش به وگانیسم افراد، مسائل اخلاقی یا رعایت حقوق حیوانات، حفاظت محیط زیست، حفظ سلامتی، مسائل معنوی یا مذهبی است. بسیاری از افراد وگان با پرورش صنعتی حیوانات و آزمایش روی حیوانات مخالف هستند. از مهم‌ترین محصولات حیوانی که پاک گیاه‌خواران یا وگان‌ها از مصرف آن‌ها خودداری می‌کنند می‌توان به انواع گوشت (گوشت قرمز، مرغ، آبزیان، ماکیان و...)، لبنیات، تخم‌مرغ، عسل، ابریشم، چرم، خز، و... و نیز محصولاتی که در آن‌ها از فراورده‌های حیوانی (مانند ژله که از ژلاتین به‌دست می‌آید) استفاده شده‌است اشاره کرد.</code>                                                                                                                                                                             | <code>گیاه‌خواری چه روشی است؟</code>                        | <code>1</code> |
-  | <code>اسب‌های سنگین با اندامی عضلانی را به عنوان «اسب‌های خونسرد» می‌شناسند. آن‌ها را به دلیل توان ماهیچه‌ای و خوی آرام و صبورشان پرورش می‌دهند. مردم با کمک آن‌ها بارهای سنگین را جابجا می‌کردند. گاهی به این اسب‌های «غول‌های نجیب» هم گفته می‌شود. از جمله اسب‌های باری می‌توان به نژاد بلژیکی و کلایدزدیل اشاره کرد. برخی از این اسب‌ها مانند پرچرون سبک‌تر و چابک ترند و درکشیدن بار یا شخم زدن زمین در اقلیم خشک به کار می‌آیند. دیگران مانند شایر آرام‌تر و نیرومندترند و برای شخم زدن خاک‌های رسی کاربرد دارند. برخی اسبچهها هم در دستهٔ خونسردها جای می‌گیرند.</code>                                                                                                                                                                                                                                              | <code>اسب‌های سنگین با اندامی عضلانی را چه می‌نامند؟</code> | <code>1</code> |
-* Loss: [<code>SoftmaxLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#softmaxloss)
-
-### Evaluation Dataset
-
-#### Unnamed Dataset
-
-
-* Size: 11,990 evaluation samples
-* Columns: <code>anchor</code>, <code>positive</code>, and <code>label</code>
-* Approximate statistics based on the first 1000 samples:
-  |         | anchor                                                                               | positive                                                                          | label                                           |
-  |:--------|:-------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------|:------------------------------------------------|
-  | type    | string                                                                               | string                                                                            | int                                             |
-  | details | <ul><li>min: 41 tokens</li><li>mean: 146.59 tokens</li><li>max: 297 tokens</li></ul> | <ul><li>min: 5 tokens</li><li>mean: 15.28 tokens</li><li>max: 48 tokens</li></ul> | <ul><li>0: ~47.90%</li><li>1: ~52.10%</li></ul> |
-* Samples:
-  | anchor                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | positive                                                                                      | label          |
-  |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------|:---------------|
-  | <code>بدنهٔ اسکلتی یا خرپا (Truss) در هواپیماهای اولیه تا جنگ جهانی اول بسیار استفاده می‌شد. هم‌اکنون در هواپیماهای دست‌ساز و نیز هواپیماهای مدل از این نوع بدنه استفاده زیادی می‌شود چرا که ساده، سبک و مقاوم بوده و با تیرک‌های چوبی قابل ساخت هستند. در این نوع بدنه اغلب نیروها و تنش‌های وارده توسط سازه اصلی تحمل شده و از پوسته برای ایجاد شکل آیرودینامیکی به سازه استفاده می‌شود. سازهٔ اصلی از تیرک‌های طولی، تیرک‌های مورب، قاب‌های عرضی و کابل‌های نگهدارنده تشکیل شده‌است. برادران رایت که اولین هواپیماهای قابل کنترل را ساختند از این حالت در ساختار بدنهٔ هواپیماهایشان استفاده می‌کردند.</code>                                                             | <code>در چه انتخاباتی یک نامزد نیاز به بیست درصد آرا دارد تا انتخاب‌شدن وی تضمین شود؟</code> | <code>0</code> |
-  | <code>شاید بتوان گفت این موضوع بر می‌گردد به ریشه زبان بلوچی که برگرفته از زبان پهلوی اشکانی و ساسانی می‌باشد. از آنجا که زبان پهلوی با دگرگونی‌هایی به زبان فارسی نو (امروزی) تبدیل شده‌است ویکی از این دگرگونی‌ها حذف (گ) از برخی کلمات می‌باشد می‌توان اینگونه بیان کرد که حرف گ و برخی حروف غیر عربی در زبان بلوچی خا��ص باقی مانده اما در زبان فارسی امروز گ از برخی کلمات حذف شده و دگرگون شده‌است؛ یعنی زبان بلوچی، "گ " اوستا را که در پازند و فارسی به "های " غیر ملفوظ تبدیل شده، مانند زبان پهلوی به صور ت "گ " و گاهی همان "ک " نگهداشته است. مثال‌های دیگر از دگرگونی حروف زبان باستان در فارسی نو اما ثابت ماندن آن‌ها در کلمات بلوچی در زیر آمده‌است:</code> | <code>در چه سالی هگل برای ادامهٔ تحصیل به دبیرستان ایلوستره رفت؟</code>                       | <code>0</code> |
-  | <code>خرطوم فیل‌ها حاصل اتصال بینی و لب بالایی است. این عضو، استخوان ندارد و دارای مقدار کمی چربی و حدود ۱۵۰۰۰۰ دسته ماهیچه‌ای است. یک یا دو لب انگشت در نوک آن وجود دارد. خرطوم این پستاندار تقریباً ۱٫۸ متر رشد می‌کند و وزنی حدود ۱۴۰ کیلوگرم دارد. این جانوران از خرطوم دراز خود به عنوان دست استفاده می‌کنند و با آن غذا و آب را در دهان خود می‌گذارند. فیل‌ها با استفاده از خرطوم خود می‌توانند حداکثر تا ۳۵۰کیلوگرم بار را برداشته و جابجا کنند. از دیگر کاربردهای خرطوم فیل‌ها احساس بویایی و همچنین تولید صدا است.</code>                                                                                                                                         | <code>فیل‌ها از خرطوم دراز خود به عنوان چه چیزی استفاده می‌کنند؟</code>                       | <code>1</code> |
-* Loss: [<code>SoftmaxLoss</code>](https://sbert.net/docs/package_reference/sentence_transformer/losses.html#softmaxloss)
-
-### Training Hyperparameters
-#### Non-Default Hyperparameters
-
-- `per_device_train_batch_size`: 16
-- `per_device_eval_batch_size`: 16
-- `gradient_accumulation_steps`: 16
-- `num_train_epochs`: 2
-- `lr_scheduler_type`: cosine
-- `warmup_ratio`: 0.1
-- `bf16`: True
-- `load_best_model_at_end`: True
-- `deepspeed`: False
-- `batch_sampler`: no_duplicates
-
-#### All Hyperparameters
-<details><summary>Click to expand</summary>
-
-- `overwrite_output_dir`: False
-- `do_predict`: False
-- `prediction_loss_only`: True
-- `per_device_train_batch_size`: 16
-- `per_device_eval_batch_size`: 16
-- `per_gpu_train_batch_size`: None
-- `per_gpu_eval_batch_size`: None
-- `gradient_accumulation_steps`: 16
-- `eval_accumulation_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.0
-- `num_train_epochs`: 2
-- `max_steps`: -1
-- `lr_scheduler_type`: cosine
-- `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
-- `no_cuda`: False
-- `use_cpu`: False
-- `use_mps_device`: False
-- `seed`: 42
-- `data_seed`: None
-- `jit_mode_eval`: False
-- `use_ipex`: False
-- `bf16`: True
-- `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`: 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}
-- `deepspeed`: False
-- `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
-- `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_sampler`: no_duplicates
-- `multi_dataset_batch_sampler`: proportional
-
-</details>
 
 ### Training Logs
 | Epoch      | Step    | Training Loss | loss       |
@@ -329,31 +146,6 @@ You can finetune this model on your own dataset.
 
 * The bold row denotes the saved checkpoint.
 
-### Framework Versions
-- Python: 3.10.13
-- Sentence Transformers: 3.0.1
-- Transformers: 4.39.3
-- PyTorch: 2.1.1+cu121
-- Accelerate: 0.26.1
-- Datasets: 2.19.2
-- Tokenizers: 0.15.2
-
-## Citation
-
-### BibTeX
-
-#### Sentence Transformers and SoftmaxLoss
-```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