Omartificial-Intelligence-Space/inference-free-splade-distilbert-base-Arabic-cased-nq

Inference-free SPLADE distilbert-base-multilingual-cased trained on Natural-Questions tuples

This is a Asymmetric Inference-free SPLADE Sparse Encoder model finetuned from distilbert/distilbert-base-multilingual-cased on the arabic-natural-questions dataset using the sentence-transformers library. It maps sentences & paragraphs to a 119547-dimensional sparse vector space and can be used for semantic search and sparse retrieval.

Colab Notebook

Model Details

Model Description

• —Model Type: Asymmetric Inference-free SPLADE Sparse Encoder
• —Base model: distilbert/distilbert-base-multilingual-cased <!-- at revision 45c032ab32cc946ad88a166f7cb282f58c753c2e -->
• —Maximum Sequence Length: 512 tokens
• —Output Dimensionality: 119547 dimensions
• —Similarity Function: Dot Product
• —Training Dataset:
• —arabic-natural-questions
• —Language: ar
• —License: apache-2.0

Model Sources

• —Documentation: Sentence Transformers Documentation
• —Documentation: Sparse Encoder Documentation
• —Repository: Sentence Transformers on GitHub
• —Hugging Face: Sparse Encoders on Hugging Face

Full Model Architecture

SparseEncoder(
  (0): Router(
    (query_0_SparseStaticEmbedding): SparseStaticEmbedding({'frozen': False}, dim=119547, tokenizer=DistilBertTokenizerFast)
    (document_0_MLMTransformer): MLMTransformer({'max_seq_length': 512, 'do_lower_case': False, 'architecture': 'DistilBertForMaskedLM'})
    (document_1_SpladePooling): SpladePooling({'pooling_strategy': 'max', 'activation_function': 'relu', 'word_embedding_dimension': 119547})
  )
)

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 SparseEncoder
import numpy as np

def retrieve_top_k(model, queries, documents, top_k=3):
    """
    Given a SparseEncoder model, a list of queries and documents,
    returns for each query the top_k documents ranked by SPLADE score.
    """
    # 1) Encode all queries and documents
    query_embeddings    = model.encode_query(queries)       # shape: [n_queries, vocab_size]
    document_embeddings = model.encode_document(documents)  # shape: [n_docs,    vocab_size]
    
    # 2) Compute pairwise similarity
    #    result shape: [n_queries, n_docs]
    sims = model.similarity(query_embeddings, document_embeddings).cpu().numpy()
    
    # 3) For each query, pick top_k documents
    all_results = []
    for qi, query in enumerate(queries):
        scores = sims[qi]
        topk_idx = np.argsort(-scores)[:top_k]
        results = [(idx, float(scores[idx]), documents[idx]) for idx in topk_idx]
        all_results.append((query, results))
    return all_results

if __name__ == "__main__":
    # Load the SPLADE‐DistilBERT Arabic model
    model_name = "Omartificial-Intelligence-Space/inference-free-splade-distilbert-base-Arabic-cased-nq"
    print(f"Loading sparse model {model_name} …")
    model = SparseEncoder(model_name)
    
    # Example documents (could be paragraphs from your corpus)
    documents = [
        "ليونيل ميسي ولد وترعرع في وسط الأرجنتين، وتم تشخيصه بضعف هرمون النمو في طفولته.",
        "علم روسيا هناك تفسيرات مختلفة لما تعنيه الألوان: الأبيض للنبلاء، الأزرق للصدق، الأحمر للشجاعة.",
        "كانت جمهورية تكساس دولة مستقلة في أمريكا الشمالية من 1836 إلى 1846.",
        "تقع مكة المكرمة في غرب المملكة العربية السعودية، وهي أقدس مدن الإسلام.",
        "برج خليفة في دبي هو أطول بناء من صنع الإنسان في العالم بارتفاع 828 متراً."
    ]
    
    # Example queries
    queries = [
        "من هو ليونيل ميسي؟",
        "ما معنى ألوان علم روسيا؟",
        "ما هي جمهورية تكساس؟",
        "أين تقع مكة المكرمة؟",
        "ما هو أطول مبنى في العالم؟"
    ]
    
    # Retrieve top-3 docs per query
    results = retrieve_top_k(model, queries, documents, top_k=2)
    
    # Print nicely
    for query, hits in results:
        print(f"\nQuery: {query}")
        for rank, (doc_idx, score, doc_text) in enumerate(hits, start=1):
            print(f"  {rank}. (score={score:.4f}) {doc_text}")

