rohit-vt/tink-reranker-phase6_minilm_multikind
CrossEncoder based on cross-encoder/ms-marco-MiniLM-L6-v2
This is a Cross Encoder model finetuned from cross-encoder/ms-marco-MiniLM-L6-v2 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/ms-marco-MiniLM-L6-v2 <!-- at revision c5ee24cb16019beea0893ab7796b1df96625c6b8 -->
- Maximum Sequence Length: 512 tokens
- Number of Output Labels: 1 label
- Supported Modality: Text <!-- - Training Dataset: Unknown --> <!-- - Language: Unknown --> <!-- - License: Unknown -->
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-transformersThen 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 = [
['skill: use of special equipment for daily activities', 'skill: use of special equipment for daily activities'],
['skill: use of special equipment for daily activities', 'skill: operate video equipment'],
['skill: use of special equipment for daily activities', 'skill: use equipment, tools or technology with precision'],
['skill: use of special equipment for daily activities', 'skill: operate emergency equipment'],
['skill: use of special equipment for daily activities', 'skill: monitor sports equipment'],
]
scores = model.predict(pairs)
print(scores)
# [ 8.5757 -7.8594 -6.9781 -5.8253 -7.199 ]
# Or rank different texts based on similarity to a single text
ranks = model.rank(
'skill: use of special equipment for daily activities',
[
'skill: use of special equipment for daily activities',
'skill: operate video equipment',
'skill: use equipment, tools or technology with precision',
'skill: operate emergency equipment',
'skill: monitor sports equipment',
]
)
# [{'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. -->
<!--
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: 283,415 training samples
- Columns: <code>sentenceA</code>, <code>sentenceB</code>, and <code>label</code>
- Approximate statistics based on the first 100 samples: | | sentenceA | sentenceB | label | |:---------|:---------------------------------------------------------------------------------|:---------------------------------------------------------------------------------|:--------------------------------------------------------------| | type | string | string | float | | modality | text | text | | | details | <ul><li>min: 7 tokens</li><li>mean: 8.45 tokens</li><li>max: 11 tokens</li></ul> | <ul><li>min: 6 tokens</li><li>mean: 7.85 tokens</li><li>max: 13 tokens</li></ul> | <ul><li>min: 0.0</li><li>mean: 0.2</li><li>max: 1.0</li></ul> |
- Samples: | sentenceA | sentenceB | label | |:------------------------------------------|:-------------------------------------------------|:-----------------| | <code>skill: manage staff of music</code> | <code>skill: manage musical staff</code> | <code>1.0</code> | | <code>skill: manage staff of music</code> | <code>skill: organise rehearsals</code> | <code>0.0</code> | | <code>skill: manage staff of music</code> | <code>skill: maintain musical instruments</code> | <code>0.0</code> |
- Loss: <code>BinaryCrossEntropyLoss</code> with these parameters:
{
"activation_fn": "torch.nn.modules.linear.Identity",
"pos_weight": null
}Evaluation Dataset
Unnamed Dataset
- Size: 34,418 evaluation samples
- Columns: <code>sentenceA</code>, <code>sentenceB</code>, and <code>label</code>
- Approximate statistics based on the first 100 samples: | | sentenceA | sentenceB | label | |:---------|:----------------------------------------------------------------------------------|:---------------------------------------------------------------------------------|:--------------------------------------------------------------| | type | string | string | float | | modality | text | text | | | details | <ul><li>min: 8 tokens</li><li>mean: 11.33 tokens</li><li>max: 13 tokens</li></ul> | <ul><li>min: 5 tokens</li><li>mean: 8.41 tokens</li><li>max: 13 tokens</li></ul> | <ul><li>min: 0.0</li><li>mean: 0.2</li><li>max: 1.0</li></ul> |
- Samples: | sentenceA | sentenceB | label | |:------------------------------------------------------------------|:----------------------------------------------------------------------|:-----------------| | <code>skill: use of special equipment for daily activities</code> | <code>skill: use of special equipment for daily activities</code> | <code>1.0</code> | | <code>skill: use of special equipment for daily activities</code> | <code>skill: operate video equipment</code> | <code>0.0</code> | | <code>skill: use of special equipment for daily activities</code> | <code>skill: use equipment, tools or technology with precision</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
per_device_train_batch_size: 32num_train_epochs: 2learning_rate: 2e-05warmup_steps: 0.1per_device_eval_batch_size: 64load_best_model_at_end: True
All Hyperparameters
<details><summary>Click to expand</summary>
per_device_train_batch_size: 32num_train_epochs: 2max_steps: -1learning_rate: 2e-05lr_scheduler_type: linearlr_scheduler_kwargs: Nonewarmup_steps: 0.1optim: adamwtorchfusedoptim_args: Noneweight_decay: 0.0adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08optim_target_modules: Nonegradient_accumulation_steps: 1average_tokens_across_devices: Truemax_grad_norm: 1.0label_smoothing_factor: 0.0bf16: Falsefp16: Falsebf16_full_eval: Falsefp16_full_eval: Falsetf32: Nonegradient_checkpointing: Falsegradient_checkpointing_kwargs: Nonetorch_compile: Falsetorch_compile_backend: Nonetorch_compile_mode: Noneuse_liger_kernel: Falseliger_kernel_config: Noneuse_cache: Falseneftune_noise_alpha: Nonetorch_empty_cache_steps: Noneauto_find_batch_size: Falselog_on_each_node: Truelogging_nan_inf_filter: Trueinclude_num_input_tokens_seen: nolog_level: passivelog_level_replica: warningdisable_tqdm: Falseproject: huggingfacetrackio_space_id: Nonetrackio_bucket_id: Nonetrackio_static_space_id: Noneper_device_eval_batch_size: 64prediction_loss_only: Trueeval_on_start: Falseeval_do_concat_batches: Trueeval_use_gather_object: Falseeval_accumulation_steps: Noneinclude_for_metrics: []batch_eval_metrics: Falsesave_only_model: Falsesave_on_each_node: Falseenable_jit_checkpoint: Falsepush_to_hub: Falsehub_private_repo: Nonehub_model_id: Nonehub_strategy: every_savehub_always_push: Falsehub_revision: Noneload_best_model_at_end: Trueignore_data_skip: Falserestore_callback_states_from_checkpoint: Falsefull_determinism: Falseseed: 42data_seed: Noneuse_cpu: Falseaccelerator_config: {'splitbatches': False, 'dispatchbatches': None, 'evenbatches': True, 'useseedablesampler': True, 'nonblocking': False, 'gradientaccumulationkwargs': None}parallelism_config: Nonedataloader_drop_last: Falsedataloader_num_workers: 0dataloader_pin_memory: Truedataloader_persistent_workers: Falsedataloader_prefetch_factor: Noneremove_unused_columns: Truelabel_names: Nonetrain_sampling_strategy: randomlength_column_name: lengthddp_find_unused_parameters: Noneddp_bucket_cap_mb: Noneddp_broadcast_buffers: Falseddp_static_graph: Noneddp_backend: Noneddp_timeout: 1800fsdp: []fsdp_config: {'minnumparams': 0, 'xla': False, 'xlafsdpv2': False, 'xlafsdpgrad_ckpt': False}deepspeed: Nonedebug: []skip_memory_metrics: Truedo_predict: Falseresume_from_checkpoint: Nonewarmup_ratio: Nonelocal_rank: -1prompts: Nonebatch_sampler: batch_samplermulti_dataset_batch_sampler: proportionalrouter_mapping: {}learning_rate_mapping: {}
</details>
Training Logs
<details><summary>Click to expand</summary>
- The bold row denotes the saved checkpoint. </details>
Training Time
- Training: 41.8 minutes
- Evaluation: 1.5 minutes
- Total: 43.3 minutes
Framework Versions
- Python: 3.13.13
- Sentence Transformers: 5.5.0
- Transformers: 5.8.1
- PyTorch: 2.12.0
- 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",
}<!--
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. -->
