example-splade-co-condenser-marco-msmarco-mse-margin

splade-co-condenser-marco trained on MS MARCO hard negatives with distillation

This is a SPLADE Sparse Encoder model finetuned from Luyu/co-condenser-marco on the msmarco dataset using the sentence-transformers library. It maps sentences & paragraphs to a 30522-dimensional sparse vector space and can be used for semantic search and sparse retrieval.

Model Details

Model Description

• Model Type: SPLADE Sparse Encoder
• Base model: Luyu/co-condenser-marco <!-- at revision e0cef0ab2410aae0f0994366ddefb5649a266709 -->
• Maximum Sequence Length: 256 tokens
• Output Dimensionality: 30522 dimensions
• Similarity Function: Dot Product
• Training Dataset:
  • msmarco
• Language: en
• 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): MLMTransformer({'max_seq_length': 256, 'do_lower_case': False}) with MLMTransformer model: BertForMaskedLM 
  (1): SpladePooling({'pooling_strategy': 'max', 'activation_function': 'relu', 'word_embedding_dimension': 30522})
)

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

# Download from the 🤗 Hub
model = SparseEncoder("arthurbresnu/co-condenser-marco-msmarco-hard-negatives")
# Run inference
queries = [
    "fastest super cars in the world",
]
documents = [
    'The McLaren F1 is amongst the fastest cars in the McLaren series and also the fastest car in the world. The McLaren F1 can clock a maximum speed of 240 miles per hour, or an equivalent of 386 km per hour.',
    'You heard about fastest cars, bikes and plans but today we have world fastest bird collection. In our collection we have top 10 fastest birds of the world. Birdâ\x80\x99s flight speed is fundamentally changeable; a hunting bird speed will increase while diving-to-catch prey as compared to its gliding speeds. Here we have the top 10 fastest birds with their flight speed. 10. Teal 109 km/h (68mph) This bird can fly 109 km/ h (68mph); they are 53 to 59cm long. This bird always lives in group. 09.',
    'Where is Langley, BC? Location of Langley on a map. Langley is a city found in British Columbia, Canada. It is located 49.08 latitude and -122.59 longitude and it is situated at elevation 78 meters above sea level. Langley has a population of 93,726 making it the 13th biggest city in British Columbia.',
]
query_embeddings = model.encode_query(queries)
document_embeddings = model.encode_document(documents)
print(query_embeddings.shape, document_embeddings.shape)
# [1, 30522] [3, 30522]

# Get the similarity scores for the embeddings
similarities = model.similarity(query_embeddings, document_embeddings)
print(similarities)
# tensor([[35.7080, 24.5349,  3.8619]])

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

Evaluation

Metrics

Sparse Information Retrieval

• Datasets: NanoMSMARCO, NanoNFCorpus, NanoNQ, NanoClimateFEVER, NanoDBPedia, NanoFEVER, NanoFiQA2018, NanoHotpotQA, NanoMSMARCO, NanoNFCorpus, NanoNQ, NanoQuoraRetrieval, NanoSCIDOCS, NanoArguAna, NanoSciFact and NanoTouche2020
• Evaluated with <code>SparseInformationRetrievalEvaluator</code>

Sparse Nano BEIR

• Dataset: NanoBEIR_mean
• Evaluated with <code>SparseNanoBEIREvaluator</code> with these parameters:

  {
      "dataset_names": [
          "msmarco",
          "nfcorpus",
          "nq"
      ]
  }
  

Sparse Nano BEIR

• Dataset: NanoBEIR_mean
• Evaluated with <code>SparseNanoBEIREvaluator</code> with these parameters:

  {
      "dataset_names": [
          "climatefever",
          "dbpedia",
          "fever",
          "fiqa2018",
          "hotpotqa",
          "msmarco",
          "nfcorpus",
          "nq",
          "quoraretrieval",
          "scidocs",
          "arguana",
          "scifact",
          "touche2020"
      ]
  }
  

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

msmarco

