Views
No views yet
pip install -U sentence-transformers1from sentence_transformers import CrossEncoder
2
3# Download from the 🤗 Hub
4model = CrossEncoder("tomaarsen/reranker-ModernBERT-base-gooaq-bce-soft-negs")
5# Get scores for pairs of texts
6pairs = [
7 ['what is the difference between ground level ozone and the ozone layer?', 'Here, ground-level or "bad" ozone is an air pollutant that is harmful to breathe and it damages crops, trees and other vegetation. ... The stratosphere or "good" ozone layer extends upward from about 6 to 30 miles and protects life on Earth from the sun\'s harmful ultraviolet (UV) rays.'],
8 ['what is the difference between ground level ozone and the ozone layer?', 'In the stratosphere, temperature increases with altitude. The reason is that the direct heat source for the stratosphere is the Sun. A layer of ozone molecules absorbs solar radiation, which heats the stratosphere.'],
9 ['what is the difference between ground level ozone and the ozone layer?', "Atmosphere layers. Earth's atmosphere is divided into five main layers: the exosphere, the thermosphere, the mesosphere, the stratosphere and the troposphere. ... Ozone is abundant here and it heats the atmosphere while also absorbing harmful radiation from the sun."],
10 ['what is the difference between ground level ozone and the ozone layer?', "['Water vapor (H. 2O)', 'Carbon dioxide (CO. ... ', 'Methane (CH. ... ', 'Nitrous oxide (N. 2O)', 'Ozone (O. ... ', 'Chlorofluorocarbons (CFCs)', 'Hydrofluorocarbons (includes HCFCs and HFCs)']"],
11 ['what is the difference between ground level ozone and the ozone layer?', "Gases in the atmosphere, such as carbon dioxide, trap heat just like the glass roof of a greenhouse. These heat-trapping gases are called greenhouse gases. During the day, the Sun shines through the atmosphere. Earth's surface warms up in the sunlight."],
12]
13scores = model.predict(pairs)
14print(scores.shape)
15# (5,)
16
17# Or rank different texts based on similarity to a single text
18ranks = model.rank(
19 'what is the difference between ground level ozone and the ozone layer?',
20 [
21 'Here, ground-level or "bad" ozone is an air pollutant that is harmful to breathe and it damages crops, trees and other vegetation. ... The stratosphere or "good" ozone layer extends upward from about 6 to 30 miles and protects life on Earth from the sun\'s harmful ultraviolet (UV) rays.',
22 'In the stratosphere, temperature increases with altitude. The reason is that the direct heat source for the stratosphere is the Sun. A layer of ozone molecules absorbs solar radiation, which heats the stratosphere.',
23 "Atmosphere layers. Earth's atmosphere is divided into five main layers: the exosphere, the thermosphere, the mesosphere, the stratosphere and the troposphere. ... Ozone is abundant here and it heats the atmosphere while also absorbing harmful radiation from the sun.",
24 "['Water vapor (H. 2O)', 'Carbon dioxide (CO. ... ', 'Methane (CH. ... ', 'Nitrous oxide (N. 2O)', 'Ozone (O. ... ', 'Chlorofluorocarbons (CFCs)', 'Hydrofluorocarbons (includes HCFCs and HFCs)']",
25 "Gases in the atmosphere, such as carbon dioxide, trap heat just like the glass roof of a greenhouse. These heat-trapping gases are called greenhouse gases. During the day, the Sun shines through the atmosphere. Earth's surface warms up in the sunlight.",
26 ]
27)
28# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]gooaq-devCrossEncoderRerankingEvaluator with these parameters:
1{
2 "at_k": 10,
3 "always_rerank_positives": false
4}| Metric | Value |
|---|---|
| map | 0.7089 (+0.1778) |
| mrr@10 | 0.7076 (+0.1836) |
| ndcg@10 | 0.7550 (+0.1637) |
NanoMSMARCO_R100, NanoNFCorpus_R100 and NanoNQ_R100CrossEncoderRerankingEvaluator with these parameters:
1{
2 "at_k": 10,
3 "always_rerank_positives": true
4}| Metric | NanoMSMARCO_R100 | NanoNFCorpus_R100 | NanoNQ_R100 |
|---|---|---|---|
| map | 0.5540 (+0.0644) | 0.3421 (+0.0811) | 0.6312 (+0.2116) |
| mrr@10 | 0.5472 (+0.0697) | 0.5284 (+0.0286) | 0.6380 (+0.2113) |
| ndcg@10 | 0.6229 (+0.0825) | 0.3792 (+0.0541) | 0.6915 (+0.1908) |
NanoBEIR_R100_meanCrossEncoderNanoBEIREvaluator with these parameters:
1{
2 "dataset_names": [
3 "msmarco",
4 "nfcorpus",
5 "nq"
6 ],
7 "rerank_k": 100,
8 "at_k": 10,
9 "always_rerank_positives": true
10}| Metric | Value |
|---|---|
| map | 0.5091 (+0.1190) |
| mrr@10 | 0.5712 (+0.1032) |
| ndcg@10 | 0.5645 (+0.1092) |
question, answer, and label| question | answer | label | |
|---|---|---|---|
| type | string | string | int |
| details |
|
|
|
| question | answer | label |
|---|---|---|
what is the difference between ground level ozone and the ozone layer? | Here, ground-level or "bad" ozone is an air pollutant that is harmful to breathe and it damages crops, trees and other vegetation. ... The stratosphere or "good" ozone layer extends upward from about 6 to 30 miles and protects life on Earth from the sun's harmful ultraviolet (UV) rays. | 1 |
what is the difference between ground level ozone and the ozone layer? | In the stratosphere, temperature increases with altitude. The reason is that the direct heat source for the stratosphere is the Sun. A layer of ozone molecules absorbs solar radiation, which heats the stratosphere. | 0 |
what is the difference between ground level ozone and the ozone layer? | Atmosphere layers. Earth's atmosphere is divided into five main layers: the exosphere, the thermosphere, the mesosphere, the stratosphere and the troposphere. ... Ozone is abundant here and it heats the atmosphere while also absorbing harmful radiation from the sun. | 0 |
BinaryCrossEntropyLoss with these parameters:
1{
2 "activation_fct": "torch.nn.modules.linear.Identity",
3 "pos_weight": 5
4}eval_strategy: stepsper_device_train_batch_size: 64per_device_eval_batch_size: 64learning_rate: 2e-05num_train_epochs: 1warmup_ratio: 0.1seed: 12bf16: Truedataloader_num_workers: 4load_best_model_at_end: Trueoverwrite_output_dir: Falsedo_predict: Falseeval_strategy: stepsprediction_loss_only: Trueper_device_train_batch_size: 64per_device_eval_batch_size: 64per_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.0adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08max_grad_norm: 1.0num_train_epochs: 1max_steps: -1lr_scheduler_type: linearlr_scheduler_kwargs: {}warmup_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: Falseuse_mps_device: Falseseed: 12data_seed: Nonejit_mode_eval: Falseuse_ipex: Falsebf16: Truefp16: Falsefp16_opt_level: O1half_precision_backend: autobf16_full_eval: Falsefp16_full_eval: Falsetf32: Nonelocal_rank: 0ddp_backend: Nonetpu_num_cores: Nonetpu_metrics_debug: Falsedebug: []dataloader_drop_last: Falsedataloader_num_workers: 4dataloader_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}deepspeed: Nonelabel_smoothing_factor: 0.0optim: adamw_torchoptim_args: Noneadafactor: Falsegroup_by_length: Falselength_column_name: lengthddp_find_unused_parameters: Noneddp_bucket_cap_mb: Noneddp_broadcast_buffers: Falsedataloader_pin_memory: Truedataloader_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: Falsegradient_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: Nonedispatch_batches: Nonesplit_batches: Noneinclude_tokens_per_second: Falseinclude_num_input_tokens_seen: Falseneftune_noise_alpha: Noneoptim_target_modules: Nonebatch_eval_metrics: Falseeval_on_start: Falseuse_liger_kernel: Falseeval_use_gather_object: Falseaverage_tokens_across_devices: Falseprompts: Nonebatch_sampler: batch_samplermulti_dataset_batch_sampler: proportional| Epoch | Step | Training Loss | gooaq-dev_ndcg@10 | NanoMSMARCO_R100_ndcg@10 | NanoNFCorpus_R100_ndcg@10 | NanoNQ_R100_ndcg@10 | NanoBEIR_R100_mean_ndcg@10 |
|---|---|---|---|---|---|---|---|
| -1 | -1 | - | 0.1488 (-0.4424) | 0.0573 (-0.4832) | 0.2647 (-0.0604) | 0.0388 (-0.4619) | 0.1202 (-0.3351) |
| 0.0001 | 1 | 1.3143 | - | - | - | - | - |
| 0.0265 | 200 | 1.2539 | - | - | - | - | - |
| 0.0531 | 400 | 0.9497 | - | - | - | - | - |
| 0.0796 | 600 | 0.5613 | - | - | - | - | - |
| 0.1061 | 800 | 0.4687 | - | - | - | - | - |
| 0.1327 | 1000 | 0.4042 | 0.7103 (+0.1191) | 0.5262 (-0.0142) | 0.3298 (+0.0048) | 0.5589 (+0.0583) | 0.4717 (+0.0163) |
| 0.1592 | 1200 | 0.3562 | - | - | - | - | - |
| 0.1857 | 1400 | 0.3543 | - | - | - | - | - |
| 0.2123 | 1600 | 0.3467 | - | - | - | - | - |
| 0.2388 | 1800 | 0.3153 | - | - | - | - | - |
| 0.2653 | 2000 | 0.3033 | 0.7317 (+0.1405) | 0.5662 (+0.0258) | 0.3859 (+0.0609) | 0.6828 (+0.1822) | 0.5450 (+0.0896) |
| 0.2919 | 2200 | 0.2986 | - | - | - | - | - |
| 0.3184 | 2400 | 0.3016 | - | - | - | - | - |
| 0.3449 | 2600 | 0.2984 | - | - | - | - | - |
| 0.3715 | 2800 | 0.2646 | - | - | - | - | - |
| 0.3980 | 3000 | 0.3048 | 0.7359 (+0.1447) | 0.5713 (+0.0309) | 0.3987 (+0.0736) | 0.6960 (+0.1953) | 0.5553 (+0.1000) |
| 0.4245 | 3200 | 0.2714 | - | - | - | - | - |
| 0.4510 | 3400 | 0.2773 | - | - | - | - | - |
| 0.4776 | 3600 | 0.2621 | - | - | - | - | - |
| 0.5041 | 3800 | 0.2529 | - | - | - | - | - |
| 0.5306 | 4000 | 0.2533 | 0.7459 (+0.1546) | 0.5893 (+0.0489) | 0.3887 (+0.0637) | 0.6749 (+0.1743) | 0.5510 (+0.0956) |
| 0.5572 | 4200 | 0.2822 | - | - | - | - | - |
| 0.5837 | 4400 | 0.2299 | - | - | - | - | - |
| 0.6102 | 4600 | 0.2554 | - | - | - | - | - |
| 0.6368 | 4800 | 0.2373 | - | - | - | - | - |
| 0.6633 | 5000 | 0.2248 | 0.7497 (+0.1584) | 0.6110 (+0.0706) | 0.3782 (+0.0531) | 0.6885 (+0.1878) | 0.5592 (+0.1038) |
| 0.6898 | 5200 | 0.2315 | - | - | - | - | - |
| 0.7164 | 5400 | 0.2313 | - | - | - | - | - |
| 0.7429 | 5600 | 0.2294 | - | - | - | - | - |
| 0.7694 | 5800 | 0.2384 | - | - | - | - | - |
| 0.7960 | 6000 | 0.2195 | 0.7530 (+0.1617) | 0.6249 (+0.0845) | 0.3873 (+0.0623) | 0.6773 (+0.1766) | 0.5632 (+0.1078) |
| 0.8225 | 6200 | 0.2047 | - | - | - | - | - |
| 0.8490 | 6400 | 0.2192 | - | - | - | - | - |
| 0.8756 | 6600 | 0.1926 | - | - | - | - | - |
| 0.9021 | 6800 | 0.2185 | - | - | - | - | - |
| 0.9286 | 7000 | 0.2365 | 0.7550 (+0.1637) | 0.6229 (+0.0825) | 0.3792 (+0.0541) | 0.6915 (+0.1908) | 0.5645 (+0.1092) |
| 0.9552 | 7200 | 0.2173 | - | - | - | - | - |
| 0.9817 | 7400 | 0.2249 | - | - | - | - | - |
| -1 | -1 | - | 0.7550 (+0.1637) | 0.6229 (+0.0825) | 0.3792 (+0.0541) | 0.6915 (+0.1908) | 0.5645 (+0.1092) |
1@inproceedings{reimers-2019-sentence-bert,
2 title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks",
3 author = "Reimers, Nils and Gurevych, Iryna",
4 booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing",
5 month = "11",
6 year = "2019",
7 publisher = "Association for Computational Linguistics",
8 url = "https://arxiv.org/abs/1908.10084",
9}