Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper • 1908.10084 • Published • 13
How to use TakoData/chart-reranker with sentence-transformers:
from sentence_transformers import CrossEncoder
model = CrossEncoder("TakoData/chart-reranker", trust_remote_code=True)
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 Alibaba-NLP/gte-multilingual-reranker-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("cross_encoder_model_id")
# Get scores for pairs of texts
pairs = [
['What is the average rent price in Canada?', 'Title: "How many hours do Americans sleep at night (United States)"\nCollections: YouGov Trackers\nDatasets: YouGovTrackerValueV2\nChart Type: survey:timeseries\nSources: YouGov'],
['for the topic digital foortprint and identity use "\t " to give a description on if there was an provided teaching materials for this activity.', 'Title: "Different ways Americans define gender for someone who says they are transgender (United States)"\nCollections: YouGov Trackers\nDatasets: YouGovTrackerValueV2\nChart Type: survey:timeseries\nSources: YouGov'],
['Which U.S. cities or counties have the highest rates of aggravated assault involving a deadly weapon per 100,000 residents?', 'Title: "U.S. Bank Overview, CITY Overview"\nCollections: Companies\nDatasets: InstrumentClosePrice1Day\nChart Type: timeseries:eav_v3\nCanonical forms: "U.S. Bancorp"="closing_price", "Club De Futbol Intercity Sad"="closing_price"'],
['Black identity topics', 'Title: "Different ways Americans define gender for someone who says they are transgender (United States)"\nCollections: YouGov Trackers\nDatasets: YouGovTrackerValueV2\nChart Type: survey:timeseries\nSources: YouGov'],
['Which company in the Interactive Media and Services category has the highest market capitalization?', 'Title: "DigiPlus Interactive. Capital Expenditure (Quarterly)"\nCollections: Companies\nDatasets: StandardIncomeStatement\nChart Type: timeseries:eav_v3\nCanonical forms: "Capital Expenditure"="capital_expenditure"\nSources: S&P Global'],
]
scores = model.predict(pairs)
print(scores.shape)
# (5,)
# Or rank different texts based on similarity to a single text
ranks = model.rank(
'What is the average rent price in Canada?',
[
'Title: "How many hours do Americans sleep at night (United States)"\nCollections: YouGov Trackers\nDatasets: YouGovTrackerValueV2\nChart Type: survey:timeseries\nSources: YouGov',
'Title: "Different ways Americans define gender for someone who says they are transgender (United States)"\nCollections: YouGov Trackers\nDatasets: YouGovTrackerValueV2\nChart Type: survey:timeseries\nSources: YouGov',
'Title: "U.S. Bank Overview, CITY Overview"\nCollections: Companies\nDatasets: InstrumentClosePrice1Day\nChart Type: timeseries:eav_v3\nCanonical forms: "U.S. Bancorp"="closing_price", "Club De Futbol Intercity Sad"="closing_price"',
'Title: "Different ways Americans define gender for someone who says they are transgender (United States)"\nCollections: YouGov Trackers\nDatasets: YouGovTrackerValueV2\nChart Type: survey:timeseries\nSources: YouGov',
'Title: "DigiPlus Interactive. Capital Expenditure (Quarterly)"\nCollections: Companies\nDatasets: StandardIncomeStatement\nChart Type: timeseries:eav_v3\nCanonical forms: "Capital Expenditure"="capital_expenditure"\nSources: S&P Global',
]
)
# [{'corpus_id': ..., 'score': ...}, {'corpus_id': ..., 'score': ...}, ...]
validationCrossEncoderCorrelationEvaluator| Metric | Value |
|---|---|
| pearson | 0.8755 |
| spearman | 0.8709 |
sentence_0, sentence_1, and label| sentence_0 | sentence_1 | label | |
|---|---|---|---|
| type | string | string | float |
| details |
|
|
|
| sentence_0 | sentence_1 | label |
|---|---|---|
What is the average rent price in Canada? |
Title: "How many hours do Americans sleep at night (United States)" |
0.0 |
for the topic digital foortprint and identity use " " to give a description on if there was an provided teaching materials for this activity. |
Title: "Different ways Americans define gender for someone who says they are transgender (United States)" |
0.25 |
Which U.S. cities or counties have the highest rates of aggravated assault involving a deadly weapon per 100,000 residents? |
Title: "U.S. Bank Overview, CITY Overview" |
0.0 |
BinaryCrossEntropyLoss with these parameters:{
"activation_fn": "torch.nn.modules.linear.Identity",
"pos_weight": null
}
eval_strategy: stepsper_device_train_batch_size: 32per_device_eval_batch_size: 32num_train_epochs: 5fp16: Trueoverwrite_output_dir: Falsedo_predict: Falseeval_strategy: stepsprediction_loss_only: Trueper_device_train_batch_size: 32per_device_eval_batch_size: 32per_gpu_train_batch_size: Noneper_gpu_eval_batch_size: Nonegradient_accumulation_steps: 1eval_accumulation_steps: Nonetorch_empty_cache_steps: Nonelearning_rate: 5e-05weight_decay: 0.0adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08max_grad_norm: 1num_train_epochs: 5max_steps: -1lr_scheduler_type: linearlr_scheduler_kwargs: {}warmup_ratio: 0.0warmup_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: Falsebf16: Falsefp16: Truefp16_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: Falseignore_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_torch_fusedoptim_args: Noneadafactor: Falsegroup_by_length: Falselength_column_name: lengthproject: huggingfacetrackio_space_id: trackioddp_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: noneftune_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: Trueprompts: Nonebatch_sampler: batch_samplermulti_dataset_batch_sampler: proportionalrouter_mapping: {}learning_rate_mapping: {}| Epoch | Step | Training Loss | validation_spearman |
|---|---|---|---|
| 0.1300 | 100 | - | 0.7581 |
| 0.2601 | 200 | - | 0.7928 |
| 0.3901 | 300 | - | 0.8105 |
| 0.5202 | 400 | - | 0.8252 |
| 0.6502 | 500 | 0.4726 | 0.8306 |
| 0.7802 | 600 | - | 0.8338 |
| 0.9103 | 700 | - | 0.8398 |
| 1.0 | 769 | - | 0.8406 |
| 1.0403 | 800 | - | 0.8412 |
| 1.1704 | 900 | - | 0.8479 |
| 1.3004 | 1000 | 0.4027 | 0.8525 |
| 1.4304 | 1100 | - | 0.8521 |
| 1.5605 | 1200 | - | 0.8549 |
| 1.6905 | 1300 | - | 0.8591 |
| 1.8205 | 1400 | - | 0.8619 |
| 1.9506 | 1500 | 0.3793 | 0.8614 |
| 2.0 | 1538 | - | 0.8627 |
| 2.0806 | 1600 | - | 0.8623 |
| 2.2107 | 1700 | - | 0.8641 |
| 2.3407 | 1800 | - | 0.8598 |
| 2.4707 | 1900 | - | 0.8655 |
| 2.6008 | 2000 | 0.3534 | 0.8641 |
| 2.7308 | 2100 | - | 0.8651 |
| 2.8609 | 2200 | - | 0.8656 |
| 2.9909 | 2300 | - | 0.8668 |
| 3.0 | 2307 | - | 0.8660 |
| 3.1209 | 2400 | - | 0.8678 |
| 3.2510 | 2500 | 0.3387 | 0.8654 |
| 3.3810 | 2600 | - | 0.8654 |
| 3.5111 | 2700 | - | 0.8667 |
| 3.6411 | 2800 | - | 0.8676 |
| 3.7711 | 2900 | - | 0.8674 |
| 3.9012 | 3000 | 0.3335 | 0.8704 |
| 4.0 | 3076 | - | 0.8703 |
| 4.0312 | 3100 | - | 0.8698 |
| 4.1612 | 3200 | - | 0.8709 |
@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
Alibaba-NLP/gte-multilingual-reranker-base