Upload folder using huggingface_hub

2c855c2 verified about 1 year ago

30.1 kB

tags:
  - sentence-transformers
  - sentence-similarity
  - feature-extraction
  - dense
  - generated_from_trainer
  - dataset_size:61039
  - loss:MultipleNegativesRankingLoss
base_model: intfloat/multilingual-e5-large
widget:
  - source_sentence: >-
      خداوند به عبدالله بن محمد چه وظایفی را در مدینه رسول الله صلی الله علیه و
      آله واگذار کرد؟
    sentences:
      - >-
        من لدن ادم الی ابیه عبد الله فی خیر فرقه و اکرم سبط و امنع رهط و اکلاحمل
        و اودع حجر اصطفاه الله و ارتضاه و اجتباه context: من لدن ادم الی ابیه
        عبد الله فی خیر فرقه و اکرم سبط و امنع رهط و اکلاحمل و اودع حجر اصطفاه
        الله و ارتضاه و اجتباه و اتاه من العلم مفاتیحه و من الحکم ینابیعه ابتعثه
        رحمه للعباد و ربیعا للبلاد و انزل الله الیه الکتاب فیه البیان و التبیان
        قرانا عربیا غیر ذی عوج لعلهم یتقون قد بینه للناس و نهجه بعلم قد فصله و
        دین قد اوضحه و فرایض قد اوجبها و حدود حدها للناس و بینها و امور قد کشفها
        لخلقه و اعلنها فیها دلاله الی النجاه و معالم تدعو الی هداه فبلغ رسول
        الله صلی الله علیه و اله ما
      - >-
        قباله وجهک و لا ترفعهما کل ذلک context: علی بن ابراهیم عن ابیه عن ابن
        ابی عمیر عن جمیل بن دراج عن زراره عن احدهما علیهماالسلام قال ترفع یدیک
        فی افتتاح الصلاه قباله وجهک و لا ترفعهما کل ذلک
      - >-
        بد الله بن محمد عما کان یتولاه من الحرب و الصلاه بمدینه رسول الله صلی
        الله علیه و اله اذ کان علی ما ذکرت من جهالته بحقک و استخفافه بقدرک
        context: بد الله بن محمد عما کان یتولاه من الحرب و الصلاه بمدینه رسول
        الله صلی الله علیه و اله اذ کان علی ما ذکرت من جهالته بحقک و استخفافه
        بقدرک و عند ما قرفک به و نسبک الیه من الامر الذی قد علم امیر المومنین
        براءتک منه و صدق نیتک فی ترک محاولته و انک لم توهل نفسک له و قد ولی امیر
        المومنین ما کان یلی من ذلک محمد بن الفضل و امره باکرامک و تبجیلک و
        الانتهاء الی امرک و رایک و التقرب الی الله و الی امیر المومنین بذلک و
        امیر المومنین مشتاق الیک یحب احداث العهد بک و النظر الیک فان نشطت
  - source_sentence: آیا میتوان برای وجود امام علی (ع) زمانی تعیین کرد یا مرزی قائل شد؟
    sentences:
      - >-
        لا یقال له: أقبل، فأقبل، ثم قال له: أدبر، فأدبر. فقال: و عزتی و جلالی ما
        خلقت خلقا هو أحب إلی منک. context: الامام علی علیه السلام لیس لاولیته
        ابتداء ولا لازلیته انقضاء هو الاول ولم یزل والباقی بلا اجل لا یقال له
        متی ولا یضرب له امد ب حتی قبل کل غایه ومده وکل احصاء وعده
      - >-
        لا یزال بنیانهم الذی بنوا ریبه فی قلوبهم الا ان تقطع قلوبهم context: ال
        وای شیء یمنعه من ذلک ثم تلا هذه الایه لا یزال بنیانهم الذی بنوا ریبه فی
        قلوبهم الا ان تقطع قلوبهم قال ثم قال تدری لای شیء تحیر ابن قیاما قال قلت
        لا قال انه تبع ابا الحسن علیه السلام فاتاه عن یمینه وعن شماله وهو یرید
        مسجد النبی صلی الله علیه و اله فالتفت الیه ابو الحسن علیه السلام فقال ما
        ترید حیرک الله قال ثم قال ارایت لو رجع الیهم موسی فقالوا لو نصبته لنا
        فاتبعناه واقتصصنا اثره ا هم کانوا اصوب قولا او من قال لن نبرح علیه
        عاکفین حتی یرجع الینا موسی قال قلت لا بل من قال
      - >-
        حملکما علی خلعه من رقابکما کما یخلع الحرون لجامه و هو الله ربی لا اشرک
        به شییا فلا تقولا اقل نفعا و اضعف دفعا فتستحقا اسم الشرک مع النفاق
        context: حملکما علی خلعه من رقابکما کما یخلع الحرون لجامه و هو الله ربی
        لا اشرک به شییا فلا تقولا اقل نفعا و اضعف دفعا فتستحقا اسم الشرک مع
        النفاق و اما قولکما انی اشجع فرسان العرب و هربکما من لعنی و دعایی فان
        لکل موقف عملا اذا اختلفت الاسنه و ماجت لبود الخیل و ملا سحراکما اجوافکما
        فثم یکفینی الله بکمال القلب و اما اذا ابیتما بانی ادعو الله فلا تجزعا من
        ان یدعو علیکما رجل ساحر من قوم سحره زعمتما اللهم اقعص الزبیر بشر قتله و
        اسفک دمه علی ضلاله و عرف طلحه المذله و ادخر لهما فی الاخره
  - source_sentence: >-
      اگر شخصی در حال تمتع باشد و نتواند هدیه ای برای قربانی پیدا کند، چه باید
      انجام دهد؟
    sentences:
      - >-
        سالت ابا عبد الله علیه السلام عن وداع قبر النبی صلی الله علیه و اله فقال
        تقول صلی الله علیک السلام علیک لا جعله الله اخر تسلیمی علیک context:
        محمد بن یحیی عن احمد بن محمد عن ابن فضال عن یونس بن یعقوب قال سالت ابا
        عبد الله علیه السلام عن وداع قبر النبی صلی الله علیه و اله فقال تقول صلی
        الله علیک السلام علیک لا جعله الله اخر تسلیمی علیک
      - >-
        علی بن ابراهیم عن ابیه عن ابن ابی عمیر عن هشام بن الحکم عن ابی عبد الله
        علیه السلام context: علی بن ابراهیم عن ابیه عن ابن ابی عمیر عن هشام بن
        الحکم عن ابی عبد الله علیه السلام قال قال البنفسج سید ادهانکم
      - >-
        سالته عن رجل تمتع فلم یجد ما یهدی به حتی اذا کان یوم النفر وجد ثمن شاه ا
        یذبح او یصوم قال بل یصوم فان ایام الذبح قد مضت context: احمد بن محمد بن
        ابی نصر عن عبد الکریم عن ابی بصیر عن احدهما علیهماالسلام قال سالته عن
        رجل تمتع فلم یجد ما یهدی به حتی اذا کان یوم النفر وجد ثمن شاه ا یذبح او
        یصوم قال بل یصوم فان ایام الذبح قد مضت
  - source_sentence: >-
      به گفته امام صادق (ع)، چه چیزی به جز موارد باطل کننده وضو، از بدن خارج
      میشود که نباید به آن توجه کرد؟
    sentences:
      - >-
        ثم تلا هذه الایه حبب الیکم الاءیمان وزینه فی قلوبکم وکره الیکم الکفر
        والفسوق والعصیان اولیک هم الراشدون context: علی بن ابراهیم عن ابیه عن
        حماد عن حریز عن فضیل بن یسارقال سالت ابا عبد الله علیه السلام عن الحب
        والبغض ا من الاءیمان هو فقال و هل الاءیمان الا الحب والبغض ثم تلا هذه
        الایه حبب الیکم الاءیمان وزینه فی قلوبکم وکره الیکم الکفر والفسوق
        والعصیان اولیک هم الراشدون
      - >-
        الذین انعم الله علیک بهما context: محمد بن اسماعیل عن الفضل بن شاذان و
        احمد بن ادریس عن محمد بن عبد الجبار جمیعا عن صفوان بن یحیی عن سالم ابی
        الفضل عن ابی عبد الله علیه السلام قال لیس ینقض الوضوء الا ما خرج من
        طرفیک الاسفلین اللذین انعم الله علیک بهما
      - >-
        ثم خلی سبیلهما context: بطن قد بدت عروق فخذیه و قد زنی بامراه مریضه فامر
        رسول الله صلی الله علیه و اله بعذق فیه مایه شمراخ فضرب به الرجل ضربه و
        ضربت به المراه ضربه ثم خلی سبیلهما ثم قرا هذه الایه و خذ بیدک ضغثا فاضرب
        به و لا تحنث
  - source_sentence: ابلیس به موسی چه توصیهای در مورد صدقه و نیت خالصانه کرد؟
    sentences:
      - >-
        قال من السنه لبس الخاتم context: ابو علی الاشعری عن الحسن بن علی الکوفی
        عن عبیس بن هشام عن حسین بن احمد المنقری عن یونس بن ظبیان عن ابی عبد الله
        علیه السلام قال من السنه لبس الخاتم
      - >-
        قال المکاری و الجمال الذی یختلف و لیس له مقام یتم الصلاه و یصوم شهر
        رمضان context: علی بن ابراهیم عن ابیه و محمد بن اسماعیل عن الفضل بن
        شاذان جمیعا عن ابن ابی عمیر عن هشام بن الحکم عن ابی عبد الله علیه السلام
        قال المکاری و الجمال الذی یختلف و لیس له مقام یتم الصلاه و یصوم شهر
        رمضان
      - >-
        قال ابلیس لموسی علیه السلام اذا هممت بصدقه فامضها واذا هم العبد بصدقه
        کنت صاحبه دون اصحابی حتى احول بینه وبینها context: قصص الانبیاء عنهم
        علیهم السلام قال ابلیس لموسی علیه السلام اذا هممت بصدقه فامضها واذا هم
        العبد بصدقه کنت صاحبه دون اصحابی حتی احول بینه وبینها
