Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper • 1908.10084 • Published • 13
How to use corleymj/snippet-entity-news-classification-v2 with sentence-transformers:
from sentence_transformers import CrossEncoder
model = CrossEncoder("corleymj/snippet-entity-news-classification-v2")
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 BAAI/bge-large-en-v1.5 using the sentence-transformers library. It computes scores for pairs of texts, which can be used for text pair classification.
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 = [
["Dennis Schroder potential trade piece, but Brooklyn Nets won't just give him away", 'Basketball: Pre Game - Entity: Dennis Schroder'],
['The Vancouver Canucks are currently facing a cap crunch after the Lafferty pickup (Sam) Lafferty.', 'Hockey: Pre Game - Entity: Lafferty'],
['Additional news for 12/11 Out: Moses Moody Questionable: Steven Adams Not on injury report: Tari Eason', 'Basketball: Pre Game - Entity: Moses Moody'],
['Additional news for 12/11 Out: Moses Moody Questionable: Steven Adams Not on injury report: Tari Eason', 'Basketball: Pre Game - Entity: Steven Adams'],
['Additional news for 12/11 Out: Moses Moody Questionable: Steven Adams Not on injury report: Tari Eason', 'Basketball: Pre Game - Entity: Tari Eason'],
]
scores = model.predict(pairs)
print(scores.shape)
# (5, 10)
sentence1, sentence2, and label| sentence1 | sentence2 | label | |
|---|---|---|---|
| type | string | string | list |
| details |
|
|
|
| sentence1 | sentence2 | label |
|---|---|---|
Dennis Schroder potential trade piece, but Brooklyn Nets won't just give him away |
Basketball: Pre Game - Entity: Dennis Schroder |
[0.0, 0.0, 0.0, 0.0, 0.0, ...] |
The Vancouver Canucks are currently facing a cap crunch after the Lafferty pickup (Sam) Lafferty. |
Hockey: Pre Game - Entity: Lafferty |
[0.0, 0.0, 0.0, 1.0, 0.0, ...] |
Additional news for 12/11 Out: Moses Moody Questionable: Steven Adams Not on injury report: Tari Eason |
Basketball: Pre Game - Entity: Moses Moody |
[0.0, 1.0, 0.0, 0.0, 1.0, ...] |
main.MultiLabelCrossEntropyLosseval_strategy: stepsper_device_train_batch_size: 16per_device_eval_batch_size: 16learning_rate: 2e-05num_train_epochs: 10warmup_ratio: 0.1load_best_model_at_end: Trueoverwrite_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: 10max_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}tp_size: 0fsdp_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: 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: proportionalrouter_mapping: {}learning_rate_mapping: {}| Epoch | Step | Training Loss |
|---|---|---|
| 0.0022 | 1 | 1.0293 |
| 0.4301 | 200 | 0.9024 |
| 0.8602 | 400 | 0.4968 |
| 1.2903 | 600 | 0.3217 |
| 1.7204 | 800 | 0.2909 |
| 2.1505 | 1000 | 0.2133 |
| 2.5806 | 1200 | 0.1821 |
| 3.0108 | 1400 | 0.1737 |
| 3.4409 | 1600 | 0.1152 |
| 3.8710 | 1800 | 0.1224 |
| 4.3011 | 2000 | 0.1019 |
| 4.7312 | 2200 | 0.0909 |
| 5.1613 | 2400 | 0.0806 |
| 5.5914 | 2600 | 0.0634 |
| 6.0215 | 2800 | 0.0689 |
| 6.4516 | 3000 | 0.0503 |
| 6.8817 | 3200 | 0.0532 |
| 7.3118 | 3400 | 0.0453 |
| 7.7419 | 3600 | 0.0405 |
| 8.1720 | 3800 | 0.032 |
| 8.6022 | 4000 | 0.029 |
| 9.0323 | 4200 | 0.032 |
| 9.4624 | 4400 | 0.0246 |
| 9.8925 | 4600 | 0.0245 |
@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
BAAI/bge-large-en-v1.5