Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks
Paper • 1908.10084 • Published • 19
How to use seanfarrell/icd11_ner_model_v2_large with sentence-transformers:
from sentence_transformers import SentenceTransformer
model = SentenceTransformer("seanfarrell/icd11_ner_model_v2_large")
sentences = [
"hypoxic ischaemic encephalopathy in diseases classified elsewhere",
"other specified hypoxic-ischaemic encephalopathy",
"monocytopenia",
"isolated benign cerebral vasculitis"
]
embeddings = model.encode(sentences)
similarities = model.similarity(embeddings, embeddings)
print(similarities.shape)
# [4, 4]This is a sentence-transformers model finetuned from google/embeddinggemma-300m. It maps sentences & paragraphs to a 768-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, classification, clustering, and more.
SentenceTransformer(
(0): Transformer({'transformer_task': 'feature-extraction', 'modality_config': {'text': {'method': 'forward', 'method_output_name': 'last_hidden_state'}}, 'module_output_name': 'token_embeddings', 'architecture': 'Gemma3TextModel'})
(1): Pooling({'embedding_dimension': 768, 'pooling_mode': 'mean', 'include_prompt': True})
(2): Dense({'in_features': 768, 'out_features': 3072, 'bias': False, 'activation_function': 'torch.nn.modules.linear.Identity', 'module_input_name': 'sentence_embedding', 'module_output_name': 'sentence_embedding'})
(3): Dense({'in_features': 3072, 'out_features': 768, 'bias': False, 'activation_function': 'torch.nn.modules.linear.Identity', 'module_input_name': 'sentence_embedding', 'module_output_name': 'sentence_embedding'})
(4): Normalize({})
)
First install the Sentence Transformers library:
pip install -U sentence-transformers
Then you can load this model and run inference.
from sentence_transformers import SentenceTransformer
# Download from the 🤗 Hub
model = SentenceTransformer("seanfarrell/icd11_ner_model_v2_large")
# Run inference
queries = [
'multiple delivery by combination of methods',
]
documents = [
'multiple delivery by combination of methods without caesarean',
'bipolar or related disorders, unspecified',
'rectal spasm',
]
query_embeddings = model.encode_query(queries)
document_embeddings = model.encode_document(documents)
print(query_embeddings.shape, document_embeddings.shape)
# [1, 768] [3, 768]
# Get the similarity scores for the embeddings
similarities = model.similarity(query_embeddings, document_embeddings)
print(similarities)
# tensor([[ 0.7717, -0.0575, 0.0184]])
icd11-valInformationRetrievalEvaluator| Metric | Value |
|---|---|
| cosine_accuracy@1 | 0.7731 |
| cosine_accuracy@5 | 0.848 |
| cosine_accuracy@10 | 0.8713 |
| cosine_precision@1 | 0.7731 |
| cosine_precision@3 | 0.6729 |
| cosine_precision@5 | 0.5754 |
| cosine_precision@10 | 0.429 |
| cosine_recall@1 | 0.1676 |
| cosine_recall@3 | 0.402 |
| cosine_recall@5 | 0.5068 |
| cosine_recall@10 | 0.6314 |
| cosine_ndcg@10 | 0.7209 |
| cosine_mrr@10 | 0.8068 |
| cosine_map@10 | 0.6633 |
anchor, positive, and negative| anchor | positive | negative | |
|---|---|---|---|
| type | string | string | string |
| modality | text | text | text |
| details |
|
|
|
| anchor | positive | negative |
|---|---|---|
rheumatic myocardiopathy |
chronic rheumatic heart |
abnormal liver lobulation |
chronic rheumatic coronary arteritis |
inactive or quiescent rheumatic fever with left ventricular failure |
other specified impairment of visual functions |
chronic rheumatic heart disease with endocarditis |
rheumatic endocarditis |
listeriosis, unspecified |
MultipleNegativesRankingLoss with these parameters:{
"scale": 20.0,
"similarity_fct": "cos_sim",
"gather_across_devices": false,
"directions": [
"query_to_doc"
],
"partition_mode": "joint",
"hardness_mode": null,
"hardness_strength": 0.0
}
per_device_train_batch_size: 512num_train_epochs: 1learning_rate: 2e-05lr_scheduler_type: cosinewarmup_steps: 1580weight_decay: 0.01bf16: Trueper_device_eval_batch_size: 256eval_on_start: Trueload_best_model_at_end: Truedataloader_drop_last: Trueper_device_train_batch_size: 512num_train_epochs: 1max_steps: -1learning_rate: 2e-05lr_scheduler_type: cosinelr_scheduler_kwargs: Nonewarmup_steps: 1580optim: adamw_torch_fusedoptim_args: Noneweight_decay: 0.01adam_beta1: 0.9adam_beta2: 0.999adam_epsilon: 1e-08optim_target_modules: Nonegradient_accumulation_steps: 1average_tokens_across_devices: Truemax_grad_norm: 1.0label_smoothing_factor: 0.0bf16: Truefp16: Falsebf16_full_eval: Falsefp16_full_eval: Falsetf32: Nonegradient_checkpointing: Falsegradient_checkpointing_kwargs: Nonetorch_compile: Falsetorch_compile_backend: Nonetorch_compile_mode: Noneuse_liger_kernel: Falseliger_kernel_config: Noneuse_cache: Falseneftune_noise_alpha: Nonetorch_empty_cache_steps: Noneauto_find_batch_size: Falselog_on_each_node: Truelogging_nan_inf_filter: Trueinclude_num_input_tokens_seen: nolog_level: passivelog_level_replica: warningdisable_tqdm: Falseproject: huggingfacetrackio_space_id: Nonetrackio_bucket_id: Nonetrackio_static_space_id: Noneper_device_eval_batch_size: 256prediction_loss_only: Trueeval_on_start: Trueeval_do_concat_batches: Trueeval_use_gather_object: Falseeval_accumulation_steps: Noneinclude_for_metrics: []batch_eval_metrics: Falsesave_only_model: Falsesave_on_each_node: Falseenable_jit_checkpoint: Falsepush_to_hub: Falsehub_private_repo: Nonehub_model_id: Nonehub_strategy: every_savehub_always_push: Falsehub_revision: Noneload_best_model_at_end: Trueignore_data_skip: Falserestore_callback_states_from_checkpoint: Falsefull_determinism: Falseseed: 42data_seed: Noneuse_cpu: Falseaccelerator_config: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None}parallelism_config: Nonedataloader_drop_last: Truedataloader_num_workers: 0dataloader_pin_memory: Truedataloader_persistent_workers: Falsedataloader_prefetch_factor: Nonedataloader_multiprocessing_context: Nonedataloader_in_order: Trueremove_unused_columns: Truelabel_names: Nonetrain_sampling_strategy: randomlength_column_name: lengthddp_find_unused_parameters: Noneddp_bucket_cap_mb: Noneddp_broadcast_buffers: Falseddp_static_graph: Noneddp_backend: Noneddp_timeout: 1800fsdp: Nonefsdp_config: Nonedeepspeed: Nonedebug: []skip_memory_metrics: Truedo_predict: Falseresume_from_checkpoint: Nonelocal_rank: -1prompts: Nonebatch_sampler: batch_samplermulti_dataset_batch_sampler: proportionalrouter_mapping: {}learning_rate_mapping: {}warmup_ratio: None| Epoch | Step | Training Loss | icd11-val_cosine_ndcg@10 |
|---|---|---|---|
| 0 | 0 | - | 0.5241 |
| 0.0032 | 50 | 2.0893 | - |
| 0.0063 | 100 | 1.6578 | - |
| 0.0095 | 150 | 1.4329 | - |
| 0.0127 | 200 | 1.2170 | - |
| 0.0158 | 250 | 1.0541 | - |
| 0.0190 | 300 | 0.9107 | - |
| 0.0222 | 350 | 0.7910 | - |
| 0.0253 | 400 | 0.6937 | - |
| 0.0285 | 450 | 0.5987 | - |
| 0.0316 | 500 | 0.5487 | 0.6342 |
| 0.0348 | 550 | 0.4945 | - |
| 0.0380 | 600 | 0.4407 | - |
| 0.0411 | 650 | 0.3987 | - |
| 0.0443 | 700 | 0.3634 | - |
| 0.0475 | 750 | 0.3231 | - |
| 0.0506 | 800 | 0.3094 | - |
| 0.0538 | 850 | 0.3041 | - |
| 0.0570 | 900 | 0.2820 | - |
| 0.0601 | 950 | 0.2629 | - |
| 0.0633 | 1000 | 0.2460 | 0.6571 |
| 0.0665 | 1050 | 0.2443 | - |
| 0.0696 | 1100 | 0.2154 | - |
| 0.0728 | 1150 | 0.2221 | - |
| 0.0759 | 1200 | 0.2117 | - |
| 0.0791 | 1250 | 0.2019 | - |
| 0.0823 | 1300 | 0.1920 | - |
| 0.0854 | 1350 | 0.1913 | - |
| 0.0886 | 1400 | 0.1777 | - |
| 0.0918 | 1450 | 0.1851 | - |
| 0.0949 | 1500 | 0.1792 | 0.6835 |
| 0.0981 | 1550 | 0.1725 | - |
| 0.1013 | 1600 | 0.1605 | - |
| 0.1044 | 1650 | 0.1743 | - |
| 0.1076 | 1700 | 0.1514 | - |
| 0.1108 | 1750 | 0.1455 | - |
| 0.1139 | 1800 | 0.1410 | - |
| 0.1171 | 1850 | 0.1209 | - |
| 0.1203 | 1900 | 0.1257 | - |
| 0.1234 | 1950 | 0.1135 | - |
| 0.1266 | 2000 | 0.1105 | 0.7033 |
| 0.1297 | 2050 | 0.1046 | - |
| 0.1329 | 2100 | 0.1068 | - |
| 0.1361 | 2150 | 0.0919 | - |
| 0.1392 | 2200 | 0.0985 | - |
| 0.1424 | 2250 | 0.0920 | - |
| 0.1456 | 2300 | 0.0868 | - |
| 0.1487 | 2350 | 0.0825 | - |
| 0.1519 | 2400 | 0.0826 | - |
| 0.1551 | 2450 | 0.0757 | - |
| 0.1582 | 2500 | 0.0778 | 0.7126 |
| 0.1614 | 2550 | 0.0697 | - |
| 0.1646 | 2600 | 0.0697 | - |
| 0.1677 | 2650 | 0.0649 | - |
| 0.1709 | 2700 | 0.0645 | - |
| 0.1741 | 2750 | 0.0661 | - |
| 0.1772 | 2800 | 0.0628 | - |
| 0.1804 | 2850 | 0.0553 | - |
| 0.1835 | 2900 | 0.0530 | - |
| 0.1867 | 2950 | 0.0565 | - |
| 0.1899 | 3000 | 0.0554 | 0.7209 |
@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",
}
@misc{oord2019representationlearningcontrastivepredictive,
title={Representation Learning with Contrastive Predictive Coding},
author={Aaron van den Oord and Yazhe Li and Oriol Vinyals},
year={2019},
eprint={1807.03748},
archivePrefix={arXiv},
primaryClass={cs.LG},
url={https://arxiv.org/abs/1807.03748},
}
Base model
google/embeddinggemma-300m