hindalmayyali/sentence-transform-arabert

AraBERT v2 base trained on Arabic triplets

This is a sentence-transformers model finetuned from aubmindlab/bert-base-arabertv02. 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: aubmindlab/bert-base-arabertv02
• Maximum Sequence Length: 512 tokens
• Output Dimensionality: 768 dimensions
• Similarity Function: Cosine Similarity
• Language: ar
• License: apache-2.0

Model Sources

• Documentation: Sentence Transformers Documentation
• Repository: Sentence Transformers on GitHub
• Hugging Face: Sentence Transformers on Hugging Face

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:

pip install -U sentence-transformers

Then you can load this model and run inference.

from sentence_transformers import SentenceTransformer

# Download from the 🤗 Hub
model = SentenceTransformer("hindalmayyali/sentence-transform-arabert")
# 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]

Evaluation

Metrics

Triplet

• Dataset: arabic-test
• Evaluated with TripletEvaluator

Metric	Value
cosine_accuracy	0.9383

Training Details

Training Dataset

Unnamed Dataset

• Size: 50,000 training samples
• Columns: anchor, positive, and negative
• Approximate statistics based on the first 1000 samples:

  	anchor	positive	negative
  type	string	string	string
  details	min: 4 tokens mean: 12.27 tokens max: 54 tokens	min: 4 tokens mean: 30.82 tokens max: 235 tokens	min: 3 tokens mean: 30.86 tokens max: 221 tokens

• Samples:

  anchor	positive	negative
  امرأة ترتدي قميصاً أحمر.	امرأة ترتدي قميصاً أحمر تجلس مع فتاتين صغيرتين يرتدين فساتين	الرجل الذي يرتدي القميص الأحمر ينظر إلى الممر.
  اثنان من الشيوخ الآسيويين يلعبون الشطرنج الصيني على مقعد.	رجلين يلعبان لعبة في الخارج	اثنان من الرجال الآسيويين يقف لعب الشطرنج.
  "مثل أرخص عاهرة قابلتها على الإطلاق" قال (ديري)	ووصفها (ديري) بأنها أرخص عاهرة قابلها في حياته	في.آر مثل أغلى عاهرة استخدمها في حياته

• Loss: MultipleNegativesRankingLoss with these parameters:

  {
      "scale": 20.0,
      "similarity_fct": "cos_sim"
  }
  

Evaluation Dataset

Unnamed Dataset

• Size: 100,000 evaluation samples
• Columns: anchor, positive, and negative
• Approximate statistics based on the first 1000 samples:

  	anchor	positive	negative
  type	string	string	string
  details	min: 4 tokens mean: 12.56 tokens max: 69 tokens	min: 4 tokens mean: 30.68 tokens max: 160 tokens	min: 4 tokens mean: 30.11 tokens max: 212 tokens

• Samples:

  anchor	positive	negative
  هل يسبب الساركويد فقدان الوزن	يعد ضيق التنفس من الأعراض الشائعة. يعاني بعض المرضى من سعال جاف مزعج وقد يعاني البعض الآخر من ألم في الصدر. التعب والخمول والخمول وآلام المفاصل شائعة. قد يسبب الساركويد الحمى وفقدان الوزن.	يبلغ متوسط ​​فقدان الوزن الزائد في جراحة المجازة المعدية في عام واحد ما يقرب من 75 إلى 85٪. لذلك إذا كان وزنك الزائد 300 رطل ، فمن المحتمل أن تفقد 225-255 رطلاً في السنة الأولى. ومع ذلك ، إذا كنت تمارس الرياضة وتناول الطعام بشكل صحيح ، يمكن تحقيق المزيد من فقدان الوزن.
  في نهاية المطاف، تدرك المنظمات الناجحة أنه يجب عليها في كثير من الأحيان تغيير ثقافتها لتحويل نفسها بنجاح، وأن مثل هذا التغيير يبدأ من القيادة العليا.	التغيير الناجح غالباً ما يبدأ من الأعلى ويتطلب توجيه جيد لضمان انتقال سلس.	المنظمات الناجحة عادة ما تحتوي على الغشاشين الذين "يقومون" بتخزين الحسابات لضمان تدفق سريع من المساهمين الجشعين.
  ما نوع المشاريع التي يمكنني تحميلها في غيثوب؟	ما نوع المشاريع التي يجب أن يضعها شخص ما على GitHub؟	ما هو التأثير المحتمل على الاقتصاد الهندي بعد إلغاء 500 و 1000 روبية؟