pipeline_tag: sentence-similarity
library_name: sentence-transformers
metrics:
  - cosine_accuracy@1
  - cosine_accuracy@3
  - cosine_accuracy@5
  - cosine_accuracy@10
  - cosine_precision@1
  - cosine_precision@3
  - cosine_precision@5
  - cosine_precision@10
  - cosine_recall@1
  - cosine_recall@3
  - cosine_recall@5
  - cosine_recall@10
  - cosine_ndcg@10
  - cosine_mrr@10
  - cosine_map@100
model-index:
  - name: SentenceTransformer based on intfloat/multilingual-e5-large
    results:
      - task:
          type: information-retrieval
          name: Information Retrieval
        dataset:
          name: validation ir eval
          type: validation_ir_eval
        metrics:
          - type: cosine_accuracy@1
            value: 0.6158521600943659
            name: Cosine Accuracy@1
          - type: cosine_accuracy@3
            value: 0.8605809400547191
            name: Cosine Accuracy@3
          - type: cosine_accuracy@5
            value: 0.920690050623372
            name: Cosine Accuracy@5
          - type: cosine_accuracy@10
            value: 0.9647438522911581
            name: Cosine Accuracy@10
          - type: cosine_precision@1
            value: 0.6158521600943659
            name: Cosine Precision@1
          - type: cosine_precision@3
            value: 0.28686031335157297
            name: Cosine Precision@3
          - type: cosine_precision@5
            value: 0.18413801012467443
            name: Cosine Precision@5
          - type: cosine_precision@10
            value: 0.09647438522911582
            name: Cosine Precision@10
          - type: cosine_recall@1
            value: 0.6158521600943659
            name: Cosine Recall@1
          - type: cosine_recall@3
            value: 0.8605809400547191
            name: Cosine Recall@3
          - type: cosine_recall@5
            value: 0.920690050623372
            name: Cosine Recall@5
          - type: cosine_recall@10
            value: 0.9647438522911581
            name: Cosine Recall@10
          - type: cosine_ndcg@10
            value: 0.8007440911740579
            name: Cosine Ndcg@10
          - type: cosine_mrr@10
            value: 0.7469129741926596
            name: Cosine Mrr@10
          - type: cosine_map@100
            value: 0.7488402597891997
            name: Cosine Map@100

