arabic-gte-multilingual-base-100k / README.md

RamzyBakir

Update README.md

00739e8 verified 4 months ago

preview code

raw

history blame contribute delete

20.2 kB

metadata

tags:
  - sentence-transformers
  - sentence-similarity
  - feature-extraction
  - generated_from_trainer
  - dataset_size:100000
  - loss:MultipleNegativesRankingLoss
base_model: Alibaba-NLP/gte-multilingual-base
widget:
  - source_sentence: (ساندورو) وقف.
    sentences:
      - ما الذي يمكن أن يكون رد فعل ذكي وفعال على هجوم أوري الإرهابي؟
      - جون) تقدم)
      - (ساندورو روز)
  - source_sentence: كيف أصبح مواطناً كندياً؟
    sentences:
      - >-
        كيف يمكنني أن أصبح مواطناً كندياً؟ هل صحيح أن الإقامة الدائمة تستغرق
        وقتاً طويلاً جداً؟
      - ما هي أفضل أساليب الدراسة للامتحانات والصفوف المتقدمة؟
      - ما هو تأثير رئاسة ترامب على كندا؟
  - source_sentence: رجلين في ألمانيا يقفزان فوق السكك الحديدية في نفس الوقت بدون قمصان
    sentences:
      - إمرأتان تسلقان السور في إيطاليا
      - هناك رجلين يرتديان ملابس جزئية
      - هل ستكون رئاسة ترامب جيدة للهند؟
  - source_sentence: ما هي الآثار الجانبية طويلة المدى للقهوة؟
    sentences:
      - ما هي بعض الآثار الايجابية والسلبية على المدى الطويل من شرب القهوة؟
      - إذا كان الفضاء الخارجي هو فراغ كيف يقيسون درجة الحرارة؟
      - كم مرة تشرب القهوة؟
  - source_sentence: ما هي قصتك الملهمة التي غيرت حياتك؟
    sentences:
      - ما هي قصصك الفاشلة؟
      - ما هي بعض القصص الأكثر إلهاما التي غيرت حياتك؟
      - >-
        كيف يمكنني كسب 1000 دولار كدخل إضافي في الشهر بالإضافة إلى وظيفتي
        العادية؟
datasets:
  - silma-ai/silma-arabic-triplets-dataset-v1.0
pipeline_tag: sentence-similarity
library_name: sentence-transformers
metrics:
  - cosine_accuracy
model-index:
  - name: SentenceTransformer based on Alibaba-NLP/gte-multilingual-base
    results:
      - task:
          type: triplet
          name: Triplet
        dataset:
          name: triplet eval
          type: triplet-eval
        metrics:
          - type: cosine_accuracy
            value: 0.9679625630378723
            name: Cosine Accuracy
license: apache-2.0
language:
  - ar

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

This is a sentence-transformers model finetuned from Alibaba-NLP/gte-multilingual-base on the silma-arabic-triplets-dataset-v1.0 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
Maximum Sequence Length: 8192 tokens
Output Dimensionality: 768 dimensions
Similarity Function: Cosine Similarity
Training Dataset:
- silma-arabic-triplets-dataset-v1.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': 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:

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("RamzyBakir/arabic-gte-multilingual-base-100k", trust_remote_code=True)
# 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: triplet-eval
Evaluated with TripletEvaluator

Metric	Value
cosine_accuracy	0.968

Training Details

Training Dataset

silma-arabic-triplets-dataset-v1.0

Dataset: silma-arabic-triplets-dataset-v1.0 at 77f8f6b
Size: 100,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: 5 tokens mean: 18.0 tokens max: 77 tokens	min: 4 tokens mean: 15.21 tokens max: 96 tokens	min: 4 tokens mean: 15.25 tokens max: 73 tokens

Samples:

anchor	positive	negative
`امرأة شابة ذات شعر أشقر، ترتدي فستاناً رمادياً، وقمصان حمراء، تستمع إلى الموسيقى وهي تسير سريعاً إلى وجهتها.`	`امرأة شابة تستمع إلى الموسيقى وتمر بسرعة`	`الرجل يأخذ قيلولة`
`لماذا لا تعطي جوجل أي ردود فعل؟`	`لماذا لا تشارك جوجل ردود الفعل من المقابلة مع المرشح؟`	`ما هي أفضل الأماكن للزيارة في جوا في رحلة لمدة يومين ونصف؟`
`كيف بالضبط سيؤدي إلغاء عملة 500/1000 روبية إلى كبح الأموال السوداء إلى أي مدى؟`	`هل سيساعد إلغاء عملة الـ 500 و 1000 روبية في الهند في كبح النقود السوداء؟ أم أن الأغنياء يخزنون أموالهم غير الخاضعة للضريبة؟`	`هل ستأتي عملة الـ2000 روبية حقاً بشريحة تحديد المواقع، أم أنها مجرد إشاعة؟`

Loss: MultipleNegativesRankingLoss with these parameters:

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

Evaluation Dataset

silma-arabic-triplets-dataset-v1.0

Dataset: silma-arabic-triplets-dataset-v1.0 at 77f8f6b
Size: 11,112 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: 18.48 tokens max: 84 tokens	min: 4 tokens mean: 16.0 tokens max: 78 tokens	min: 4 tokens mean: 15.29 tokens max: 70 tokens

Samples:

anchor	positive	negative
`نعم لقد كان فقط كما تعلمون لقد كان انها لحظة مناسبة جدا لهم لمحاولة كما تعلمون`	`يبدو وكأنه وقت مناسب جدا بالنسبة لهم لمحاولة.`	`أعتقد أنه وقت سيء جداً للمحاولة، ألا تعتقدين ذلك؟`
`هل يمكنك أن توصي بفيلم رعب جيد؟`	`هل يمكنك أن توصي ببعض أفلام الرعب الجيدة؟`	`ما هو أسلوب فيلم البؤساء؟`
`ما هي التغييرات الحقيقية التي شعرتم بها في حياتكم (ليس من خلال التقارير الإعلامية) ، منذ وصول حكومة مودي إلى السلطة؟`	`ما هو التغيير السلبي الذي شعرتم به في حياتكم منذ وصول حكومة مودي إلى السلطة؟`	`ما الذي يمكن أن يغير حياتك؟`

Loss: MultipleNegativesRankingLoss with these parameters:

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

Training Hyperparameters

Non-Default Hyperparameters

eval_strategy: steps
per_device_train_batch_size: 16
per_device_eval_batch_size: 16
num_train_epochs: 1
warmup_ratio: 0.1
fp16: True
load_best_model_at_end: True

All Hyperparameters

Click to expand

overwrite_output_dir: False
do_predict: False
eval_strategy: steps
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: 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: 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: 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
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

Training Logs

Epoch	Step	Training Loss	Validation Loss	triplet-eval_cosine_accuracy
0.16	500	0.2784	0.2127	0.9552
0.32	1000	0.2282	0.1903	0.9628
0.48	1500	0.2125	0.1787	0.9640
0.64	2000	0.1887	0.1678	0.9662
0.8	2500	0.1845	0.1616	0.9663
0.96	3000	0.1785	0.1582	0.968

The bold row denotes the saved checkpoint.

Framework Versions

Python: 3.11.13
Sentence Transformers: 4.1.0
Transformers: 4.52.4
PyTorch: 2.6.0+cu124
Accelerate: 1.8.1
Datasets: 3.6.0
Tokenizers: 0.21.2

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