• Dataset: msmarco at 9e329ed
• Size: 90,000 training samples
• Columns: <code>score</code>, <code>query</code>, <code>positive</code>, and <code>negative</code>
• Approximate statistics based on the first 1000 samples:

  	score	query	positive	negative
  type	float	string	string	string
  details	<ul><li>min: -3.66</li><li>mean: 12.97</li><li>max: 22.48</li></ul>	<ul><li>min: 4 tokens</li><li>mean: 8.89 tokens</li><li>max: 24 tokens</li></ul>	<ul><li>min: 16 tokens</li><li>mean: 80.61 tokens</li><li>max: 256 tokens</li></ul>	<ul><li>min: 18 tokens</li><li>mean: 78.92 tokens</li><li>max: 250 tokens</li></ul>

• Samples:

  score	query	positive	negative
  <code>2.1688317457834883</code>	<code>what is ast test used for</code>	<code>The AST test is commonly used to check for liver diseases. It is usually measured together with alanine aminotransferase (ALT). The AST to ALT ratio can help your doctor diagnose liver disease. Symptoms of liver disease that may cause your doctor to order an AST test include: 1 fatigue. 2 weakness.3 loss of appetite.t is usually measured together with alanine aminotransferase (ALT). The AST to ALT ratio can help your doctor diagnose liver disease. Symptoms of liver disease that may cause your doctor to order an AST test include: 1 fatigue. 2 weakness. 3 loss of appetite.</code>	<code>An aspartate aminotransferase (AST) test measures the amount of this enzyme in the blood. AST is normally found in red blood cells, liver, heart, muscle tissue, pancreas, and kidneys. AST formerly was called serum glutamic oxaloacetic transaminase (SGOT).he amount of AST in the blood is directly related to the extent of the tissue damage. After severe damage, AST levels rise in 6 to 10 hours and remain high for about 4 days. The AST test may be done at the same time as a test for alanine aminotransferase, or ALT.</code>
  <code>12.405409197012585</code>	<code>what does the suspensory ligament do when the cillary muscles contract</code>	<code>Suspensory Ligaments of the Ciliary Body: The suspensory ligaments of the ciliary body are ligaments that attach the ciliary body to the lens of the eye. Suspensory ligaments enable the ciliary body to change the shape of the lens as needed to focus light reflected from objects at different distances from the eye.</code>	<code>Ossification of the posterior longitudinal ligament of the spine: Introduction. Ossification of the posterior longitudinal ligament of the spine: Abnormal calcification of a spinal ligament. The progressive calcification can starts within months of birth and affects the ability to move arms and legs.ssification of the posterior longitudinal ligament of the spine: Introduction. Ossification of the posterior longitudinal ligament of the spine: Abnormal calcification of a spinal ligament. The progressive calcification can starts within months of birth and affects the ability to move arms and legs.</code>
  <code>19.407212177912392</code>	<code>how many kids does trump have</code>	<code>Donald Trump has 5 children: Donald Jr., Eric, and Ivanka- mother Ivana Trump Tiffany -mother Marla Maples Barron-mother Malania Trump Donald Trump Jr. has 2 children: … Kai Madison Trump and Donald Trump III.</code>	<code>Copyright © 2018, Trump Make America Great Again Committee. Paid for by Trump Make America Great Again Committee, a joint fundraising committee authorized by and composed of Donald J. Trump for President, Inc. and the Republican National Committee. x Close</code>

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

  {
      "loss": "SparseMarginMSELoss",
      "lambda_corpus": 0.08,
      "lambda_query": 0.1
  }
  

Evaluation Dataset

msmarco

