Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper • 1908.10084 • Published • 13
How to use cuadron11/BERnaT_base-contrastive-all-8-3ep with sentence-transformers:
from sentence_transformers import CrossEncoder
model = CrossEncoder("cuadron11/BERnaT_base-contrastive-all-8-3ep")
query = "Which planet is known as the Red Planet?"
passages = [
"Venus is often called Earth's twin because of its similar size and proximity.",
"Mars, known for its reddish appearance, is often referred to as the Red Planet.",
"Jupiter, the largest planet in our solar system, has a prominent red spot.",
"Saturn, famous for its rings, is sometimes mistaken for the Red Planet."
]
scores = model.predict([(query, passage) for passage in passages])
print(scores)This is a Cross Encoder model finetuned from HiTZ/BERnaT_base using the sentence-transformers library. It computes scores for pairs of texts, which can be used for text reranking and semantic search.
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("cuadron11/BERnaT_base-contrastive-all-8-3ep")
# Get scores for pairs of texts
pairs = [
['Zein da Gobernantza Publiko eta Autogobernuko sailburuaren asmoa 2019ko apirilaren 5etik aurrera gobernatzeari dagokionez?', '[TOPIC: Galdera, Borja Sémper Pascual Euskal Talde Popularreko legebiltzarkideak Gobernantza Publiko eta Autogobernuko sailburuari egina, izan daitekeen hauteskundeen aurreratzeari buruz]\n[GOBERNANTZA PUBLIKO ETA AUTOGOBERNUKO SAILBURUAK (ERKOREKA GERVASIO), (EA-NV)]:\nbat egin du hemen, tribuna honetan, gaur goizean bertan, eta ni goitik behera ados nago. Bere asmoa, bere borondatea, bere konpromisoa, negoziatzen jarraitzea da, orain arte bezala; egonkortasunetik, konpromisotik eta oposizioko indar politikoekin elkar ulertzetik gobernatzen jarraitzea. Eta, apaltasunari dagokionez, fribolo dei nazakezu, inolako eragozpenik gabe, eta nik ez dizut erantzungo, hara. Eskerrik asko. (Date: 05.04.2019)'],
['Zeintzuk dira Urdaibaiko Biosfera Erreserbako garapen sozioekonomikoa bultzatzeko hartu diren neurriak?', '[TOPIC: Mozioa, José Ramón Becerra Carollo Elkarrekin Podemos taldeko legebiltzarkideak aurkeztua, Urdaibaiko Biosfera Erreserbako garapen sozioekonomikoari buruz. Eztabaida eta behin betiko ebazpena]\n[ARRUABARRENA AZPITARTE, (EA-NV)]:\nBai, agian, Otero jauna, irakurketa azkar samarra egin diozu PADASen ebaluazioari. Lehenengoz eta behin, nik ere aurpegi irribarretsu gehiago ikusi ditudalako, grafikoki hartzen direnean, baina batez ere PADASen ebaluazioa orain dela urte batzuk egin zelako, eta harrezkero gauza batzuk egin direlako. Eta nik bi partetan sailkatuko nituzke hartu diren neurriak. Alde batetik, erakundeen eskuetan % 100ean dauden neurriak, hau da, inbertsio publikoa % 100a denean. Eta, beste alde batetik, (Date: 06.06.2019)'],
['Zein da Leire Pinedo Bustamanteren proposamena Ogasun eta Ekonomia Sailak BEZaren doikuntzetatik jasotako 400 milioi euroak erabiltzeko?', '[TOPIC: Galdera, Leire Pinedo Bustamante EH Bildu taldeko legebiltzarkideak Ogasun eta Ekonomiako sailburuari egina, BEZaren doikuntzetatik eratorritako 400 milioi euro inguruko kopuruaren erabilpenari buruz]\n[PINEDO BUSTAMANTE, (EH Bildu)]:\nzenbatekoak; hamar urteren buruan sortutako zenbatekoak dira. Beraz, nik bai uste dudala zuek mahairatzen duzuen hori baino zerbait gehiago egiteko aukera dagoela. Negoziatu behar baduzue, negozia ezazue dagokionarekin, baina egiteko aukera badagoela uste dut. Izan ere, dirubide publiko handiagoak eskatzen zenituen zuk, zerga-erreforma eskatzen zenuen... Oraintxe duzu mahai gainean aukera aparta eta ederra, zeuk ere aitortuko didazu hori, seguru aitortuko duzula, aparta eta ederra, aurtengo urtearen amaieran (Date: 20.10.2017)'],
['Zeintzuk dira Euskal Talde Popularreko legebiltzarkideek dirulaguntza publikoak emateko nahiago dituzten metodoak?', '[TOPIC: Mozioa, Carmelo Barrio Baroja Euskal Talde Popularreko legebiltzarkideak aurkeztua, kirol arloan eta kulturaren eta ondare historiko eta artistikoaren sustapen arloan gauzatu gabe dauden aurrekontu-partidak exekutatzeari buruz. Eztabaida eta behin betiko ebazpena]\n[GARCÍA LARRIMBE, (EP)]:\nez zaizkigu gustatzen, diskriminatu egiten dutelako, hatzez ematen direlako, ez direlako inbertsio publikoak definitzeko metodoa eta klientelismoa sustatzen dutelako. Eta guri, askotan esan dugun bezala, lehia libreko dirulaguntza publikoak gustatzen zaizkigu, edonork baldintza berdinetan erabil ditzakeenak eta proiektua baloratu ostean ematen direnak. Beraz, egia esan, nahiko zaila egiten zaigu legea betetzearen aurka egoteko arrazoiak aurkitzea, eta, era berean, zaila egiten zaigu legea betetzeko eta aipatutako dirulaguntza izendunak (Date: 24.10.2019)'],
['Zein kasutan daude aurreikusita geroratzeak Estatuko araudian eta foru-araudian?', '[TOPIC: Euskal Talde Popularra-Ciudadanos talde parlamentarioak egindako legez besteko proposamena, 2021. XII. legegintzaldia / XII legislatura N.º ekitaldiko lehen sei hilabeteetan tributuak geroratzeari buruz. Eztabaida eta behin betiko ebazpena]\n[PINEDO BUSTAMANTE, (EH Bildu)]:\nez dator bat lurralde honen eskumen-egoerarekin. Geroratzeez hitz egin diezadazula; Berrojalbiz andreak esan dizu: badira kasu zehatz-zehatz batzuk, bakanak. Eta ez dira gure auzoko enpresa txiki eta ertainak, ezta gure auzoko autonomoak ere, Gordillo jauna. Horiek ez dira Estatuko araudian, eta ez foru-araudian, barne hartuta egon daitezkeen salbuespenak. Eta ondo baino hobeto dakizu zuk hori. Orduan, niri bolatxoarekin tranparik ez, Gordillo jauna. Orduan, mesedez, zergei (Date: 29.04.2021)'],
]
scores = model.predict(pairs)
print(scores.shape)
# (5,)
# Or rank different texts based on similarity to a single text
ranks = model.rank(
'Zein da Gobernantza Publiko eta Autogobernuko sailburuaren asmoa 2019ko apirilaren 5etik aurrera gobernatzeari dagokionez?',
[
'[TOPIC: Galdera, Borja Sémper Pascual Euskal Talde Popularreko legebiltzarkideak Gobernantza Publiko eta Autogobernuko sailburuari egina, izan daitekeen hauteskundeen aurreratzeari buruz]\n[GOBERNANTZA PUBLIKO ETA AUTOGOBERNUKO SAILBURUAK (ERKOREKA GERVASIO), (EA-NV)]:\nbat egin du hemen, tribuna honetan, gaur goizean bertan, eta ni goitik behera ados nago. Bere asmoa, bere borondatea, bere konpromisoa, negoziatzen jarraitzea da, orain arte bezala; egonkortasunetik, konpromisotik eta oposizioko indar politikoekin elkar ulertzetik gobernatzen jarraitzea. Eta, apaltasunari dagokionez, fribolo dei nazakezu, inolako eragozpenik gabe, eta nik ez dizut erantzungo, hara. Eskerrik asko. (Date: 05.04.2019)',
'[TOPIC: Mozioa, José Ramón Becerra Carollo Elkarrekin Podemos taldeko legebiltzarkideak aurkeztua, Urdaibaiko Biosfera Erreserbako garapen sozioekonomikoari buruz. Eztabaida eta behin betiko ebazpena]\n[ARRUABARRENA AZPITARTE, (EA-NV)]:\nBai, agian, Otero jauna, irakurketa azkar samarra egin diozu PADASen ebaluazioari. Lehenengoz eta behin, nik ere aurpegi irribarretsu gehiago ikusi ditudalako, grafikoki hartzen direnean, baina batez ere PADASen ebaluazioa orain dela urte batzuk egin zelako, eta harrezkero gauza batzuk egin direlako. Eta nik bi partetan sailkatuko nituzke hartu diren neurriak. Alde batetik, erakundeen eskuetan % 100ean dauden neurriak, hau da, inbertsio publikoa % 100a denean. Eta, beste alde batetik, (Date: 06.06.2019)',
'[TOPIC: Galdera, Leire Pinedo Bustamante EH Bildu taldeko legebiltzarkideak Ogasun eta Ekonomiako sailburuari egina, BEZaren doikuntzetatik eratorritako 400 milioi euro inguruko kopuruaren erabilpenari buruz]\n[PINEDO BUSTAMANTE, (EH Bildu)]:\nzenbatekoak; hamar urteren buruan sortutako zenbatekoak dira. Beraz, nik bai uste dudala zuek mahairatzen duzuen hori baino zerbait gehiago egiteko aukera dagoela. Negoziatu behar baduzue, negozia ezazue dagokionarekin, baina egiteko aukera badagoela uste dut. Izan ere, dirubide publiko handiagoak eskatzen zenituen zuk, zerga-erreforma eskatzen zenuen... Oraintxe duzu mahai gainean aukera aparta eta ederra, zeuk ere aitortuko didazu hori, seguru aitortuko duzula, aparta eta ederra, aurtengo urtearen amaieran (Date: 20.10.2017)',
'[TOPIC: Mozioa, Carmelo Barrio Baroja Euskal Talde Popularreko legebiltzarkideak aurkeztua, kirol arloan eta kulturaren eta ondare historiko eta artistikoaren sustapen arloan gauzatu gabe dauden aurrekontu-partidak exekutatzeari buruz. Eztabaida eta behin betiko ebazpena]\n[GARCÍA LARRIMBE, (EP)]:\nez zaizkigu gustatzen, diskriminatu egiten dutelako, hatzez ematen direlako, ez direlako inbertsio publikoak definitzeko metodoa eta klientelismoa sustatzen dutelako. Eta guri, askotan esan dugun bezala, lehia libreko dirulaguntza publikoak gustatzen zaizkigu, edonork baldintza berdinetan erabil ditzakeenak eta proiektua baloratu ostean ematen direnak. Beraz, egia esan, nahiko zaila egiten zaigu legea betetzearen aurka egoteko arrazoiak aurkitzea, eta, era berean, zaila egiten zaigu legea betetzeko eta aipatutako dirulaguntza izendunak (Date: 24.10.2019)',
'[TOPIC: Euskal Talde Popularra-Ciudadanos talde parlamentarioak egindako legez besteko proposamena, 2021. XII. legegintzaldia / XII legislatura N.º ekitaldiko lehen sei hilabeteetan tributuak geroratzeari buruz. Eztabaida eta behin betiko ebazpena]\n[PINEDO BUSTAMANTE, (EH Bildu)]:\nez dator bat lurralde honen eskumen-egoerarekin. Geroratzeez hitz egin diezadazula; Berrojalbiz andreak esan dizu: badira kasu zehatz-zehatz batzuk, bakanak. Eta ez dira gure auzoko enpresa txiki eta ertainak, ezta gure auzoko autonomoak ere, Gordillo jauna. Horiek ez dira Estatuko araudian, eta ez foru-araudian, barne hartuta egon daitezkeen salbuespenak. Eta ondo baino hobeto dakizu zuk hori. Orduan, niri bolatxoarekin tranparik ez, Gordillo jauna. Orduan, mesedez, zergei (Date: 29.04.2021)',
]
)
# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]
BERnaT_base-contrastive-all-8-3epCrossEncoderRerankingEvaluator with these parameters:{
"at_k": 10,
"always_rerank_positives": false
}
| Metric | Value |
|---|---|
| map | 0.0229 (+0.0219) |
| mrr@10 | 0.0229 (+0.0226) |
| ndcg@10 | 0.0231 (+0.0226) |
query and positive| query | positive | |
|---|---|---|
| type | string | string |
| details |
|
|
| query | positive |
|---|---|
Noizko atera nahi da haur-pobreziari buruzko proiektua herritar guztien mesederako? |
[TOPIC: Mozioa, Isabel González Rodríguez Elkarrekin Podemos-IU taldeko legebiltzarkideak aurkeztua, 2020ko Pobreziaren eta Gizarte Ezberdintasunen Inkestan jasotako haur-pobreziaren gaineko datuei buruz. Eztabaida eta behin betiko ebazpena] |
Zein da Eusko Jaurlaritzaren jarduna emakumeen genitalen mutilazioaren aurka? |
[TOPIC: Interpelazioa, Juana de Bengoechea Estrade Euskal Talde Popularreko legebiltzarkideak Hezkuntzako sailburuari egina, emakumeen genitalen mutilazioari buruz] |
Nola kokatu du Eusko Jaurlaritzak Igeldoren auzia Gipuzkoako erakundeen jardueran? |
[TOPIC: Galdera, Txarli Prieto San Vicente Euskal Sozialistak taldeko legebiltzarkideak lehendakariari egina, Igeldori buruz] |
CachedMultipleNegativesRankingLoss with these parameters:{
"scale": 10.0,
"num_negatives": null,
"activation_fn": "torch.nn.modules.activation.Sigmoid",
"mini_batch_size": 16
}
query and positive| query | positive | |
|---|---|---|
| type | string | string |
| details |
|
|
| query | positive |
|---|---|
Zein da Gobernantza Publiko eta Autogobernuko sailburuaren asmoa 2019ko apirilaren 5etik aurrera gobernatzeari dagokionez? |
[TOPIC: Galdera, Borja Sémper Pascual Euskal Talde Popularreko legebiltzarkideak Gobernantza Publiko eta Autogobernuko sailburuari egina, izan daitekeen hauteskundeen aurreratzeari buruz] |
Zeintzuk dira Urdaibaiko Biosfera Erreserbako garapen sozioekonomikoa bultzatzeko hartu diren neurriak? |
[TOPIC: Mozioa, José Ramón Becerra Carollo Elkarrekin Podemos taldeko legebiltzarkideak aurkeztua, Urdaibaiko Biosfera Erreserbako garapen sozioekonomikoari buruz. Eztabaida eta behin betiko ebazpena] |
Zein da Leire Pinedo Bustamanteren proposamena Ogasun eta Ekonomia Sailak BEZaren doikuntzetatik jasotako 400 milioi euroak erabiltzeko? |
[TOPIC: Galdera, Leire Pinedo Bustamante EH Bildu taldeko legebiltzarkideak Ogasun eta Ekonomiako sailburuari egina, BEZaren doikuntzetatik eratorritako 400 milioi euro inguruko kopuruaren erabilpenari buruz] |
CachedMultipleNegativesRankingLoss with these parameters:{
"scale": 10.0,
"num_negatives": null,
"activation_fn": "torch.nn.modules.activation.Sigmoid",
"mini_batch_size": 16
}
eval_strategy: stepsper_device_train_batch_size: 16per_device_eval_batch_size: 16learning_rate: 2e-05num_train_epochs: 1warmup_ratio: 0.1load_best_model_at_end: Truebatch_sampler: no_duplicatesoverwrite_output_dir: Falsedo_predict: Falseeval_strategy: stepsprediction_loss_only: Trueper_device_train_batch_size: 16per_device_eval_batch_size: 16per_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: 42data_seed: Nonejit_mode_eval: Falseuse_ipex: Falsebf16: Falsefp16: 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: 0dataloader_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}parallelism_config: Nonedeepspeed: 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: Falsehub_revision: Nonegradient_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: Noneinclude_tokens_per_second: Falseinclude_num_input_tokens_seen: Falseneftune_noise_alpha: Noneoptim_target_modules: Nonebatch_eval_metrics: Falseeval_on_start: Falseuse_liger_kernel: Falseliger_kernel_config: Noneeval_use_gather_object: Falseaverage_tokens_across_devices: Falseprompts: Nonebatch_sampler: no_duplicatesmulti_dataset_batch_sampler: proportionalrouter_mapping: {}learning_rate_mapping: {}| Epoch | Step | Training Loss | Validation Loss | BERnaT_base-contrastive-all-8-3ep_ndcg@10 |
|---|---|---|---|---|
| 1.0 | 200 | 0.4445 | 0.036 | 0.0231 (+0.0226) |
@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",
}
Base model
HiTZ/BERnaT-base