CoolFace
Modelpublic

pujithapsx/lora_bge_reranker_4114_indvl_nameandaddres

sourceHugging Faceupdated 6mo agoView on Hugging Face
0likes34downloads
Model Card

CrossEncoder based on BAAI/bge-reranker-v2-m3

This is a Cross Encoder model finetuned from BAAI/bge-reranker-v2-m3 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: BAAI/bge-reranker-v2-m3 <!-- at revision 953dc6f6f85a1b2dbfca4c34a2796e7dde08d41e -->
  • —Maximum Sequence Length: 512 tokens
  • —Number of Output Labels: 1 label <!-- - Training Dataset: Unknown --> <!-- - Language: Unknown --> <!-- - License: Unknown -->

Model Sources

Usage

Direct Usage (Sentence Transformers)

First install the Sentence Transformers library:

bash
pip install -U sentence-transformers

Then you can load this model and run inference.

python
from sentence_transformers import CrossEncoder

# Download from the 🤗 Hub
model = CrossEncoder("pujithapsx/lora_bge_reranker_4114_indvl_nameandaddres")
# Get scores for pairs of texts
pairs = [
    ['Shreyas', 'Shreyaas'],
    ['House 2A Sector 7 Faridabad', '2-A Sector 7 Faridabad'],
    ['BANKIMCHANDRACHATTOPADHYAY', 'BANKIM CHANDRA CHATTOPADHYAY'],
    ['Jaya Sree Reddy', 'Jaya Sree Patil'],
    ['Vill Rampur Azamgarh Uttar Pradesh', 'So/o Ram Prasad Vill Rampur Jaunpur Uttar Pradesh'],
]
scores = model.predict(pairs)
print(scores.shape)
# (5,)

# Or rank different texts based on similarity to a single text
ranks = model.rank(
    'Shreyas',
    [
        'Shreyaas',
        '2-A Sector 7 Faridabad',
        'BANKIM CHANDRA CHATTOPADHYAY',
        'Jaya Sree Patil',
        'So/o Ram Prasad Vill Rampur Jaunpur Uttar Pradesh',
    ]
)
# [{'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 Classification
MetricValue
accuracy0.94
accuracy_threshold0.5757
f10.9477
f1_threshold0.5757
precision0.9517
recall0.9437
average_precision0.9812

<!--

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

Unnamed Dataset
  • —Size: 2,467 training samples
  • —Columns: <code>sentence1</code>, <code>sentence2</code>, and <code>label</code>
  • —Approximate statistics based on the first 1000 samples: | | sentence1 | sentence2 | label | |:--------|:----------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------|:------------------------------------------------| | type | string | string | int | | details | <ul><li>min: 3 characters</li><li>mean: 31.09 characters</li><li>max: 98 characters</li></ul> | <ul><li>min: 4 characters</li><li>mean: 31.92 characters</li><li>max: 106 characters</li></ul> | <ul><li>0: ~44.20%</li><li>1: ~55.80%</li></ul> |
  • —Samples: | sentence1 | sentence2 | label | |:-------------------------------------------------------------------|:--------------------------------------|:---------------| | <code>Riddhi Kapoor</code> | <code>Riddhi Bhardwaj</code> | <code>0</code> | | <code>House 6 Kharagpur Village Post Kharagpur Munger Bihar</code> | <code>Kharagpur Village Munger</code> | <code>1</code> | | <code>Akhil Prashant</code> | <code>Nikhil Prashant</code> | <code>0</code> |
  • —Loss: <code>BinaryCrossEntropyLoss</code> with these parameters:
json
  {
      "activation_fn": "torch.nn.modules.linear.Identity",
      "pos_weight": null
  }

Evaluation Dataset

