CrossEncoder

This is a Cross Encoder model trained 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

• Maximum Sequence Length: 512 tokens
• Number of Output Labels: 1 label
• Supported Modality: Text

Model Sources

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

Full Model Architecture

CrossEncoder(
  (0): Transformer({'transformer_task': 'sequence-classification', 'modality_config': {'text': {'method': 'forward', 'method_output_name': 'logits'}}, 'module_output_name': 'scores', 'architecture': 'BertForSequenceClassification'})
)

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("cross_encoder_model_id")
# Get scores for pairs of inputs
pairs = [
    ['best way to cook turkey legs', 'The best way to bake chicken legs is to pat them dry, season generously, and bake at 400°F (200°C) for 40-45 minutes. For extra crispiness, start them at a higher temperature (425°F) for the first 20 minutes, then lower to 375°F until the internal temperature reaches 165°F.'],
    ['best way to burn belly fat', "You cannot spot-reduce stomach fat; the most effective approach combines full-body strength training (like squats, deadlifts, and push-ups) with high-intensity interval training (HIIT) and a calorie-controlled diet. Core exercises like planks and Russian twists build muscle but won't burn the fat on top of them. Prioritize compound movements and consistent cardio to lower overall body fat."],
    ['crockpot pork tenderloin slow cooker recipes', 'For the best crock pot pork carnitas, season a pork shoulder (or butt) with cumin, oregano, garlic, salt, and pepper, then cook on low for 8-10 hours with orange juice, lime juice, and bay leaves until fall-apart tender. After shredding, spread the meat on a baking sheet and broil for 5-10 minutes to get crispy, golden edges before serving.'],
    ['bed bath and beyond schaumburg', "Bed Bath & Beyond operated in Canada until its closures in 2023, when all Canadian stores and its e-commerce site were shut down following the company's bankruptcy. The Canadian business was acquired by a private equity firm but ultimately liquidated, so there are no remaining Bed Bath & Beyond locations in Canada."],
    ['brother printer download for windows 10', 'Try reinstalling the printer driver from Brother\'s official support site, as Windows 10 often needs the specific "Full Driver & Software Package" instead of the basic driver. If it\'s a USB connection, unplug the cable, restart both the printer and PC, then reconnect; for network printers, run the Brother "Printer Setting Tool" or check that the IP address hasn\'t changed. Also, run the Windows built-in "Printer troubleshooter" (Settings > Update & Security > Troubleshoot) to auto-detect and fix common issues.'],
]
scores = model.predict(pairs)
print(scores)
# [-1.6193  1.0399 -0.3764 -1.8634  0.1748]

# Or rank different texts based on similarity to a single text
ranks = model.rank(
    'best way to cook turkey legs',
    [
        'The best way to bake chicken legs is to pat them dry, season generously, and bake at 400°F (200°C) for 40-45 minutes. For extra crispiness, start them at a higher temperature (425°F) for the first 20 minutes, then lower to 375°F until the internal temperature reaches 165°F.',
        "You cannot spot-reduce stomach fat; the most effective approach combines full-body strength training (like squats, deadlifts, and push-ups) with high-intensity interval training (HIIT) and a calorie-controlled diet. Core exercises like planks and Russian twists build muscle but won't burn the fat on top of them. Prioritize compound movements and consistent cardio to lower overall body fat.",
        'For the best crock pot pork carnitas, season a pork shoulder (or butt) with cumin, oregano, garlic, salt, and pepper, then cook on low for 8-10 hours with orange juice, lime juice, and bay leaves until fall-apart tender. After shredding, spread the meat on a baking sheet and broil for 5-10 minutes to get crispy, golden edges before serving.',
        "Bed Bath & Beyond operated in Canada until its closures in 2023, when all Canadian stores and its e-commerce site were shut down following the company's bankruptcy. The Canadian business was acquired by a private equity firm but ultimately liquidated, so there are no remaining Bed Bath & Beyond locations in Canada.",
        'Try reinstalling the printer driver from Brother\'s official support site, as Windows 10 often needs the specific "Full Driver & Software Package" instead of the basic driver. If it\'s a USB connection, unplug the cable, restart both the printer and PC, then reconnect; for network printers, run the Brother "Printer Setting Tool" or check that the IP address hasn\'t changed. Also, run the Windows built-in "Printer troubleshooter" (Settings > Update & Security > Troubleshoot) to auto-detect and fix common issues.',
    ]
)
# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]

Training Details

Training Dataset

Unnamed Dataset

• Size: 60,398 training samples
• Columns: query, response, and label
• Approximate statistics based on the first 100 samples:

  	query	response	label
  type	string	string	float
  modality	text	text
  details	min: 7 tokensmean: 8.26 tokensmax: 13 tokens	min: 31 tokensmean: 79.28 tokensmax: 150 tokens	min: 0.0mean: 0.19max: 1.0

• Samples:

  query	response	label
  best way to cook turkey legs	The best way to bake chicken legs is to pat them dry, season generously, and bake at 400°F (200°C) for 40-45 minutes. For extra crispiness, start them at a higher temperature (425°F) for the first 20 minutes, then lower to 375°F until the internal temperature reaches 165°F.	0.0
  best way to burn belly fat	You cannot spot-reduce stomach fat; the most effective approach combines full-body strength training (like squats, deadlifts, and push-ups) with high-intensity interval training (HIIT) and a calorie-controlled diet. Core exercises like planks and Russian twists build muscle but won't burn the fat on top of them. Prioritize compound movements and consistent cardio to lower overall body fat.	0.0
  crockpot pork tenderloin slow cooker recipes	For the best crock pot pork carnitas, season a pork shoulder (or butt) with cumin, oregano, garlic, salt, and pepper, then cook on low for 8-10 hours with orange juice, lime juice, and bay leaves until fall-apart tender. After shredding, spread the meat on a baking sheet and broil for 5-10 minutes to get crispy, golden edges before serving.	0.0

• Loss: BinaryCrossEntropyLoss with these parameters:

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

Training Hyperparameters

Non-Default Hyperparameters

• per_device_train_batch_size: 16
• num_train_epochs: 1
• disable_tqdm: True

All Hyperparameters

• per_device_train_batch_size: 16
• num_train_epochs: 1
• max_steps: -1
• learning_rate: 5e-05
• lr_scheduler_type: linear
• lr_scheduler_kwargs: None
• warmup_steps: 0
• 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: False
• 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: True
• project: huggingface
• trackio_space_id: None
• trackio_bucket_id: None
• trackio_static_space_id: None
• per_device_eval_batch_size: 8
• 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: False
• 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: batch_sampler
• multi_dataset_batch_sampler: proportional
• router_mapping: {}
• learning_rate_mapping: {}

Training Logs

Training Time

• Training: 3.9 minutes

Framework Versions

• Python: 3.11.6
• Sentence Transformers: 5.6.1
• Transformers: 5.14.1
• PyTorch: 2.13.0+cu130
• Accelerate: 1.14.0
• Datasets: 5.0.0
• Tokenizers: 0.22.2

Additional Resources

• Training and Finetuning Reranker Models with Sentence Transformers: the end-to-end guide for training or finetuning Cross Encoder (reranker) models.
• Multimodal Embedding & Reranker Models with Sentence Transformers: use text, image, audio, and video reranker models through the same API.
• Training and Finetuning Multimodal Embedding & Reranker Models with Sentence Transformers: training multimodal Cross Encoders.

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