reranker-ettin-encoder-1b-msmarco-bce-10m

CrossEncoder based on jhu-clsp/ettin-encoder-1b

This is a Cross Encoder model finetuned from jhu-clsp/ettin-encoder-1b on the msmarco dataset using the sentence-transformers library. It computes scores for pairs of texts, which can be used for text reranking and semantic search.

Model Details

Model Description

• Model Type: Cross Encoder
• Base model: jhu-clsp/ettin-encoder-1b <!-- at revision befd76be43d08b89ff9957012f3ff29d0842780b -->
• Maximum Sequence Length: 7999 tokens
• Number of Output Labels: 1 label
• Training Dataset:
  • msmarco
• Language: en

<!-- - **License:** Unknown -->

Model Sources

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

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 CrossEncoder

# Download from the 🤗 Hub
model = CrossEncoder("kdhole/reranker-ettin-encoder-1b-msmarco-bce-10m")
# Get scores for pairs of texts
pairs = [
    ['what is the zip code for hamilton nj', 'Stats and Demographics for the 21227 ZIP Code. ZIP code 21227 is located in Maryland and covers a slightly less than average land area compared to other ZIP codes in the United States. It also has a slightly larger than average population density.n addition to the primary city for a ZIP code, USPS also publishes a list of other acceptable cities that can be used with ZIP code 21227. However, if you are mailing something to ZIP code 21227, you should not use any of the cities listed as unacceptable.'],
    ['which cooking oil is healthy', "Photo Credit bgfoto126/iStock/Getty Images. Olive oil may get all the press, but safflower oil is emerging as a health superstar in its own right. Made from the seeds of safflowers, which are similar to sunflowers, this oil contains healthy fats and may even help prevent cardiovascular disease.All oils are pure fat, however, which means they're high in calories.hoto Credit bgfoto126/iStock/Getty Images. Olive oil may get all the press, but safflower oil is emerging as a health superstar in its own right. Made from the seeds of safflowers, which are similar to sunflowers, this oil contains healthy fats and may even help prevent cardiovascular disease."],
    ['what canadian cities have the highest crime rates?', 'Saginaw, TX Tarrant County crime report and crime data. Compare the rate to other cities, state average, and national average.'],
    ['how to delete bcc', 'How to delete the CC/BCC rule. 1  Open Auto BCC dialog box. 2  Select the rule you need in the list and click the Delete button on the top toolbar or the Delete key on your keyboard. 3  Confirm deletion and click Ok to save changes.'],
    ['what county is waukegan illinois in?', 'Downtown Waukegan is the urban center of Lake County. Many restaurants, bars, shops, the Waukegan Public Library, the College of Lake County, the Lake County Courthouse (including the William D. Block Memorial Law Library), and much more call Downtown Waukegan their home.'],
]
scores = model.predict(pairs)
print(scores.shape)
# (5,)

# Or rank different texts based on similarity to a single text
ranks = model.rank(
    'what is the zip code for hamilton nj',
    [
        'Stats and Demographics for the 21227 ZIP Code. ZIP code 21227 is located in Maryland and covers a slightly less than average land area compared to other ZIP codes in the United States. It also has a slightly larger than average population density.n addition to the primary city for a ZIP code, USPS also publishes a list of other acceptable cities that can be used with ZIP code 21227. However, if you are mailing something to ZIP code 21227, you should not use any of the cities listed as unacceptable.',
        "Photo Credit bgfoto126/iStock/Getty Images. Olive oil may get all the press, but safflower oil is emerging as a health superstar in its own right. Made from the seeds of safflowers, which are similar to sunflowers, this oil contains healthy fats and may even help prevent cardiovascular disease.All oils are pure fat, however, which means they're high in calories.hoto Credit bgfoto126/iStock/Getty Images. Olive oil may get all the press, but safflower oil is emerging as a health superstar in its own right. Made from the seeds of safflowers, which are similar to sunflowers, this oil contains healthy fats and may even help prevent cardiovascular disease.",
        'Saginaw, TX Tarrant County crime report and crime data. Compare the rate to other cities, state average, and national average.',
        'How to delete the CC/BCC rule. 1  Open Auto BCC dialog box. 2  Select the rule you need in the list and click the Delete button on the top toolbar or the Delete key on your keyboard. 3  Confirm deletion and click Ok to save changes.',
        'Downtown Waukegan is the urban center of Lake County. Many restaurants, bars, shops, the Waukegan Public Library, the College of Lake County, the Lake County Courthouse (including the William D. Block Memorial Law Library), and much more call Downtown Waukegan their home.',
    ]
)
# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]

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

Cross Encoder Reranking

• Datasets: NanoMSMARCO_R100, NanoNFCorpus_R100 and NanoNQ_R100
• Evaluated with <code>CrossEncoderRerankingEvaluator</code> with these parameters:

  {
      "at_k": 10,
      "always_rerank_positives": true
  }
  

Cross Encoder Nano BEIR