SentenceTransformer based on intfloat/multilingual-e5-large

This is a sentence-transformers model finetuned from intfloat/multilingual-e5-large. It maps sentences & paragraphs to a 1024-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: intfloat/multilingual-e5-large
Maximum Sequence Length: 512 tokens
Output Dimensionality: 1024 dimensions
Similarity Function: Cosine Similarity

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, 'architecture': 'XLMRobertaModel'})
  (1): Pooling({'word_embedding_dimension': 1024, '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})
  (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("sentence_transformers_model_id")
# Run inference
sentences = [
    'ابلیس به موسی چه توصیهای در مورد صدقه و نیت خالصانه کرد؟',
    'قال ابلیس لموسی علیه السلام اذا هممت بصدقه فامضها واذا هم العبد بصدقه کنت صاحبه دون اصحابی حتى احول بینه وبینها context: قصص الانبیاء عنهم علیهم السلام قال ابلیس لموسی علیه السلام اذا هممت بصدقه فامضها واذا هم العبد بصدقه کنت صاحبه دون اصحابی حتی احول بینه وبینها',
    'قال المکاری و الجمال الذی یختلف و لیس له مقام یتم الصلاه و یصوم شهر رمضان context: علی بن ابراهیم عن ابیه و محمد بن اسماعیل عن الفضل بن شاذان جمیعا عن ابن ابی عمیر عن هشام بن الحکم عن ابی عبد الله علیه السلام قال المکاری و الجمال الذی یختلف و لیس له مقام یتم الصلاه و یصوم شهر رمضان',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 1024]

# Get the similarity scores for the embeddings
similarities = model.similarity(embeddings, embeddings)
print(similarities)
# tensor([[ 1.0000,  0.7678, -0.0848],
#         [ 0.7678,  1.0000, -0.1112],
#         [-0.0848, -0.1112,  1.0000]])

Evaluation

Metrics

Information Retrieval

Dataset: validation_ir_eval
Evaluated with InformationRetrievalEvaluator

Metric	Value
cosine_accuracy@1	0.6159
cosine_accuracy@3	0.8606
cosine_accuracy@5	0.9207
cosine_accuracy@10	0.9647
cosine_precision@1	0.6159
cosine_precision@3	0.2869
cosine_precision@5	0.1841
cosine_precision@10	0.0965
cosine_recall@1	0.6159
cosine_recall@3	0.8606
cosine_recall@5	0.9207
cosine_recall@10	0.9647
cosine_ndcg@10	0.8007
cosine_mrr@10	0.7469
cosine_map@100	0.7488

Training Details

Training Dataset

Unnamed Dataset

Size: 61,039 training samples
Columns: sentence_0 and sentence_1
Approximate statistics based on the first 1000 samples:
sentence_0 sentence_1
type string string
details
min: 8 tokens
mean: 21.36 tokens
max: 54 tokens

min: 32 tokens
mean: 111.04 tokens
max: 466 tokens

	sentence_0	sentence_1
type	string	string
details	min: 8 tokens mean: 21.36 tokens max: 54 tokens	min: 32 tokens mean: 111.04 tokens max: 466 tokens

Samples:

sentence_0	sentence_1
`به نظر امیرالمومنین (ع)، ربا در این امت چگونه است و چه عاقبتی دارد؟`	والله للربا فی هذه الامه اخفی من دبیب النمل علی الصفا شوبوا ایمانکم بالصدق التاجر فاجر والفاجر فی النار context: عده من اصحابنا عن احمد بن محمد عن عثمان بن عیسی عن ابی الجارود عن الاصبغ بن نباته قال سمعت امیر المومنین علیه السلام یقول علی المنبر یا معشر التجار الفقه ثم المتجر الفقه ثم المتجر الفقه ثم المتجر والله للربا فی هذه الامه اخفی من دبیب النمل علی الصفا شوبوا ایمانکم بالصدق التاجر فاجر والفاجر فی النار الا من اخذ الحق واعطی الحق
`در چه سنی شیر شتر مادر، حق مصرف شیر را پیدا میکند؟`	ففیها حقه طروقه الفحل ثم لیس فیها شیء حتی تبلغ ستین فاذا بلغت ستین ففیها جذعه context: ه ابن اللبون والانثی ابنه لبون لان امه حملت غیره ووضعته فصارت ذات لبن راجع الصحاح ج 6 ص 2192 النهایه ج 4 ص 228 لبن ثم لیس فیها شیء حتی تبلغ خمسا و اربعین فاذا بلغت خمسا و اربعین ففیها حقه طروقه الفحل ثم لیس فیها شیء حتی تبلغ ستین فاذا بلغت ستین ففیها جذعه ثم لیس فیها شیء حتی تبلغ خمسا و سبعین فاذا بلغت خمسا و سبعین ففیها ابنتا لبون ثم لیس فیها شیء حتی تبلغ تسعین فاذا بلغت تسعین ففیها حقتان طروقتا الفحل ثم لیس فیها شیء حتی تبلغ عشرین و مایه فاذا بلغت عشرین و مایه ففیها حقتان
`برکت و محافظت از عقیقه به چه چیزی مرتبط است؟`	`اللهم و عزتی و جلالی ما خلقت خلقا هو أحب إلی منک. context: عده من اصحابنا عن سهل بن زیاد عن بعض اصحابه یرفعه عن ابی عبد الله علیه السلام قال تقول علی العقیقه و ذکر مثله وزاد فیه اللهم لحمها بلحمه ودمها بدمه وعظمها بعظمه وشعرها بشعره وجلدها بجلده اللهم اجعلها وقاء لفلان بن فلان`

Loss: MultipleNegativesRankingLoss with these parameters:

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

Training Hyperparameters

Non-Default Hyperparameters

eval_strategy: steps
per_device_train_batch_size: 72
per_device_eval_batch_size: 72
num_train_epochs: 5
multi_dataset_batch_sampler: round_robin

All Hyperparameters

Click to expand

overwrite_output_dir: False
do_predict: False
eval_strategy: steps
prediction_loss_only: True
per_device_train_batch_size: 72
per_device_eval_batch_size: 72
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
num_train_epochs: 5
max_steps: -1
lr_scheduler_type: linear
lr_scheduler_kwargs: {}
warmup_ratio: 0.0
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: 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: 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}
parallelism_config: None
deepspeed: None
label_smoothing_factor: 0.0
optim: adamw_torch_fused
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
hub_revision: None
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
liger_kernel_config: None
eval_use_gather_object: False
average_tokens_across_devices: False
prompts: None
batch_sampler: batch_sampler
multi_dataset_batch_sampler: round_robin
router_mapping: {}
learning_rate_mapping: {}

Training Logs

Epoch	Step	Training Loss	validation_ir_eval_cosine_ndcg@10
0.5896	500	0.6713	-
1.0	848	-	0.6695
1.1792	1000	0.1576	-
1.7689	1500	0.0938	-
2.0	1696	-	0.7355
2.3585	2000	0.0618	-
2.9481	2500	0.0439	-
3.0	2544	-	0.7674
3.5377	3000	0.0285	-
4.0	3392	-	0.7882
4.1274	3500	0.0254	-
4.7170	4000	0.018	-
5.0	4240	-	0.8007

Framework Versions

Python: 3.12.3
Sentence Transformers: 5.1.0
Transformers: 4.56.1
PyTorch: 2.8.0+cu128
Accelerate: 1.10.1
Datasets: 4.0.0
Tokenizers: 0.22.0

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