OloriBern/musique-climb-50

CrossEncoder

This is a Cross Encoder model trained 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: 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
• —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("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>

<!--

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>sentence0</code>, <code>sentence1</code>, and <code>label</code>
• —Approximate statistics based on the first 50 samples: | | sentence0 | sentence1 | 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: | sentence0 | sentence1 | 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> with these parameters:

  {
      "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: {'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}
• —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

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

@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. -->