hadith-retriever-bn-v2

SentenceTransformer based on intfloat/multilingual-e5-base

This is a sentence-transformers model finetuned from intfloat/multilingual-e5-base. It maps sentences & paragraphs to a 768-dimensional dense vector space and can be used for retrieval.

Model Details

Model Description

• Model Type: Sentence Transformer
• Base model: intfloat/multilingual-e5-base <!-- at revision d128750597153bb5987e10b1c3493a34e5a4502a -->
• Maximum Sequence Length: 256 tokens
• Output Dimensionality: 768 dimensions
• Similarity Function: Cosine Similarity
• Supported Modality: Text

<!-- - **Training Dataset:** Unknown --> <!-- - **Language:** Unknown --> <!-- - **License:** Unknown -->

Model Sources

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

Full Model Architecture

SentenceTransformer(
  (0): Transformer({'transformer_task': 'feature-extraction', 'modality_config': {'text': {'method': 'forward', 'method_output_name': 'last_hidden_state'}}, 'module_output_name': 'token_embeddings', 'architecture': 'XLMRobertaModel'})
  (1): Pooling({'embedding_dimension': 768, 'pooling_mode': 'mean', '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 = [
    'query: নিষিদ্ধ ছবি বলতে কী বোঝায়?',
    'passage: নবী (ﷺ) বলেছেন, ‘যে বাড়িতে প্রাণীর ছবি থাকে সেখানে ফেরেশতা প্রবেশ করে না।’\n\nবুসর (রহঃ) বলেন, অতঃপর যায়িদ ইবন খালিদ (রাঃ) রোগাক্রান্ত হন। আমরা তাঁর সেবার জন্য গেলাম। তখন আমরা তাঁর ঘরে একটি পর্দায় কিছু ছবি দেখতে পেলাম। তখন আমি (বুসর) উবাইদুল্লাহ খাওলানি (রহঃ)-কে জিজ্ঞেস করলাম, ইনি কি আমাদের কাছে ছবি সম্পর্কীয় হাদীস বর্ণনা করেননি? তখন তিনি বলেছেন, প্রাণীর; তবে কাপড়ের মধ্যে কিছু অঙ্কন করা নিষিদ্ধ নয়, তুমি কি তা শুননি? আমি বললাম, না। তিনি বললেন, হ্যাঁ, তিনি তা বর্ণনা করেছেন।',
    'passage: লোকজন যখন নবী (ﷺ)-এর নিকট নিজেদের সদকা নিয়ে উপস্থিত হতো তখন তিনি বলতেনঃ আল্লাহ! অমুকের প্রতি রহমত বর্ষণ করুন। একদা আমার পিতা সদকা নিয়ে হাজির হলে তিনি বললেনঃ হে আল্লাহ! আবু আওফার বংশধরের প্রতি রহমত বর্ষণ করুন।',
]
embeddings = model.encode(sentences)
print(embeddings.shape)
# [3, 768]

# Get the similarity scores for the embeddings
similarities = model.similarity(embeddings, embeddings)
print(similarities)
# tensor([[ 1.0000,  0.5619, -0.0843],
#         [ 0.5619,  1.0000,  0.0230],
#         [-0.0843,  0.0230,  1.0000]])

<!-- ### 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: 21,389 training samples
• Columns: <code>anchor</code> and <code>positive</code>
• Approximate statistics based on the first 100 samples:

  	anchor	positive
  type	string	string
  modality	text	text
  details	<ul><li>min: 10 tokens</li><li>mean: 18.71 tokens</li><li>max: 31 tokens</li></ul>	<ul><li>min: 19 tokens</li><li>mean: 108.47 tokens</li><li>max: 256 tokens</li></ul>

• Samples:

  anchor	positive
  <code>query: রমজান মাসে রোজা অবস্থায় সহবাস করলে কাফফারা কী?</code>	<code>passage: বর্ণিত। এক ব্যক্তি রমজান মাসে তার স্ত্রীর সাথে সহবাস করে এবং এ সম্পর্কে রাসূলুল্লাহ (ﷺ)-এর নিকট প্রশ্ন করল। তখন তিনি বললেন, “তোমার কোন ক্রীতদাস আছে কি?” সে বলল, না। তিনি আবার বললেন, “তুমি দুই মাস সাওম পালন করতে পারবে কি?” সে বলল, না। তখন তিনি বললেন, “তাহলে ষাটজন মিসকীনকে আহার করাও।”</code>
  <code>query: ইহরাম অবস্থায় কষ্টের কারণ কী?</code>	<code>passage: রসূলুল্লাহ (ﷺ) আয়িশা (রাঃ)-এর কাছে উপস্থিত হলেন, তখন তিনি কাঁদছিলেন। হাদীসের অবশিষ্ট অংশ পূর্বোক্ত লায়স (রহঃ)-এর হাদীসের অনুরূপ। অবশ্য উক্ত হাদীসের প্রথমাংশ এ হাদীসে বর্ণনা করা হয়নি।</code>
  <code>query: জানাজার নামাজ পড়লে কতটুকু সওয়াব পাওয়া যায়?</code>	<code>passage: একই সূত্রে অনুরূপ বর্ণনা করেছেন। সা‘ঈদ ও হিশাম-এর বর্ণিত হাদীসে আছে, নবী (ﷺ)-কে কীরাত সম্পর্কে জিজ্ঞেস করা হলে তিনি বললেন, তা উহুদ পাহাড় সমতুল্য।</code>

• Loss: <code>MultipleNegativesRankingLoss</code> with these parameters:

  {
      "scale": 20.0,
      "similarity_fct": "cos_sim",
      "gather_across_devices": false,
      "directions": [
          "query_to_doc"
      ],
      "partition_mode": "joint",
      "hardness_mode": null,
      "hardness_strength": 0.0
  }
  

Evaluation Dataset

Unnamed Dataset

• Size: 436 evaluation samples
• Columns: <code>anchor</code> and <code>positive</code>
• Approximate statistics based on the first 100 samples:

  	anchor	positive
  type	string	string
  modality	text	text
  details	<ul><li>min: 11 tokens</li><li>mean: 18.61 tokens</li><li>max: 33 tokens</li></ul>	<ul><li>min: 17 tokens</li><li>mean: 106.16 tokens</li><li>max: 256 tokens</li></ul>

• Samples:

  anchor	positive
  <code>query: শপথ করে কাউকে মাফ না করার ঘোষণা দেওয়া কি জায়েজ?</code>	<code>passage: রাসূলুল্লাহ (ﷺ) বলেছেন: এক লোক বলল, আল্লাহর শপথ! আল্লাহ অমুক লোককে মাফ করবেন না। আর আল্লাহ তা‘আলা বলেন, সে লোক কে? যে শপথ খেয়ে বলে যে, আমি অমুককে মাফ করব না? আমি তাকে মাফ করে দিলাম এবং তোমার আমল (শপথ)-কে নষ্ট করে দিলাম, কিংবা তিনি যেমন বলেছেন।</code>
  <code>query: তিন দিনের বেশি কথা না বলার পরিণাম কী?</code>	<code>passage: রাসূলুল্লাহ (ﷺ) বলেছেন: কোন মুসলিমের জন্য তার ভাইয়ের সঙ্গে তিন দিনের অধিক সময় সম্পর্ক ছিন্ন রাখা বৈধ নয়। দুই জনের সাক্ষাৎ ঘটলে একজন এদিকে মুখ ফিরিয়ে থাকে, অন্যজন ঐদিকে ঘাড় বাঁকিয়ে থাকে। তবে তাদের মধ্যে সে-ই উত্তম, যে প্রথমে সালাম করে।</code>
  <code>query: চাটুকার বা অতিরিক্ত প্রশংসাকারীদের প্রতি কী আচরণ করতে হয়?</code>	<code>passage: এক ব্যক্তি দণ্ডায়মান অবস্থায় কোন এক আমীরের বা নেতার ভূয়সী প্রশংসা করতে শুরু করলে মিকদাদ (রাঃ) তার মুখে মাটি ছুঁড়ে মারলেন এবং বললেন, রাসূলুল্লাহ (ﷺ) আমাদেরকে নির্দেশ দিয়েছেন অতিমাত্রায় প্রশংসাকারীদের মুখে মাটি ছুঁড়ে মারার জন্য।</code>

• Loss: <code>MultipleNegativesRankingLoss</code> with these parameters:

  {
      "scale": 20.0,
      "similarity_fct": "cos_sim",
      "gather_across_devices": false,
      "directions": [
          "query_to_doc"
      ],
      "partition_mode": "joint",
      "hardness_mode": null,
      "hardness_strength": 0.0
  }
  

Training Hyperparameters

Non-Default Hyperparameters

• per_device_train_batch_size: 40
• num_train_epochs: 7
• warmup_steps: 205
• fp16: True
• per_device_eval_batch_size: 32
• load_best_model_at_end: True
• batch_sampler: no_duplicates

All Hyperparameters

<details><summary>Click to expand</summary>

• per_device_train_batch_size: 40
• num_train_epochs: 7
• max_steps: -1
• learning_rate: 5e-05
• lr_scheduler_type: linear
• lr_scheduler_kwargs: None
• warmup_steps: 205
• optim: adamw_torch_fused
• optim_args: None
• weight_decay: 0.0
• adam_beta1: 0.9
• adam_beta2: 0.999
• adam_epsilon: 1e-08
• optim_target_modules: None
• gradient_accumulation_steps: 1
• average_tokens_across_devices: True
• max_grad_norm: 1.0
• label_smoothing_factor: 0.0
• bf16: False
• fp16: True
• bf16_full_eval: False
• fp16_full_eval: False
• tf32: None
• gradient_checkpointing: False
• gradient_checkpointing_kwargs: None
• torch_compile: False
• torch_compile_backend: None
• torch_compile_mode: None
• use_liger_kernel: False
• liger_kernel_config: None
• use_cache: False
• neftune_noise_alpha: None
• torch_empty_cache_steps: None
• auto_find_batch_size: False
• log_on_each_node: True
• logging_nan_inf_filter: True
• include_num_input_tokens_seen: no
• log_level: passive
• log_level_replica: warning
• disable_tqdm: False
• project: huggingface
• trackio_space_id: None
• trackio_bucket_id: None
• trackio_static_space_id: None
• per_device_eval_batch_size: 32
• prediction_loss_only: True
• eval_on_start: False
• eval_do_concat_batches: True
• eval_use_gather_object: False
• eval_accumulation_steps: None
• include_for_metrics: []
• batch_eval_metrics: False
• save_only_model: False
• save_on_each_node: False
• enable_jit_checkpoint: False
• push_to_hub: False
• hub_private_repo: None
• hub_model_id: None
• hub_strategy: every_save
• hub_always_push: False
• hub_revision: None
• load_best_model_at_end: True
• ignore_data_skip: False
• restore_callback_states_from_checkpoint: False
• full_determinism: False
• seed: 42
• data_seed: None
• use_cpu: False
• 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
• dataloader_drop_last: False
• dataloader_num_workers: 0
• dataloader_pin_memory: True
• dataloader_persistent_workers: False
• dataloader_prefetch_factor: None
• remove_unused_columns: True
• label_names: None
• train_sampling_strategy: random
• length_column_name: length
• ddp_find_unused_parameters: None
• ddp_bucket_cap_mb: None
• ddp_broadcast_buffers: False
• ddp_static_graph: None
• ddp_backend: None
• ddp_timeout: 1800
• fsdp: None
• fsdp_config: None
• deepspeed: None
• debug: []
• skip_memory_metrics: True
• do_predict: False
• resume_from_checkpoint: None
• warmup_ratio: None
• local_rank: -1
• prompts: None
• batch_sampler: no_duplicates
• multi_dataset_batch_sampler: proportional
• router_mapping: {}
• learning_rate_mapping: {}

</details>

Training Logs

<details><summary>Click to expand</summary>

• The bold row denotes the saved checkpoint.

</details>

Training Time

• Training: 48.5 minutes

Framework Versions

• Python: 3.12.13
• Sentence Transformers: 5.5.1
• Transformers: 5.10.2
• PyTorch: 2.11.0+cu128
• Accelerate: 1.13.0
• Datasets: 4.0.0
• Tokenizers: 0.22.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{oord2019representationlearningcontrastivepredictive,
      title={Representation Learning with Contrastive Predictive Coding},
      author={Aaron van den Oord and Yazhe Li and Oriol Vinyals},
      year={2019},
      eprint={1807.03748},
      archivePrefix={arXiv},
      primaryClass={cs.LG},
      url={https://arxiv.org/abs/1807.03748},
}

<!-- ## 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.* -->