--- 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 - **Maximum Sequence Length:** 1024 tokens - **Number of Output Labels:** 1 label ### 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': ...}, ...] ``` ## Evaluation ### Metrics #### Cross Encoder Binary Classification * Dataset: `validation` * Evaluated with [CEBinaryClassificationEvaluator](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** | ## Training Details ### Training Dataset #### Unnamed Dataset * Size: 50 training samples * Columns: sentence_0, sentence_1, and label * Approximate statistics based on the first 50 samples: | | sentence_0 | sentence_1 | label | |:--------|:-----------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------|:---------------------------------------------------------------| | type | string | string | float | | details | | | | * Samples: | sentence_0 | sentence_1 | label | |:----------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------| | 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. | 1.0 | | 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. | 0.0 | | 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 ''. | 0.0 | * Loss: [BinaryCrossEntropyLoss](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
Click to expand - `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`: {}
### 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", } ```