File size: 17,491 Bytes
d56cdda 4811dee d56cdda 5c725db d56cdda 5c725db d56cdda 5c725db d56cdda 4811dee d56cdda 4811dee d56cdda 4811dee d56cdda 5c725db d56cdda 4811dee d56cdda 5c725db d56cdda 5c725db d56cdda 5c725db d56cdda 5c725db d56cdda 5c725db d56cdda 5c725db d56cdda | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 | ---
tags:
- sentence-transformers
- cross-encoder
- reranker
- generated_from_trainer
- dataset_size:50
- loss:BinaryCrossEntropyLoss
pipeline_tag: text-ranking
library_name: sentence-transformers
metrics:
- accuracy
- accuracy_threshold
- f1
- f1_threshold
- precision
- recall
- average_precision
model-index:
- name: CrossEncoder
results:
- task:
type: cross-encoder-binary-classification
name: Cross Encoder Binary Classification
dataset:
name: validation
type: validation
metrics:
- type: accuracy
value: 0.964769647696477
name: Accuracy
- type: accuracy_threshold
value: 0.05564344301819801
name: Accuracy Threshold
- type: f1
value: 0.9446808510638298
name: F1
- type: f1_threshold
value: 0.017735233530402184
name: F1 Threshold
- type: precision
value: 0.9568965517241379
name: Precision
- type: recall
value: 0.9327731092436975
name: Recall
- type: average_precision
value: 0.9823537725322578
name: Average Precision
---
# CrossEncoder
This is a [Cross Encoder](https://www.sbert.net/docs/cross_encoder/usage/usage.html) model trained using the [sentence-transformers](https://www.SBERT.net) 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:** [Unknown](https://huggingface.co/unknown) -->
- **Maximum Sequence Length:** 1024 tokens
- **Number of Output Labels:** 1 label
<!-- - **Training Dataset:** Unknown -->
<!-- - **Language:** Unknown -->
<!-- - **License:** Unknown -->
### Model Sources
- **Documentation:** [Sentence Transformers Documentation](https://sbert.net)
- **Documentation:** [Cross Encoder Documentation](https://www.sbert.net/docs/cross_encoder/usage/usage.html)
- **Repository:** [Sentence Transformers on GitHub](https://github.com/huggingface/sentence-transformers)
- **Hugging Face:** [Cross Encoders on Hugging Face](https://huggingface.co/models?library=sentence-transformers&other=cross-encoder)
## 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("cross_encoder_model_id")
# Get scores for pairs of texts
pairs = [
['Khosrowabad, in the city where Pouya Tajik was born, is found in what county?', 'Khosrowabad, Tehran. Khosrowabad (, also Romanized as Khosrowābād) is a village in Jajrud Rural District, in the Jajrud District of Pardis County, Tehran Province, Iran. At the 2006 census, its population was 1,180, in 386 families. The village was chosen as the capital of Jajrud Rural District when it was created on December 29, 2012.'],
['Khosrowabad, in the city where Pouya Tajik was born, is found in what county?', 'The Prince and the Showgirl. The Prince and the Showgirl (originally called The Sleeping Prince) is a 1957 British - American romantic comedy film starring Marilyn Monroe and Laurence Olivier. Olivier also served as director and producer. The screenplay by Terence Rattigan was based on his 1953 stage play The Sleeping Prince. It was filmed in London.'],
['How many symbols are the same in the beginning of ASCII and the dominant scheme for internal processing?', "Star of David. The flag of Israel, depicting a blue Star of David on a white background, between two horizontal blue stripes was adopted on October 28, 1948, five months after the country's establishment. The origins of the flag's design date from the First Zionist Congress in 1897; the flag has subsequently been known as the ``flag of Zion ''."],
['Margraviate of the country of the Botanical Garden of the place Josef Victor Rohon was educated is an instance of?', 'Botanical Garden of the University of Vienna. The Botanical Garden of the University of Vienna is a botanical garden in Vienna, Austria. It covers 8 hectares and is immediately adjacent to the Belvedere gardens. It is a part of the University of Vienna.'],
["Who was the singer of I Can't Sleep at Night in Home and Away?", 'I Can\'t Sleep at Night. "I Can\'t Sleep at Night" was written by Dannii Minogue, Rob Davis and Jewels & Stone for Minogue\'s fifth studio album "Club Disco" and included on the greatest hits compilation, "The Hits & Beyond" (2006). On 8 January 2007, the song and its remixes were released as a digital download in Australia, the United Kingdom and North America. The Radio Edit of the song features minor mixing and production differences and is the version featured in the music video.'],
]
scores = model.predict(pairs)
print(scores.shape)
# (5,)
# Or rank different texts based on similarity to a single text
ranks = model.rank(
'Khosrowabad, in the city where Pouya Tajik was born, is found in what county?',
[
'Khosrowabad, Tehran. Khosrowabad (, also Romanized as Khosrowābād) is a village in Jajrud Rural District, in the Jajrud District of Pardis County, Tehran Province, Iran. At the 2006 census, its population was 1,180, in 386 families. The village was chosen as the capital of Jajrud Rural District when it was created on December 29, 2012.',
'The Prince and the Showgirl. The Prince and the Showgirl (originally called The Sleeping Prince) is a 1957 British - American romantic comedy film starring Marilyn Monroe and Laurence Olivier. Olivier also served as director and producer. The screenplay by Terence Rattigan was based on his 1953 stage play The Sleeping Prince. It was filmed in London.',
"Star of David. The flag of Israel, depicting a blue Star of David on a white background, between two horizontal blue stripes was adopted on October 28, 1948, five months after the country's establishment. The origins of the flag's design date from the First Zionist Congress in 1897; the flag has subsequently been known as the ``flag of Zion ''.",
'Botanical Garden of the University of Vienna. The Botanical Garden of the University of Vienna is a botanical garden in Vienna, Austria. It covers 8 hectares and is immediately adjacent to the Belvedere gardens. It is a part of the University of Vienna.',
'I Can\'t Sleep at Night. "I Can\'t Sleep at Night" was written by Dannii Minogue, Rob Davis and Jewels & Stone for Minogue\'s fifth studio album "Club Disco" and included on the greatest hits compilation, "The Hits & Beyond" (2006). On 8 January 2007, the song and its remixes were released as a digital download in Australia, the United Kingdom and North America. The Radio Edit of the song features minor mixing and production differences and is the version featured in the music video.',
]
)
# [{'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 Binary Classification
* Dataset: `validation`
* Evaluated with [<code>CEBinaryClassificationEvaluator</code>](https://sbert.net/docs/package_reference/cross_encoder/evaluation.html#sentence_transformers.cross_encoder.evaluation.CEBinaryClassificationEvaluator)
| Metric | Value |
|:----------------------|:-----------|
| accuracy | 0.9648 |
| accuracy_threshold | 0.0556 |
| f1 | 0.9447 |
| f1_threshold | 0.0177 |
| precision | 0.9569 |
| recall | 0.9328 |
| **average_precision** | **0.9824** |
<!--
## 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: 50 training samples
* Columns: <code>sentence_0</code>, <code>sentence_1</code>, and <code>label</code>
* Approximate statistics based on the first 50 samples:
| | sentence_0 | sentence_1 | label |
|:--------|:-----------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------|:---------------------------------------------------------------|
| type | string | string | float |
| details | <ul><li>min: 39 characters</li><li>mean: 76.6 characters</li><li>max: 114 characters</li></ul> | <ul><li>min: 148 characters</li><li>mean: 511.34 characters</li><li>max: 1394 characters</li></ul> | <ul><li>min: 0.0</li><li>mean: 0.32</li><li>max: 1.0</li></ul> |
* Samples:
| sentence_0 | sentence_1 | label |
|:----------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------|
| <code>Khosrowabad, in the city where Pouya Tajik was born, is found in what county?</code> | <code>Khosrowabad, Tehran. Khosrowabad (, also Romanized as Khosrowābād) is a village in Jajrud Rural District, in the Jajrud District of Pardis County, Tehran Province, Iran. At the 2006 census, its population was 1,180, in 386 families. The village was chosen as the capital of Jajrud Rural District when it was created on December 29, 2012.</code> | <code>1.0</code> |
| <code>Khosrowabad, in the city where Pouya Tajik was born, is found in what county?</code> | <code>The Prince and the Showgirl. The Prince and the Showgirl (originally called The Sleeping Prince) is a 1957 British - American romantic comedy film starring Marilyn Monroe and Laurence Olivier. Olivier also served as director and producer. The screenplay by Terence Rattigan was based on his 1953 stage play The Sleeping Prince. It was filmed in London.</code> | <code>0.0</code> |
| <code>How many symbols are the same in the beginning of ASCII and the dominant scheme for internal processing?</code> | <code>Star of David. The flag of Israel, depicting a blue Star of David on a white background, between two horizontal blue stripes was adopted on October 28, 1948, five months after the country's establishment. The origins of the flag's design date from the First Zionist Congress in 1897; the flag has subsequently been known as the ``flag of Zion ''.</code> | <code>0.0</code> |
* Loss: [<code>BinaryCrossEntropyLoss</code>](https://sbert.net/docs/package_reference/cross_encoder/losses.html#binarycrossentropyloss) with these parameters:
```json
{
"activation_fn": "torch.nn.modules.linear.Identity",
"pos_weight": null
}
```
### Training Hyperparameters
#### Non-Default Hyperparameters
- `per_device_train_batch_size`: 4
- `per_device_eval_batch_size`: 4
#### All Hyperparameters
<details><summary>Click to expand</summary>
- `overwrite_output_dir`: False
- `do_predict`: False
- `eval_strategy`: no
- `prediction_loss_only`: True
- `per_device_train_batch_size`: 4
- `per_device_eval_batch_size`: 4
- `per_gpu_train_batch_size`: None
- `per_gpu_eval_batch_size`: None
- `gradient_accumulation_steps`: 1
- `eval_accumulation_steps`: None
- `torch_empty_cache_steps`: None
- `learning_rate`: 5e-05
- `weight_decay`: 0.0
- `adam_beta1`: 0.9
- `adam_beta2`: 0.999
- `adam_epsilon`: 1e-08
- `max_grad_norm`: 1
- `num_train_epochs`: 3
- `max_steps`: -1
- `lr_scheduler_type`: linear
- `lr_scheduler_kwargs`: {}
- `warmup_ratio`: 0.0
- `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`: False
- `use_cpu`: False
- `use_mps_device`: False
- `seed`: 42
- `data_seed`: None
- `jit_mode_eval`: False
- `use_ipex`: 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`: 0
- `dataloader_prefetch_factor`: None
- `past_index`: -1
- `disable_tqdm`: False
- `remove_unused_columns`: True
- `label_names`: None
- `load_best_model_at_end`: False
- `ignore_data_skip`: False
- `fsdp`: []
- `fsdp_min_num_params`: 0
- `fsdp_config`: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False}
- `fsdp_transformer_layer_cls_to_wrap`: None
- `accelerator_config`: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}
- `deepspeed`: None
- `label_smoothing_factor`: 0.0
- `optim`: adamw_torch
- `optim_args`: None
- `adafactor`: False
- `group_by_length`: False
- `length_column_name`: length
- `ddp_find_unused_parameters`: None
- `ddp_bucket_cap_mb`: None
- `ddp_broadcast_buffers`: False
- `dataloader_pin_memory`: True
- `dataloader_persistent_workers`: False
- `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`: False
- `hub_always_push`: False
- `gradient_checkpointing`: False
- `gradient_checkpointing_kwargs`: None
- `include_inputs_for_metrics`: False
- `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
- `dispatch_batches`: None
- `split_batches`: None
- `include_tokens_per_second`: False
- `include_num_input_tokens_seen`: False
- `neftune_noise_alpha`: None
- `optim_target_modules`: None
- `batch_eval_metrics`: False
- `eval_on_start`: False
- `eval_use_gather_object`: False
- `prompts`: None
- `batch_sampler`: batch_sampler
- `multi_dataset_batch_sampler`: proportional
- `router_mapping`: {}
- `learning_rate_mapping`: {}
</details>
### Training Logs
| Epoch | Step | validation_average_precision |
|:-----:|:----:|:----------------------------:|
| 1.0 | 13 | 0.9827 |
| 2.0 | 26 | 0.9826 |
| 3.0 | 39 | 0.9824 |
### Framework Versions
- Python: 3.11.6
- Sentence Transformers: 5.2.0
- Transformers: 4.44.2
- PyTorch: 2.9.1+cu128
- Accelerate: 1.12.0
- Datasets: 4.0.0
- Tokenizers: 0.19.1
## 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.*
--> |