CrossEncoder based on cross-encoder/mmarco-mMiniLMv2-L12-H384-v1

This is a Cross Encoder model finetuned from cross-encoder/mmarco-mMiniLMv2-L12-H384-v1 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: cross-encoder/mmarco-mMiniLMv2-L12-H384-v1
• 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': 'XLMRobertaForSequenceClassification'})
)

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 = [
    ['Bangalore South Automotive Private Limited | C-901, Goyalco Orchid, Lakeview, Bangalore South, Bangalore, Karnataka', 'Bangalore South Automotive Infratech Private  Ltd | C-905, GOYALCO ORCHID, LAKEVIEW, BANGALORE SOUTH, Karnataka'],
    ['Bangalore South Automotive Private Limited | C-901, Goyalco Orchid, Lakeview, Bangalore South, Bangalore, Karnataka', 'OWA Cafe LLP | A-1206, 12TH FLOOR, GOYALCO ORCHID LAKEVIEW, BANGALORE SOUTH, ಕರ್ನಾಟಕ'],
    ['IMY India Company | Plot No. 3, 3Rd Floor, Road No G7, Dlf Phase-1, Gurgaon Kty., Gurgaon, Haryana', 'IMY  India Company | PLTO NO. ##3 , 3RD FLOOR, ROAD NO G7, DLF PHASE-1, GURGAON KTY., हरियाणा'],
    ['IMY India Company | Plot No. 3, 3Rd Floor, Road No G7, Dlf Phase-1, Gurgaon Kty., Gurgaon, Haryana', 'IMY India Co | SHOP302, FORTUNEALEXA, OPP., KADAMHEIGHT, 150FTRINGRD-2, RAJKOT, Gujarat'],
    ['Software Pinnacle Tourism | 3016/5, 1St Floor, Ranjit Nagar, New Delhi, Central Delhi, Delhi', 'Software Pinnacle Tóurism | A-3016/5, 1ST FLOOR, RANJIT NAGAR, NEW DELHI, दिल्ली'],
]
scores = model.predict(pairs)
print(scores)
# [-11.7818 -11.8389  11.1288 -11.8149  11.103 ]

# Or rank different texts based on similarity to a single text
ranks = model.rank(
    'Bangalore South Automotive Private Limited | C-901, Goyalco Orchid, Lakeview, Bangalore South, Bangalore, Karnataka',
    [
        'Bangalore South Automotive Infratech Private  Ltd | C-905, GOYALCO ORCHID, LAKEVIEW, BANGALORE SOUTH, Karnataka',
        'OWA Cafe LLP | A-1206, 12TH FLOOR, GOYALCO ORCHID LAKEVIEW, BANGALORE SOUTH, ಕರ್ನಾಟಕ',
        'IMY  India Company | PLTO NO. ##3 , 3RD FLOOR, ROAD NO G7, DLF PHASE-1, GURGAON KTY., हरियाणा',
        'IMY India Co | SHOP302, FORTUNEALEXA, OPP., KADAMHEIGHT, 150FTRINGRD-2, RAJKOT, Gujarat',
        'Software Pinnacle Tóurism | A-3016/5, 1ST FLOOR, RANJIT NAGAR, NEW DELHI, दिल्ली',
    ]
)
# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]

Evaluation

Metrics

Cross Encoder Classification

• Dataset: ce-val
• Evaluated with CrossEncoderClassificationEvaluator

Training Details

Training Dataset

Unnamed Dataset

• Size: 3,299,295 training samples
• Columns: text1, text2, and label
• Approximate statistics based on the first 100 samples:

  	text1	text2	label
  type	string	string	float
  modality	text	text
  details	min: 24 tokensmean: 36.35 tokensmax: 45 tokens	min: 12 tokensmean: 44.4 tokensmax: 72 tokens	min: 0.0mean: 0.2max: 1.0

• Samples:

  text1	text2	label
  Bangalore South Automotive Private Limited | C-901, Goyalco Orchid, Lakeview, Bangalore South, Bangalore, Karnataka	Bangalore South Automotive Limited Private | C-901., GOYALCO ORCHID, LAKEVIEW, BANGALORE SOUTH, ಕರ್ನಾಟಕ	1.0
  Bangalore South Automotive Private Limited | C-901, Goyalco Orchid, Lakeview, Bangalore South, Bangalore, Karnataka	Bangalore Sóuth Automotive Private Limited |	1.0
  Bangalore South Automotive Private Limited | C-901, Goyalco Orchid, Lakeview, Bangalore South, Bangalore, Karnataka	SOUTH AUTOMOTIVE PRIVATE LIMITED | A-71/2, HARI NAGAR, ASHRAM, NEW DELHI, Delhi	0.0

• Loss: BinaryCrossEntropyLoss with these parameters:

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

Evaluation Dataset

Unnamed Dataset

• Size: 366,241 evaluation samples
• Columns: text1, text2, and label
• Approximate statistics based on the first 100 samples:

  	text1	text2	label
  type	string	string	float
  modality	text	text
  details	min: 16 tokensmean: 36.73 tokensmax: 63 tokens	min: 12 tokensmean: 43.76 tokensmax: 74 tokens	min: 0.0mean: 0.14max: 1.0

• Samples:

  text1	text2	label
  Bangalore South Automotive Private Limited | C-901, Goyalco Orchid, Lakeview, Bangalore South, Bangalore, Karnataka	Bangalore South Automotive Infratech Private Ltd | C-905, GOYALCO ORCHID, LAKEVIEW, BANGALORE SOUTH, Karnataka	0.0
  Bangalore South Automotive Private Limited | C-901, Goyalco Orchid, Lakeview, Bangalore South, Bangalore, Karnataka	OWA Cafe LLP | A-1206, 12TH FLOOR, GOYALCO ORCHID LAKEVIEW, BANGALORE SOUTH, ಕರ್ನಾಟಕ	0.0
  IMY India Company | Plot No. 3, 3Rd Floor, Road No G7, Dlf Phase-1, Gurgaon Kty., Gurgaon, Haryana	IMY India Company | PLTO NO. ##3 , 3RD FLOOR, ROAD NO G7, DLF PHASE-1, GURGAON KTY., हरियाणा	1.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: 64
• num_train_epochs: 2
• learning_rate: 2e-05
• warmup_steps: 0.1
• per_device_eval_batch_size: 64
• load_best_model_at_end: True

All Hyperparameters

• per_device_train_batch_size: 64
• num_train_epochs: 2
• max_steps: -1
• learning_rate: 2e-05
• lr_scheduler_type: linear
• lr_scheduler_kwargs: None
• warmup_steps: 0.1
• 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: False
• project: huggingface
• trackio_space_id: None
• trackio_bucket_id: None
• trackio_static_space_id: None
• per_device_eval_batch_size: 64
• 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
• dataloader_multiprocessing_context: None
• dataloader_in_order: True
• 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
• local_rank: -1
• prompts: None
• batch_sampler: batch_sampler
• multi_dataset_batch_sampler: proportional
• router_mapping: {}
• learning_rate_mapping: {}
• warmup_ratio: None

Training Logs