• Dataset: msmarco at 9e329ed
• Size: 10,000 evaluation samples
• Columns: <code>score</code>, <code>query</code>, <code>positive</code>, and <code>negative</code>
• Approximate statistics based on the first 1000 samples:

  	score	query	positive	negative
  type	float	string	string	string
  details	<ul><li>min: -4.07</li><li>mean: 13.12</li><li>max: 22.25</li></ul>	<ul><li>min: 4 tokens</li><li>mean: 8.96 tokens</li><li>max: 33 tokens</li></ul>	<ul><li>min: 13 tokens</li><li>mean: 80.54 tokens</li><li>max: 220 tokens</li></ul>	<ul><li>min: 17 tokens</li><li>mean: 78.41 tokens</li><li>max: 242 tokens</li></ul>

• Samples:

  score	query	positive	negative
  <code>11.227776050567627</code>	<code>tabernacle definition</code>	<code>Wiktionary(0.00 / 0 votes)Rate this definition: tabernacle(Noun) any temporary dwelling, a hut, tent, booth. tabernacle(Noun) (Old Testament) The portable tent used before the construction of the temple, where the shekinah (presence of God) was believed to dwell. 1611 ... So Moses finished the work. Then a cloud covered the tent of the congregation, and the glory of the LORD filled the tabernacle.</code>	<code>Both the Annunciation tabernacle in Santa Croce and the Cantoria (the singer's pulpit) in the Duomo (now in the Museo dell'Opera del Duomo) show a vastly increased repertory of forms derived from ancient art, the harvest of Donatello's long stay in Rome (1430-33).</code>
  <code>12.354041655858357</code>	<code>what scientist discovered radiation</code>	<code>Becquerel used an apparatus similar to that displayed below to show that the radiation he discovered could not be x-rays. X-rays are neutral and cannot be bent in a magnetic field. The new radiation was bent by the magnetic field so that the radiation must be charged and different than x-rays.</code>	<code>5a-Hydroxy Laxogenin. 5a-Hydroxy Laxogenin was discovered by a American scientist in 1996. It was shown to possess an anabolic/androgenic ratio similar to one of the most efficient anabolic substances, in particular Anavar but without the side effects of liver toxicity or testing positive for steroidal therapy.</code>
  <code>11.721514344215393</code>	<code>are horses primates</code>	<code>Primates still do, but many, if not most, mammals do not. Horses, deer, cows and many other mammals have a reduced number of digits on their forelimbs and hindlimbs. Primates also retain other generalized skeletal features like the clavicle or collar bone.</code>	<code>The only primates that live in Canada are humans. The species originated in east Africa and is unrelated to South American primates. Humans first arrived in large numbers to Canada around 15,000 years ago from North Asia, and surged in migration starting 400 years ago from around the world, especially from Europe.</code>

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

  {
      "loss": "SparseMarginMSELoss",
      "lambda_corpus": 0.08,
      "lambda_query": 0.1
  }
  

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
• bf16: True
• load_best_model_at_end: True

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: True
• 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: 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}
• tp_size: 0
• 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
• router_mapping: {}
• learning_rate_mapping: {}

</details>

Training Logs

• The bold row denotes the saved checkpoint.

Environmental Impact

Carbon emissions were measured using CodeCarbon.

• Energy Consumed: 0.093 kWh
• Carbon Emitted: 0.034 kg of CO2
• Hours Used: 0.305 hours

Training Hardware

• On Cloud: No
• GPU Model: 1 x NVIDIA H100 80GB HBM3
• CPU Model: AMD EPYC 7R13 Processor
• RAM Size: 248.00 GB

Framework Versions

• Python: 3.13.3
• Sentence Transformers: 4.2.0.dev0
• Transformers: 4.51.3
• PyTorch: 2.7.1+cu126
• Accelerate: 0.26.0
• Datasets: 2.21.0
• Tokenizers: 0.21.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",
}

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

SparseMarginMSELoss

@misc{hofstätter2021improving,
    title={Improving Efficient Neural Ranking Models with Cross-Architecture Knowledge Distillation},
    author={Sebastian Hofstätter and Sophia Althammer and Michael Schröder and Mete Sertkan and Allan Hanbury},
    year={2021},
    eprint={2010.02666},
    archivePrefix={arXiv},
    primaryClass={cs.IR}
}

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