Unnamed Dataset
  • —Size: 617 evaluation samples
  • —Columns: <code>sentence1</code>, <code>sentence2</code>, and <code>label</code>
  • —Approximate statistics based on the first 617 samples: | | sentence1 | sentence2 | label | |:--------|:----------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------|:------------------------------------------------| | type | string | string | int | | details | <ul><li>min: 4 characters</li><li>mean: 30.02 characters</li><li>max: 81 characters</li></ul> | <ul><li>min: 4 characters</li><li>mean: 31.57 characters</li><li>max: 91 characters</li></ul> | <ul><li>0: ~42.46%</li><li>1: ~57.54%</li></ul> |
  • —Samples: | sentence1 | sentence2 | label | |:-----------------------------------------|:------------------------------------------|:---------------| | <code>Shreyas</code> | <code>Shreyaas</code> | <code>1</code> | | <code>House 2A Sector 7 Faridabad</code> | <code>2-A Sector 7 Faridabad</code> | <code>1</code> | | <code>BANKIMCHANDRACHATTOPADHYAY</code> | <code>BANKIM CHANDRA CHATTOPADHYAY</code> | <code>1</code> |
  • —Loss: <code>BinaryCrossEntropyLoss</code> with these parameters:
json
  {
      "activation_fn": "torch.nn.modules.linear.Identity",
      "pos_weight": null
  }

Training Hyperparameters

Non-Default Hyperparameters
  • —eval_strategy: steps
  • —per_device_train_batch_size: 6
  • —gradient_accumulation_steps: 4
  • —learning_rate: 2e-05
  • —weight_decay: 0.01
  • —warmup_ratio: 0.1
  • —no_cuda: True
  • —use_cpu: True
  • —dataloader_num_workers: 31
  • —dataloader_prefetch_factor: 2
  • —load_best_model_at_end: True
  • —dataloader_pin_memory: False
  • —dataloader_persistent_workers: 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: 6
  • —per_device_eval_batch_size: 8
  • —per_gpu_train_batch_size: None
  • —per_gpu_eval_batch_size: None
  • —gradient_accumulation_steps: 4
  • —eval_accumulation_steps: None
  • —torch_empty_cache_steps: None
  • —learning_rate: 2e-05
  • —weight_decay: 0.01
  • —adam_beta1: 0.9
  • —adam_beta2: 0.999
  • —adam_epsilon: 1e-08
  • —max_grad_norm: 1.0
  • —num_train_epochs: 3
  • —max_steps: -1
  • —lr_scheduler_type: linear
  • —lr_scheduler_kwargs: None
  • —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: True
  • —use_cpu: True
  • —use_mps_device: False
  • —seed: 42
  • —data_seed: None
  • —jit_mode_eval: False
  • —bf16: False
  • —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: 31
  • —dataloader_prefetch_factor: 2
  • —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: {'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}
  • —parallelism_config: None
  • —deepspeed: None
  • —label_smoothing_factor: 0.0
  • —optim: adamwtorchfused
  • —optim_args: None
  • —adafactor: False
  • —group_by_length: False
  • —length_column_name: length
  • —project: huggingface
  • —trackio_space_id: trackio
  • —ddp_find_unused_parameters: None
  • —ddp_bucket_cap_mb: None
  • —ddp_broadcast_buffers: False
  • —dataloader_pin_memory: False
  • —dataloader_persistent_workers: True
  • —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: no
  • —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: True
  • —prompts: None
  • —batch_sampler: batch_sampler
  • —multi_dataset_batch_sampler: proportional
  • —router_mapping: {}
  • —learning_rate_mapping: {}

</details>

Training Logs

EpochStepTraining LossValidation Lossrich-entity-matching-lora_average_precision
0.5922610.4508--
1.18451220.3143--
1.77671830.2789--
1.9903205-0.18460.9812
2.36892440.2108--
2.96123050.2273--

Framework Versions

  • —Python: 3.10.12
  • —Sentence Transformers: 5.3.0
  • —Transformers: 4.57.6
  • —PyTorch: 2.10.0+cu128
  • —Accelerate: 1.13.0
  • —Datasets: 4.8.4
  • —Tokenizers: 0.22.2

Citation

BibTeX

Sentence Transformers
bibtex
@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. -->