<!--

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

arabic-natural-questions

• —Dataset: arabic-natural-questions at 2a52bde
• —Size: 99,000 training samples
• —Columns: <code>query</code> and <code>answer</code>
• —Approximate statistics based on the first 1000 samples: | | query | answer | |:--------|:----------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------| | type | string | string | | details | <ul><li>min: 7 tokens</li><li>mean: 15.69 tokens</li><li>max: 35 tokens</li></ul> | <ul><li>min: 10 tokens</li><li>mean: 166.92 tokens</li><li>max: 512 tokens</li></ul> |
• —Samples: | query | answer | |:-----------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | <code>الذي لعب دور الأب في أبي لا يُوعَظ</code> | <code>أليكس ماك آرثر (بالإنجليزية: Alex McArthur) (ولد في 6 مارس 1957) هو ممثل أمريكي.</code> | | <code>أين كان موقع معركة هستيينغز</code> | <code>معركة هستنغز معركة هستنغز[1] عُقدت في 14 أكتوبر 1066 بين الجيش النورماندي الفرنسي لويليام دوق نورماندي والجيش الإنجليزي بقيادة الملك الأنجلو ساكسوني هارولد غودوينسون، وبدأت بذلك الفتح النورماني لإنجلترا. وقعت على بعد حوالي 7 أميال (11 كيلومتر) شمال غرب هستنغز، بالقرب من بلدة باتل الحالية في شرق ساسكس، وكانت انتصاراً نورماندياً حاسماً.</code> | | <code>كم عدد الجراء الذي يمكن أن يولدها الكلب</code> | <code>التكاثر الكلابي تم تحديد أكبر حجم للقمامة حتى الآن من قبل مستطيل نابولي في مانيا ، كامبريدجشير ، المملكة المتحدة في 29 نوفمبر 2004 ؛ كان القمامة 24 جروًا. [1]</code> |
• —Loss: <code>SpladeLoss</code> with these parameters:

  {
      "loss": "SparseMultipleNegativesRankingLoss(scale=1.0, similarity_fct='dot_score')",
      "document_regularizer_weight": 0.003,
      "query_regularizer_weight": 0
  }

Evaluation Dataset

arabic-natural-questions

