Update README.md

README.md

@@ -9,27 +9,25 @@ tags:
 - generated_from_trainer
 - dataset_size:2000
 - loss:CosineSimilarityLoss
+- persian
+- farsi
+- gpt4-translated
+
 widget:
 - source_sentence: انقلاب صنعتی چگونه جامعه را تغییر داد؟
   sentences:
-  - انقلاب صنعتی منجر به شهرنشینی شد زیرا مردم به شهرها نقل مکان کردند تا در کارخانه‌ها
-    کار کنند.
-  - انقلاب صنعتی منجر به شهرنشینی شد زیرا مردم به شهرها نقل مکان کردند تا در کارخانه‌ها
-    کار کنند.
+  - انقلاب صنعتی منجر به شهرنشینی شد زیرا مردم به شهرها نقل مکان کردند تا در کارخانه‌ها کار کنند.
+  - انقلاب صنعتی منجر به شهرنشینی شد زیرا مردم به شهرها نقل مکان کردند تا در کارخانه‌ها کار کنند.
   - انقلاب صنعتی چگونه جامعه را تغییر داد؟
 - source_sentence: الکترون‌ها چه نقشی در پیوندهای شیمیایی ایفا می‌کنند؟
   sentences:
   - الکترون‌ها چه نقشی در پیوندهای شیمیایی ایفا می‌کنند؟
-  - پروتون‌ها در هسته بر هویت و ویژگی‌های اتم تأثیر می‌گذارند که به طور غیرمستقیم
-    بر نحوه‌ی تشکیل پیوندهای شیمیایی تأثیر دارد.
-  - پروتون‌ها در هسته بر هویت و ویژگی‌های اتم تأثیر می‌گذارند که به طور غیرمستقیم
-    بر نحوه‌ی تشکیل پیوندهای شیمیایی تأثیر دارد.
+  - پروتون‌ها در هسته بر هویت و ویژگی‌های اتم تأثیر می‌گذارند که به طور غیرمستقیم بر نحوه‌ی تشکیل پیوندهای شیمیایی تأثیر دارد.
+  - پروتون‌ها در هسته بر هویت و ویژگی‌های اتم تأثیر می‌گذارند که به طور غیرمستقیم بر نحوه‌ی تشکیل پیوندهای شیمیایی تأثیر دارد.
 - source_sentence: عملکردهای اصلی سیستم ایمنی انسان چیست؟
   sentences:
-  - آنتی بادی‌ها توسط سیستم ایمنی برای کمک به خنثی کردن پاتوژن‌های ایجادکننده عفونت
-    تولید می‌شوند.
-  - آنتی بادی‌ها توسط سیستم ایمنی برای کمک به خنثی کردن پاتوژن‌های ایجادکننده عفونت
-    تولید می‌شوند.
+  - آنتی بادی‌ها توسط سیستم ایمنی برای کمک به خنثی کردن پاتوژن‌های ایجادکننده عفونت تولید می‌شوند.
+  - آنتی بادی‌ها توسط سیستم ایمنی برای کمک به خنثی کردن پاتوژن‌های ایجادکننده عفونت تولید می‌شوند.
   - عملکردهای اصلی سیستم ایمنی انسان چیست؟
 - source_sentence: ماهیت بنیادی واقعیت چیست؟
   sentences:
@@ -43,21 +41,20 @@ widget:
   - شخصیت‌های اصلی در جنبش کوبیسم چه کسانی بودند؟
 ---
 
-# SentenceTransformer based on Alibaba-NLP/gte-multilingual-base
+# SentenceTransformer based on Alibaba-NLP/gte-multilingual-base for Persian (Farsi)
 
-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). 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.
+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). It maps Persian (Farsi) 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 in the Persian language.
 
 ## 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 7fc06782350c1a83f88b15dd4b38ef853d3b8503 -->
+- **Base model:** [Alibaba-NLP/gte-multilingual-base](https://huggingface.co/Alibaba-NLP/gte-multilingual-base)
 - **Maximum Sequence Length:** 8192 tokens
 - **Output Dimensionality:** 768 tokens
 - **Similarity Function:** Cosine Similarity
-<!-- - **Training Dataset:** Unknown -->
-<!-- - **Language:** Unknown -->
-<!-- - **License:** Unknown -->
+- **Training Dataset:** 2000 high-quality Persian sentence pairs translated from English using GPT-4
+- **Language:** Persian (Farsi)
 
 ### Model Sources
 
@@ -107,41 +104,7 @@ 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
 
@@ -155,140 +118,6 @@ You can finetune this model on your own dataset.
 - `warmup_ratio`: 0.1
 - `fp16`: 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`: 3
-- `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`: 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
-- `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
-- `batch_sampler`: batch_sampler
-- `multi_dataset_batch_sampler`: proportional
-
-</details>
-
-### Training Logs
-| Epoch  | Step | Training Loss | Validation Loss |
-|:------:|:----:|:-------------:|:---------------:|
-| 0.8772 | 50   | 0.0584        | -               |
-| 1.7544 | 100  | 0.0342        | 0.0379          |
-| 2.6316 | 150  | 0.0277        | -               |
-
-
-### Framework Versions
-- Python: 3.10.8
-- Sentence Transformers: 3.2.0
-- Transformers: 4.45.2
-- PyTorch: 2.4.1+cu121
-- Accelerate: 1.0.1
-- Datasets: 3.0.1
-- Tokenizers: 0.20.1
 
 ## Citation
 
@@ -306,21 +135,3 @@ You can finetune this model on your own dataset.
     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.*
--->