• Dataset: NanoBEIR_R100_mean
• Evaluated with <code>CrossEncoderNanoBEIREvaluator</code> with these parameters:

  {
      "dataset_names": [
          "msmarco",
          "nfcorpus",
          "nq"
      ],
      "rerank_k": 100,
      "at_k": 10,
      "always_rerank_positives": true
  }
  

<!-- ## 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: 9,960,000 training samples
• Columns: <code>query</code>, <code>passage</code>, and <code>score</code>
• Approximate statistics based on the first 1000 samples:

  	query	passage	score
  type	string	string	float
  details	<ul><li>min: 10 characters</li><li>mean: 33.92 characters</li><li>max: 156 characters</li></ul>	<ul><li>min: 80 characters</li><li>mean: 344.88 characters</li><li>max: 1061 characters</li></ul>	<ul><li>min: 0.0</li><li>mean: 0.48</li><li>max: 1.0</li></ul>

• Samples:

  query	passage	score
  <code>what is liquid resources</code>	<code>Renewable Resources. Renewable resources are resources that are replenished by the environment over relatively short periods of time. This type of resource is much more desirable to use because often a resource renews so fast that it will have regenerated by the time you've used it up.n contrast to renewable resources, non-renewable resources are resources that are not easily replenished by the environment. Let's think about this in terms of that ice cube maker again.</code>	<code>0.0</code>
  <code>halo laser treatment</code>	<code>Laser surgery (photocoagulation) With laser surgery, your ophthalmologist uses a laser to make small burns around the retinal tear. The scarring that results seals the retina to the underlying tissue, helping to prevent a retinal detachment. Freezing treatment (cryopexy)</code>	<code>0.0</code>
  <code>three motorcycle car</code>	<code>Can-Am Spyder roadster: three wheeled motorcycle. February 20, 2007 BRP has unveiled its first on-road vehicle, the 2008 Can-Am Spyder roadster. This three-wheel vehicle, with two wheels in the front and one in the rear, offers a completely new and stunning look. Powered by a proven 990cc V Twin engine designed and manufactured by BRP-Rotax, Spyder roadster, with its unique Y-architecture, can be described as part motorcycle and part convertible sports car.</code>	<code>1.0</code>

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

  {
      "activation_fn": "torch.nn.modules.linear.Identity",
      "pos_weight": null
  }
  

Evaluation Dataset

msmarco

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

  	query	passage	score
  type	string	string	float
  details	<ul><li>min: 12 characters</li><li>mean: 34.65 characters</li><li>max: 132 characters</li></ul>	<ul><li>min: 65 characters</li><li>mean: 345.56 characters</li><li>max: 874 characters</li></ul>	<ul><li>min: 0.0</li><li>mean: 0.49</li><li>max: 1.0</li></ul>

• Samples:

  query	passage	score
  <code>what is the zip code for hamilton nj</code>	<code>Stats and Demographics for the 21227 ZIP Code. ZIP code 21227 is located in Maryland and covers a slightly less than average land area compared to other ZIP codes in the United States. It also has a slightly larger than average population density.n addition to the primary city for a ZIP code, USPS also publishes a list of other acceptable cities that can be used with ZIP code 21227. However, if you are mailing something to ZIP code 21227, you should not use any of the cities listed as unacceptable.</code>	<code>0.0</code>
  <code>which cooking oil is healthy</code>	<code>Photo Credit bgfoto126/iStock/Getty Images. Olive oil may get all the press, but safflower oil is emerging as a health superstar in its own right. Made from the seeds of safflowers, which are similar to sunflowers, this oil contains healthy fats and may even help prevent cardiovascular disease.All oils are pure fat, however, which means they're high in calories.hoto Credit bgfoto126/iStock/Getty Images. Olive oil may get all the press, but safflower oil is emerging as a health superstar in its own right. Made from the seeds of safflowers, which are similar to sunflowers, this oil contains healthy fats and may even help prevent cardiovascular disease.</code>	<code>0.0</code>
  <code>what canadian cities have the highest crime rates?</code>	<code>Saginaw, TX Tarrant County crime report and crime data. Compare the rate to other cities, state average, and national average.</code>	<code>0.0</code>

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

  {
      "activation_fn": "torch.nn.modules.linear.Identity",
      "pos_weight": null
  }
  

Training Hyperparameters

Non-Default Hyperparameters

• eval_strategy: steps
• per_device_train_batch_size: 64
• per_device_eval_batch_size: 64
• learning_rate: 2e-05
• num_train_epochs: 1
• warmup_ratio: 0.1
• seed: 12
• bf16: True
• dataloader_num_workers: 4
• 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: 64
• per_device_eval_batch_size: 64
• 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: 12
• 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: 4
• 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}
• 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: proportional
• router_mapping: {}
• learning_rate_mapping: {}

</details>

Training Logs

• The bold row denotes the saved checkpoint.

Framework Versions

• Python: 3.9.18
• Sentence Transformers: 5.1.1
• Transformers: 4.56.2
• PyTorch: 2.8.0+cu128
• Accelerate: 1.10.1
• Datasets: 4.1.1
• Tokenizers: 0.22.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",
}

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