• —Dataset: arabic-natural-questions at 2a52bde
• —Size: 1,000 evaluation samples
• —Columns: <code>query</code> and <code>answer</code>
• —Approximate statistics based on the first 1000 samples: | | query | answer | |:--------|:----------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------| | type | string | string | | details | <ul><li>min: 6 tokens</li><li>mean: 15.74 tokens</li><li>max: 30 tokens</li></ul> | <ul><li>min: 21 tokens</li><li>mean: 170.43 tokens</li><li>max: 512 tokens</li></ul> |
• —Samples: | query | answer | |:---------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | <code>أين نهر تيبر في إيطاليا</code> | <code>التايبر (/ taɪbər /، اللاتينية: Tiberis، [1] الإيطالية: Tevere [teːvere]) [2] هو ثالث أطول نهر في إيطاليا، يرتفع في جبال أبينين في إيميليا-رومانيا ويتدفق 406 كيلومتر (252 ميل) عبر توسكانا وأومبريا ولاتسيو، حيث ينضم إليه نهر أنين، إلى بحر تيرينيان، بين أوستيا وفيوميسينو. [3] يستنزف حوض يقدر بنحو 17،375 كيلومتر مربع (6،709 ميل مربع). حقق النهر شهرة دائمة باعتباره مجرى المياه الرئيسي لمدينة روما، التي تأسست على ضفافها الشرقية.</code> | | <code>ما نوع السيارة التي يقودها جاي غاتسبي</code> | <code>جي غاتسبي في منزل بيوكانان ، قرر جوردان بيكر ، نيك ، جي ، والبيوكانانز زيارة مدينة نيويورك. استعار توم سيارة رولز رويس الصفراء من غاتسبي للقيادة إلى المدينة. في الطريق إلى مدينة نيويورك ، قام توم بتحويل محطة بنزين في "وادي الرماد" ، وهو جزء من لونغ آيلاند. يشارك المالك ، جورج ويلسون ، قلقه من أن زوجته ، ميرتل ، قد تكون على علاقة غرامية. هذا يزعج توم ، الذي كان على علاقة غرامية مع ميرتل ، ويغادر في عجلة من أمره.</code> | | <code>من يغني إذا كنت أستطيع أن أحلم بك</code> | <code>"I Can Dream About You" هي أغنية أداءها المغني الأمريكي دان هارتمان في ألبوم الموسيقى الصوتية لفيلم Streets of Fire. تم إصداره في عام 1984 كأغنية فردية من الموسيقى الصوتية ، وشملت في ألبوم هارتمان I Can Dream About You ، حيث وصلت إلى المركز السادس في Billboard Hot 100. [1]</code> |
• —Loss: <code>SpladeLoss</code> with these parameters:

  {
      "loss": "SparseMultipleNegativesRankingLoss(scale=1.0, similarity_fct='dot_score')",
      "document_regularizer_weight": 0.003,
      "query_regularizer_weight": 0
  }

Training Hyperparameters

Non-Default Hyperparameters

• —eval_strategy: steps
• —per_device_train_batch_size: 16
• —per_device_eval_batch_size: 16
• —learning_rate: 2e-05
• —num_train_epochs: 1
• —warmup_ratio: 0.1
• —fp16: True
• —batch_sampler: no_duplicates
• —router_mapping: {'query': 'query', 'answer': 'document'}
• —learning_rate_mapping: {'SparseStaticEmbedding\\.weight': 0.001}

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: 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: 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: False
• —ignore_data_skip: False
• —fsdp: []
• —fsdp_min_num_params: 0
• —fsdp_config: {'minnumparams': 0, 'xla': False, 'xlafsdpv2': False, 'xlafsdpgrad_ckpt': False}
• —fsdp_transformer_layer_cls_to_wrap: None
• —accelerator_config: {'splitbatches': False, 'dispatchbatches': None, 'evenbatches': True, 'useseedablesampler': True, 'nonblocking': False, 'gradientaccumulationkwargs': 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
• —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
• —average_tokens_across_devices: False
• —prompts: None
• —batch_sampler: no_duplicates
• —multi_dataset_batch_sampler: proportional
• —router_mapping: {'query': 'query', 'answer': 'document'}
• —learning_rate_mapping: {'SparseStaticEmbedding\\.weight': 0.001}

</details>

Training Logs

Framework Versions

• —Python: 3.10.13
• —Sentence Transformers: 5.0.0
• —Transformers: 4.47.1
• —PyTorch: 2.4.1+cu121
• —Accelerate: 1.2.1
• —Datasets: 2.21.0
• —Tokenizers: 0.21.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",
}

SpladeLoss

@misc{formal2022distillationhardnegativesampling,
      title={From Distillation to Hard Negative Sampling: Making Sparse Neural IR Models More Effective},
      author={Thibault Formal and Carlos Lassance and Benjamin Piwowarski and Stéphane Clinchant},
      year={2022},
      eprint={2205.04733},
      archivePrefix={arXiv},
      primaryClass={cs.IR},
      url={https://arxiv.org/abs/2205.04733},
}

SparseMultipleNegativesRankingLoss

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

FlopsLoss

@article{paria2020minimizing,
    title={Minimizing flops to learn efficient sparse representations},
    author={Paria, Biswajit and Yeh, Chih-Kuan and Yen, Ian EH and Xu, Ning and Ravikumar, Pradeep and P{'o}czos, Barnab{'a}s},
    journal={arXiv preprint arXiv:2004.05665},
    year={2020}
}

<!--

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