Text Ranking
sentence-transformers
Safetensors
xlm-roberta
cross-encoder
reranker
Generated from Trainer
dataset_size:2879
loss:BinaryCrossEntropyLoss
Eval Results (legacy)
text-embeddings-inference
Instructions to use pujithapsx/test_fine_flow with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- sentence-transformers
How to use pujithapsx/test_fine_flow with sentence-transformers:
from sentence_transformers import CrossEncoder model = CrossEncoder("pujithapsx/test_fine_flow") query = "Which planet is known as the Red Planet?" passages = [ "Venus is often called Earth's twin because of its similar size and proximity.", "Mars, known for its reddish appearance, is often referred to as the Red Planet.", "Jupiter, the largest planet in our solar system, has a prominent red spot.", "Saturn, famous for its rings, is sometimes mistaken for the Red Planet." ] scores = model.predict([(query, passage) for passage in passages]) print(scores) - Notebooks
- Google Colab
- Kaggle
metadata
tags:
- sentence-transformers
- cross-encoder
- reranker
- generated_from_trainer
- dataset_size:2879
- loss:BinaryCrossEntropyLoss
base_model: BAAI/bge-reranker-v2-m3
pipeline_tag: text-ranking
library_name: sentence-transformers
metrics:
- accuracy
- accuracy_threshold
- f1
- f1_threshold
- precision
- recall
- average_precision
model-index:
- name: CrossEncoder based on BAAI/bge-reranker-v2-m3
results:
- task:
type: cross-encoder-classification
name: Cross Encoder Classification
dataset:
name: entity matching
type: entity-matching
metrics:
- type: accuracy
value: 0.8525121555915721
name: Accuracy
- type: accuracy_threshold
value: 0.44037526845932007
name: Accuracy Threshold
- type: f1
value: 0.8783068783068781
name: F1
- type: f1_threshold
value: 0.3608097732067108
name: F1 Threshold
- type: precision
value: 0.827930174563591
name: Precision
- type: recall
value: 0.9352112676056338
name: Recall
- type: average_precision
value: 0.9356992398880613
name: Average Precision
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
- Maximum Sequence Length: 64 tokens
- Number of Output Labels: 1 label
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("pujithapsx/test_fine_flow")
# Get scores for pairs of texts
pairs = [
['Yamini Durga Fernandes', 'Roy Yamini Durga'],
['C/O Ramesh Yadav Village Bairiya Post Bairiya Ballia', 'Village Bairiya C/O Ramesh Yadav Post Bairiya Ballia'],
['Flat 5 Lotus Tower Brigade Road Bengaluru', 'Flat 6 Lotus Tower Brigade Road Bangalore'],
['House 7 Tinsukia Village Post Tinsukia Assam Assam', 'Tinsukia Village Assam'],
['Rudra', 'Rudhraa'],
]
scores = model.predict(pairs)
print(scores.shape)
# (5,)
# Or rank different texts based on similarity to a single text
ranks = model.rank(
'Yamini Durga Fernandes',
[
'Roy Yamini Durga',
'Village Bairiya C/O Ramesh Yadav Post Bairiya Ballia',
'Flat 6 Lotus Tower Brigade Road Bangalore',
'Tinsukia Village Assam',
'Rudhraa',
]
)
# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]
Evaluation
Metrics
Cross Encoder Classification
- Dataset:
entity-matching - Evaluated with
CrossEncoderClassificationEvaluator
| Metric | Value |
|---|---|
| accuracy | 0.8525 |
| accuracy_threshold | 0.4404 |
| f1 | 0.8783 |
| f1_threshold | 0.3608 |
| precision | 0.8279 |
| recall | 0.9352 |
| average_precision | 0.9357 |
Training Details
Training Dataset
Unnamed Dataset
- Size: 2,879 training samples
- Columns:
sentence1,sentence2, andlabel - Approximate statistics based on the first 1000 samples:
sentence1 sentence2 label type string string int details - min: 4 characters
- mean: 30.29 characters
- max: 90 characters
- min: 3 characters
- mean: 31.45 characters
- max: 106 characters
- 0: ~42.10%
- 1: ~57.90%
- Samples:
sentence1 sentence2 label Village Buxar BiharVillage Buxar Rohtas Bihar0DhruvDhruvi0Venkat Prakash VermaVenkat P Verma1 - Loss:
BinaryCrossEntropyLosswith these parameters:{ "activation_fn": "torch.nn.modules.linear.Identity", "pos_weight": null }
Evaluation Dataset
Unnamed Dataset
- Size: 617 evaluation samples
- Columns:
sentence1,sentence2, andlabel - Approximate statistics based on the first 617 samples:
sentence1 sentence2 label type string string int details - min: 4 characters
- mean: 30.88 characters
- max: 98 characters
- min: 4 characters
- mean: 31.67 characters
- max: 100 characters
- 0: ~42.46%
- 1: ~57.54%
- Samples:
sentence1 sentence2 label Yamini Durga FernandesRoy Yamini Durga0C/O Ramesh Yadav Village Bairiya Post Bairiya BalliaVillage Bairiya C/O Ramesh Yadav Post Bairiya Ballia1Flat 5 Lotus Tower Brigade Road BengaluruFlat 6 Lotus Tower Brigade Road Bangalore0 - Loss:
BinaryCrossEntropyLosswith these parameters:{ "activation_fn": "torch.nn.modules.linear.Identity", "pos_weight": null }
Training Hyperparameters
Non-Default Hyperparameters
eval_strategy: stepsper_device_train_batch_size: 256per_device_eval_batch_size: 32learning_rate: 2e-05weight_decay: 0.01num_train_epochs: 1warmup_ratio: 0.1use_cpu: Truebf16: Truehalf_precision_backend: cpu_ampload_best_model_at_end: Truedataloader_pin_memory: False
All Hyperparameters
Click to expand
overwrite_output_dir: Falsedo_predict: Falseeval_strategy: stepsprediction_loss_only: Trueper_device_train_batch_size: 256per_device_eval_batch_size: 32per_gpu_train_batch_size: Noneper_gpu_eval_batch_size: Nonegradient_accumulation_steps: 1eval_accumulation_steps: Nonetorch_empty_cache_steps: Nonelearning_rate: 2e-05weight_decay: 0.01adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08max_grad_norm: 1.0num_train_epochs: 1max_steps: -1lr_scheduler_type: linearlr_scheduler_kwargs: Nonewarmup_ratio: 0.1warmup_steps: 0log_level: passivelog_level_replica: warninglog_on_each_node: Truelogging_nan_inf_filter: Truesave_safetensors: Truesave_on_each_node: Falsesave_only_model: Falserestore_callback_states_from_checkpoint: Falseno_cuda: Falseuse_cpu: Trueuse_mps_device: Falseseed: 42data_seed: Nonejit_mode_eval: Falsebf16: Truefp16: Falsefp16_opt_level: O1half_precision_backend: cpu_ampbf16_full_eval: Falsefp16_full_eval: Falsetf32: Nonelocal_rank: 0ddp_backend: Nonetpu_num_cores: Nonetpu_metrics_debug: Falsedebug: []dataloader_drop_last: Falsedataloader_num_workers: 0dataloader_prefetch_factor: Nonepast_index: -1disable_tqdm: Falseremove_unused_columns: Truelabel_names: Noneload_best_model_at_end: Trueignore_data_skip: Falsefsdp: []fsdp_min_num_params: 0fsdp_config: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}fsdp_transformer_layer_cls_to_wrap: Noneaccelerator_config: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}parallelism_config: Nonedeepspeed: Nonelabel_smoothing_factor: 0.0optim: adamw_torch_fusedoptim_args: Noneadafactor: Falsegroup_by_length: Falselength_column_name: lengthproject: huggingfacetrackio_space_id: trackioddp_find_unused_parameters: Noneddp_bucket_cap_mb: Noneddp_broadcast_buffers: Falsedataloader_pin_memory: Falsedataloader_persistent_workers: Falseskip_memory_metrics: Trueuse_legacy_prediction_loop: Falsepush_to_hub: Falseresume_from_checkpoint: Nonehub_model_id: Nonehub_strategy: every_savehub_private_repo: Nonehub_always_push: Falsehub_revision: Nonegradient_checkpointing: Falsegradient_checkpointing_kwargs: Noneinclude_inputs_for_metrics: Falseinclude_for_metrics: []eval_do_concat_batches: Truefp16_backend: autopush_to_hub_model_id: Nonepush_to_hub_organization: Nonemp_parameters:auto_find_batch_size: Falsefull_determinism: Falsetorchdynamo: Noneray_scope: lastddp_timeout: 1800torch_compile: Falsetorch_compile_backend: Nonetorch_compile_mode: Noneinclude_tokens_per_second: Falseinclude_num_input_tokens_seen: noneftune_noise_alpha: Noneoptim_target_modules: Nonebatch_eval_metrics: Falseeval_on_start: Falseuse_liger_kernel: Falseliger_kernel_config: Noneeval_use_gather_object: Falseaverage_tokens_across_devices: Trueprompts: Nonebatch_sampler: batch_samplermulti_dataset_batch_sampler: proportionalrouter_mapping: {}learning_rate_mapping: {}
Training Logs
| Epoch | Step | Validation Loss | entity-matching_average_precision |
|---|---|---|---|
| 0.1667 | 2 | 0.4423 | 0.9298 |
| 0.3333 | 4 | 0.4188 | 0.9319 |
| 0.5 | 6 | 0.4032 | 0.9335 |
| 0.6667 | 8 | 0.3935 | 0.9345 |
| 0.8333 | 10 | 0.3874 | 0.9353 |
| 1.0 | 12 | 0.3849 | 0.9357 |
- The bold row denotes the saved checkpoint.
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
@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",
}