• Loss: MultipleNegativesRankingLoss with these parameters:

  {
      "scale": 20.0,
      "similarity_fct": "cos_sim"
  }
  

Training Hyperparameters

Non-Default Hyperparameters

• per_device_train_batch_size: 16
• per_device_eval_batch_size: 16
• learning_rate: 2e-05
• num_train_epochs: 5
• warmup_ratio: 0.1
• fp16: True
• batch_sampler: no_duplicates

All Hyperparameters

Click to expand

• overwrite_output_dir: False
• do_predict: False
• eval_strategy: no
• 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: 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: 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
• eval_use_gather_object: False
• prompts: None
• batch_sampler: no_duplicates
• multi_dataset_batch_sampler: proportional

Training Logs

Epoch	Step	Training Loss	arabic-test_cosine_accuracy
0.008	50	1.0824	-
0.16	500	0.6589	-
0.32	1000	0.4173	-
0.48	1500	0.3636	-
0.64	2000	0.3261	-
0.8	2500	0.3075	-
0.96	3000	0.2975	-
1.12	3500	0.287	-
1.28	4000	0.2259	-
1.44	4500	0.1764	-
1.6	5000	0.1262	-
1.76	5500	0.1138	-
1.92	6000	0.1141	-
2.08	6500	0.119	-
2.24	7000	0.1009	-
2.4	7500	0.0733	-
2.56	8000	0.0615	-
2.7200	8500	0.0512	-
2.88	9000	0.0546	-
3.04	9500	0.0524	-
3.2	10000	0.0515	-
3.36	10500	0.0427	-
3.52	11000	0.0331	-
3.68	11500	0.0243	-
3.84	12000	0.0252	-
4.0	12500	0.026	-
4.16	13000	0.0318	-
4.32	13500	0.0266	-
4.48	14000	0.0218	-
4.64	14500	0.0146	-
4.8	15000	0.0166	-
4.96	15500	0.0189	-
0.16	500	0.0223	-
0.32	1000	0.0212	-
0.48	1500	0.0232	-
0.64	2000	0.0218	-
0.8	2500	0.0273	-
0.96	3000	0.035	-
1.12	3500	0.0381	-
1.28	4000	0.0266	-
1.44	4500	0.0186	-
1.6	5000	0.0149	-
1.76	5500	0.0126	-
1.92	6000	0.0152	-
2.08	6500	0.0173	-
2.24	7000	0.0142	-
2.4	7500	0.0104	-
2.56	8000	0.0076	-
2.7200	8500	0.0062	-
2.88	9000	0.0071	-
3.04	9500	0.0083	-
3.2	10000	0.0082	-
3.36	10500	0.0054	-
3.52	11000	0.0045	-
3.68	11500	0.0037	-
3.84	12000	0.0038	-
4.0	12500	0.0045	-
4.16	13000	0.0051	-
4.32	13500	0.0034	-
4.48	14000	0.0031	-
4.64	14500	0.0023	-
4.8	15000	0.0029	-
4.96	15500	0.0027	-
5.0	15625	-	0.9383

Framework Versions

• Python: 3.10.12
• Sentence Transformers: 3.3.1
• Transformers: 4.44.2
• PyTorch: 2.4.1+cu121
• Accelerate: 0.34.2
• Datasets: 3.2.0
• Tokenizers: 0.19.1

Citation

BibTeX

Sentence Transformers

@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

@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}
}